Skip to content
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.

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

Add linting of jsdoc comments #6

Merged
merged 1 commit into from
Feb 19, 2020

Conversation

mroderick
Copy link
Member

This PR adds dependency on eslint-plugin-jsdoc with the recommended configuration. This will allow us to lint JSDoc comments in projects and allow authors to detect and fix invalid comments.

The ultimate goal is to have all Sinon projects covered with JSDoc so people using IDEs can have a great autocomplete experience.

Maybe it'll allow some automation of the creation of the typescript files for Definitely Typed. We'll see.

How to verify

  1. Check out this branch
  2. npm link
  3. Check out sinonjs/sinon somewhere
  4. (sinon): npm install eslint-plugin-jsdoc --save-dev
  5. (sinon): npm link @sinonjs/eslint-config-sinon
  6. (sinon): Write some invalid JSDoc in a source file
  7. (sinon): npm run lint
  8. Observe that the linter warns you about the invalid JSDoc

@mroderick mroderick added the semver:major changes will cause a new major version label Feb 5, 2020
Copy link
Member

@mantoni mantoni left a comment

Choose a reason for hiding this comment

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

Nice! Thank you Morgan 👍

@mroderick mroderick merged commit 956db70 into sinonjs:master Feb 19, 2020
Docs 2020 automation moved this from In progress to Done Feb 19, 2020
@mroderick mroderick deleted the add-jsdoc-linting branch February 19, 2020 11:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
semver:major changes will cause a new major version
Projects
Docs 2020
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

2 participants