Open sanjeetsuhag opened 2 years ago
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:
.eslintrc.json
and .eslintrc.json
check-types
rule only, setting it to "error"Test more of the recommended rules, and enable the ones that give the best return on effort. We could prioritize as follows:
--fix
option. For example, check-tag-names
to replace @return
with @returns
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.