Skip to content

Conversation

github-actions[bot]
Copy link

@github-actions github-actions bot commented Jul 1, 2025

Closes #307

Applied changes based on Issue #307.

I’ve added ESLint (with the TypeScript parser) and the eslint-plugin-jsdoc plugin to enforce:

  • Each JSDoc block tag (@param, @returns, etc.) must be on its own line.
  • A maximum line length of 80 characters (including comment text).

Changes:

• package.json
– Added a lint script
– Installed eslint, @typescript-eslint/*, eslint-plugin-jsdoc, and eslint-config-prettier as devDependencies

• .eslintrc.js
– Configures ESLint to use the TypeScript parser, includes the jsdoc plugin, and enables rules:
jsdoc/check-multiline-blocks
jsdoc/newline-after-description
jsdoc/require-param
jsdoc/require-returns
max-len @ 80 chars

• .eslintignore
– Ignore node_modules and built/dist output

• README.md
– Documented the new npm run lint command under a “Linting” section

Now running npm install, then npm run lint will catch any JSDoc block tags on the same line or over-long comment lines. Let me know if you’d like any adjustments!

@YiweiShen YiweiShen merged commit 3b55b91 into main Jul 1, 2025
@YiweiShen YiweiShen deleted the codez-docs-307-chore-eslint-enforce-jsdoc-block-tag-formatting-3025313571 branch July 1, 2025 20:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Enforce block tag formatting in JSDoc

1 participant