-
Notifications
You must be signed in to change notification settings - Fork 56
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
Enhance "all" configuration and update documentation #578
Conversation
@@ -1,6 +1,5 @@ | |||
# Require .spec test file pattern (`vitest/consistent-test-filename`) | |||
|
|||
⚠️ This rule _warns_ in the 🌐 `all` config. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there any specific reason why this was removed? It's generated by a tool we use to keep documentation updated. Did you removed it manually?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there any specific reason why this was removed?
Since the information is already documented in the All section, I determined that it is unnecessary to include it in each individual rule's documentation.
It's generated by a tool we use to keep documentation updated. Did you removed it manually?
Oh, I see... I didn't realize that and ended up removing it manually. 🥲
Are you referring to the script below?
eslint-plugin-vitest/package.json
Line 41 in 541f8b7
"update:eslint-docs": "pnpm build && eslint-doc-generator", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you don't mind, you can get them back and I'll go a head and merge your PR
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I reverted it in commit 62cd790.
Should we add the note "This rule warns in the 🌐 all config." to the documentation for the rules that were enabled this time (e.g., expect-expect, no-commented-out-tests, etc.)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
uhmm, it's supposed to be done by eslint-doc-generator
automatically but it hasn't added support for flat config.
Should we add the note "This rule warns in the 🌐 all config." to the documentation for the rules that were enabled this time
yes!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added the notes in ce2114a.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One last thing, did you run this command update:eslint-docs
? I think some things on readme have been modified which shouldn't be modified.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
did you run this command update:eslint-docs?
No, I haven't run it.
I think some things on readme have been modified which shouldn't be modified.
Which part are you referring to? The Rules section?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Which part are you referring to? The Rules section?
Yes, the rules section should remain as it is
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I fixed in 488a269.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you!
Resolves: #577