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

update:eslint-docs script does not generate the expected documentation #634

Open
y-hsgw opened this issue Jan 5, 2025 · 0 comments
Open

Comments

@y-hsgw
Copy link
Contributor

y-hsgw commented Jan 5, 2025

Description:

Running the update:eslint-docs script results in the following unexpected output:

  • The prefix in the rule documentation titles is @vitest.
  • The contents for the shared configs (recommended and all) are not generated in either the README or the rule documentation.

Cause:

This issue occurs because eslint-doc-generator determines the prefix based on the name field in package.json.

Expected Behavior:

  • The prefix in the rule documentation titles should be vitest.
  • The contents for the shared configs (recommended and all) should be generated in both the README and the rule documentation.

Additional Information:

A related issue has been created: bmish/eslint-doc-generator#610.

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

No branches or pull requests

1 participant