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

chore: upgrade eslint-doc-generator v1.4#76

Merged
merged 6 commits into from Jan 11, 2023

Conversation

aladdin-add
Copy link

No description provided.

@aladdin-add
Copy link
Author

I used npm run update:eslint-docs to update the docs, but it still shows a few errors:

➜  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! :)

@bmish
Copy link
Member

bmish commented Jan 10, 2023

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.

#### convertPath
TODO

#### convertPath
TODO

The options come from a shared schema:

include: {
type: "array",
items: { type: "string" },
minItems: 1,
uniqueItems: true,
},
exclude: {
type: "array",
items: { type: "string" },
uniqueItems: true,
},
replace: {
type: "array",
items: { type: "string" },
minItems: 2,
maxItems: 2,
},

I would recommend just adding a bullet-point list to add some initial documentation for these options:

  • include: TODO
  • exclude: TODO
  • replace: TODO

I am improving the error message though: bmish/eslint-doc-generator#388

aladdin-add and others added 3 commits January 11, 2023 10:30
Co-authored-by: Bryan Mishkin <698306+bmish@users.noreply.github.com>
Co-authored-by: Bryan Mishkin <698306+bmish@users.noreply.github.com>
@aladdin-add aladdin-add merged commit 83446a1 into master Jan 11, 2023
@aladdin-add aladdin-add deleted the chore/eslint-doc-generator-v1.4 branch January 11, 2023 03:37
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.

None yet

2 participants