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

Evaluate eslint-plugin-jsdoc #10815

Open
sanjeetsuhag opened this issue Sep 24, 2022 · 1 comment · May be fixed by #12019
Open

Evaluate eslint-plugin-jsdoc #10815

sanjeetsuhag opened this issue Sep 24, 2022 · 1 comment · May be fixed by #12019

Comments

@sanjeetsuhag
Copy link
Contributor

To help enforce consistency in how we use JSDoc in the CesiumJS codebase, we should evaluate the eslint-plugin-jsdoc. It seems like it is actively maintained and fairly popular. If we like it enough, we should also consider it for eslint-config-cesium.

@jjhembd
Copy link
Contributor

jjhembd commented Feb 17, 2023

After the work by @onsummer in #11080, this plugin could be a good way to ensure consistency going forward.

The default rules might require too much change at once. We could phase the implementation as follows:

First PR

  1. Add the dependency
  2. Update .eslintrc.json and .eslintrc.json
  3. Enable the check-types rule only, setting it to "error"
  4. Confirm that the results match what we implemented in Use primitive type instead of constructor type #11080

Later PRs

Test more of the recommended rules, and enable the ones that give the best return on effort. We could prioritize as follows:

  1. Rules that don't require much change to our docs. These will enforce existing doc style going forward
  2. Rules that flag behavior that can be auto-corrected with the --fix option. For example, check-tag-names to replace @return with @returns
  3. Rules that flag serious errors like invalid tag names

@ggetz ggetz linked a pull request Jun 4, 2024 that will close this issue
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants