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

Support auto-generated config lists #480

Merged
merged 1 commit into from
Oct 7, 2023
Merged

Support auto-generated config lists #480

merged 1 commit into from
Oct 7, 2023

Conversation

bmish
Copy link
Owner

@bmish bmish commented Oct 6, 2023

Fixes #61.

This is an optional feature for anyone who adds these marker comments to their README.md:

<!-- begin auto-generated configs list -->
<!-- end auto-generated configs list -->

Rendered example of the table/list that will be generated:

Name Description
recommended These rules are recommended for everyone.
🎨 stylistic These rules are more about code style than bugs.
⌨️ typescript These are good rules to use with TypeScript.

Config descriptions will be included in the list for configs that export a description property. This is not yet an official ESLint config property but it should likely become one.

Future follow-up features to consider:

This feature respects the following options: --config-format, --ignore-config, --path-rule-list (may need to be renamed #489). The URL from --url-configs is not currently used in this feature.

@bmish bmish added the enhancement New feature or request label Oct 6, 2023
@bmish bmish requested a review from ddzz October 7, 2023 01:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Automatically generate configs list in README
2 participants