Skip to content

Conversation

@mbg
Copy link
Member

@mbg mbg commented Nov 9, 2025

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:

  • Low risk: Changes are fully under feature flags, or have been fully tested and validated in pre-production environments and are highly observable, or are documentation or test only.

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?

  • Rollback - Change can only be disabled by rolling back the release or releasing a new version with a fix.

How will you know if something goes wrong after this change is released?

N/A.

Merge / deployment checklist

  • Confirm this change is backwards compatible with existing workflows.
  • Consider adding a changelog entry for this change.
  • Confirm the readme and docs have been updated if necessary.

@mbg mbg requested a review from a team as a code owner November 9, 2025 10:28
Copilot AI review requested due to automatic review settings November 9, 2025 10:28
@github-actions github-actions bot added the size/S Should be easy to review label Nov 9, 2025
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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

Copy link
Contributor

@henrymercer henrymercer left a comment

Choose a reason for hiding this comment

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

❤️

@mbg mbg merged commit 04bd5c6 into main Nov 10, 2025
247 checks passed
@mbg mbg deleted the mbg/lint/jsdoc-param-names branch November 10, 2025 11:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/S Should be easy to review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants