Linter: check JSDoc parameter names exist - #3279
Merged
mbg merged 1 commit intoNov 10, 2025
Merged
mbg merged 1 commit into
mbg merged 1 commit into
Conversation
Copy link
Copy Markdown
Member
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds the eslint-plugin-jsdoc linting plugin to enforce accurate JSDoc parameter names and corrects several outdated JSDoc comments throughout the codebase where parameter names had drifted from their function signatures.
Key Changes
- Added eslint-plugin-jsdoc@^61.1.12 as a dev dependency and configured the jsdoc/check-param-names rule to catch parameter name mismatches
- Updated JSDoc comments in 5 source files to align parameter documentation with actual function signatures
- Configured the rule with disableMissingParamChecks: true to avoid requiring full JSDoc coverage while still catching outdated parameter names
Reviewed Changes
Copilot reviewed 19 out of 20 changed files in this pull request and generated no comments.
Show a summary per file| File | Description |
|---|---|
| src/upload-lib.ts | Fixed JSDoc parameter name from processingResults to postProcessingResults |
| src/status-report.ts | Fixed JSDoc parameter name from startedAt to actionStartedAt |
| src/config/db-config.ts | Removed obsolete @param configFile that no longer exists in function signature |
| src/config-utils.ts | Removed obsolete @param codeQL that no longer exists in function signature |
| src/codeql.ts | Improved JSDoc structure with proper nested @param args.* format and updated parameter descriptions |
| package.json | Added eslint-plugin-jsdoc@^61.1.12 to devDependencies |
| package-lock.json | Auto-generated lockfile updates for new dependency and its transitive dependencies |
| eslint.config.mjs | Imported and configured the jsdoc plugin with the jsdoc/check-param-names rule |
| lib/*.js | Generated JavaScript files automatically updated to reflect TypeScript source changes |
Sorry, something went wrong.
esbena
approved these changes
Nov 10, 2025
henrymercer
approved these changes
Nov 10, 2025
henrymercer
left a comment
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
❤️
Sorry, something went wrong.
This was referenced Nov 13, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a linter rule (using the eslint-plugin-jsdoc plugin for eslint) that checks JSDoc comment parameter names to make sure that the parameters exist.
This doesn't enforce that JSDoc comments must exist or that they must be up-to-date.
I have fixed the few instances where we had outdated JSDoc comments and this rule was violated.
Risk assessment
For internal use only. Please select the risk level of this change:
Which use cases does this change impact?
Dev only.
How did/will you validate this change?
I ran the linter and it will run as part of CI.
If something goes wrong after this change is released, what are the mitigation and rollback strategies?
How will you know if something goes wrong after this change is released?
N/A.
Merge / deployment checklist