Skip to content

chore(lint/jsdoc): enable jsdoc/valid-types rule and fix offenses #11706

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
naorpeled merged 1 commit into from
Oct 3, 2025
Merged

chore(lint/jsdoc): enable jsdoc/valid-types rule and fix offenses #11706

naorpeled merged 1 commit into from
Oct 3, 2025

Conversation

@pkuczynski
Copy link
Collaborator

@pkuczynski pkuczynski commented Oct 2, 2025 •
edited by coderabbitai bot
Loading

Description of change

Enable jsdoc/valid-types rule and fix offenses

Pull-Request Checklist

  • Code is up-to-date with the master branch
  • This pull request links relevant issues as Fixes #00000
  • There are new or updated unit tests validating the change
  • Documentation has been updated to reflect this change

Summary by CodeRabbit

  • Chores
    • Updated linting configuration to temporarily enforce stricter JSDoc type validation, improving code quality without affecting functionality.
  • Documentation
    • Added explanatory comments and clarified linting exemptions in type definition files to improve maintainability and readability.
  • Style
    • Minor formatting adjustments to configuration for consistency.

No user-facing changes or behavioral impacts in this release.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 2, 2025 •
edited
Loading

Walkthrough

Updates ESLint configuration to switch a jsdoc config string to double quotes, add a temporary jsdoc rule enforcing valid types, and annotate its temporary nature. Adds a header comment and disables ESLint for a MongoDB typings file without altering types or runtime behavior.

Changes

Cohort / File(s) Summary
ESLint JSDoc config
eslint.config.mjs		 Changed jsdoc(config) string to use double quotes; added a temporary rules block enabling "jsdoc/valid-types": "error"; kept files filter for "src/**/*.ts"; added inline comments about temporary rule and future cleanup.
MongoDB typings housekeeping
src/driver/mongodb/typings.ts		 Added header comment noting content is copied from mongodb.d.ts; disabled ESLint for the file; no type or runtime changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • gioboa
  • naorpeled
  • alumni

Poem

I thump my paw—lint’s in a line,
Quotes now twinned, types looking fine.
A hush on typings, ESLint sleeps,
While burrowed rules the project keeps.
Hop hop—tidy change, crisp and slight,
Carrots for code that compiles right. 🥕

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit's high-level summary is enabled.
Title Check ✅ Passed The title succinctly and accurately describes the main change by indicating that the jsdoc/valid-types rule is enabled and JSDoc offenses are fixed, matching the content of the PR without extraneous detail.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2446bd0 and fd34089.

📒 Files selected for processing (2)
  • eslint.config.mjs (1 hunks)
  • src/driver/mongodb/typings.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (20)
  • GitHub Check: tests-linux (20) / postgres (17)
  • GitHub Check: tests-linux (20) / postgres (14)
  • GitHub Check: tests-linux (18) / sap
  • GitHub Check: tests-linux (20) / sap
  • GitHub Check: tests-linux (18) / oracle
  • GitHub Check: tests-linux (18) / postgres (14)
  • GitHub Check: tests-linux (18) / postgres (17)
  • GitHub Check: tests-linux (20) / cockroachdb
  • GitHub Check: tests-linux (20) / mongodb
  • GitHub Check: tests-linux (18) / mysql_mariadb_latest
  • GitHub Check: tests-linux (18) / sqlite
  • GitHub Check: tests-linux (18) / mysql_mariadb
  • GitHub Check: tests-linux (18) / mssql
  • GitHub Check: tests-linux (18) / better-sqlite3
  • GitHub Check: tests-linux (18) / mongodb
  • GitHub Check: tests-windows / sqljs
  • GitHub Check: tests-windows / sqlite
  • GitHub Check: tests-windows / better-sqlite3
  • GitHub Check: formatting
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (2)
src/driver/mongodb/typings.ts (1)

1-6: Thanks for documenting the provenance.
Clear explanation plus the scoped eslint-disable make sense for a vendored typings snapshot.

eslint.config.mjs (1)

87-93: jsdoc rule enablement looks good.
Appreciate the temporary targeting plus the note about flipping to the stricter preset once warnings are gone.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@pkg-pr-new
Copy link

pkg-pr-new bot commented Oct 2, 2025

typeorm-sql-js-example

npm i https://pkg.pr.new/typeorm/typeorm@11706

commit: fd34089

@coveralls
Copy link

coveralls commented Oct 2, 2025

Coverage Status

coverage: 76.431%. remained the same
when pulling fd34089 on pkuczynski:lint/jsdoc/valid-types
into 2446bd0 on typeorm:master.

gioboa
gioboa approved these changes Oct 3, 2025
View reviewed changes
Copy link
Collaborator

@gioboa gioboa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👏
Thanks @pkuczynski

@gioboa gioboa requested review from alumni, naorpeled and sgarner October 3, 2025 06:33
@naorpeled naorpeled merged commit 74522ff into typeorm:master Oct 3, 2025
62 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Nov 9, 2025
Merged
4 tasks
ThbltLmr pushed a commit to ThbltLmr/typeorm that referenced this pull request Dec 2, 2025
@pkuczynski @ThbltLmr
chore(lint/jsdoc): enable jsdoc/valid-types rule and fix offenses (ty…
a51ba46 
…peorm#11706)
mgohin pushed a commit to mgohin/typeorm that referenced this pull request Jan 15, 2026
@pkuczynski
chore(lint/jsdoc): enable jsdoc/valid-types rule and fix offenses (ty…
dd35055 
…peorm#11706)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@naorpeled naorpeled naorpeled approved these changes

@gioboa gioboa gioboa approved these changes

@alumni alumni Awaiting requested review from alumni

@sgarner sgarner Awaiting requested review from sgarner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@pkuczynski @coveralls @naorpeled @gioboa