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
chore: upgrade eslint-doc-generator v1.4#76
Conversation
I used ➜ eslint-plugin-node git:(master) npm run update:eslint-docs
> eslint-plugin-n@15.6.0 update:eslint-docs
> eslint-doc-generator --config-emoji recommended-module,☑️ --config-emoji recommended-script,✔️ --rule-list-split meta.docs.category --ignore-config recommended-module --ignore-config recommended-script --url-configs "https://github.com/eslint-community/eslint-plugin-n#-configs"
`no-extraneous-import` rule doc should have included: include
`no-extraneous-import` rule doc should have included: exclude
`no-extraneous-import` rule doc should have included: replace
`no-extraneous-require` rule doc should have included: include
`no-extraneous-require` rule doc should have included: exclude
`no-extraneous-require` rule doc should have included: replace @bmish can you please take a look, thanks! :) |
I just investigated and it looks like this is correct. eslint-doc-generator is correctly detecting additional options that are undocumented. We have a TODO in the doc to mention these options. eslint-plugin-n/docs/rules/no-extraneous-require.md Lines 60 to 62 in f5267e7
eslint-plugin-n/docs/rules/no-extraneous-import.md Lines 52 to 54 in f5267e7
The options come from a shared schema: eslint-plugin-n/lib/util/get-convert-path.js Lines 167 to 183 in f5267e7
I would recommend just adding a bullet-point list to add some initial documentation for these options:
I am improving the error message though: bmish/eslint-doc-generator#388 |
Co-authored-by: Bryan Mishkin <698306+bmish@users.noreply.github.com>
Co-authored-by: Bryan Mishkin <698306+bmish@users.noreply.github.com>
No description provided.