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

Automatically generate README configs list with eslint-doc-generator #1966

Merged
merged 1 commit into from
Oct 31, 2023

Conversation

bmish
Copy link
Member

@bmish bmish commented Oct 31, 2023

Useful especially in case there are additional configs in the future. We can optionally export a description property from a config resulting in a "Description" column getting added to this list.

@bmish bmish merged commit 3efc920 into ember-cli:master Oct 31, 2023
7 checks passed
@bmish bmish deleted the auto-configs-list-edg branch October 31, 2023 13:07
@patricklx
Copy link
Contributor

patricklx commented Nov 5, 2023

I think this broke the badge appearing in the configs? @bmish
See #1982
Do i miss some config option to display the badge

@bmish
Copy link
Member Author

bmish commented Nov 5, 2023

I'm going to be removing or redesigning the current badge functionality in eslint-doc-generator (bmish/eslint-doc-generator#487).

Instead, can you add this config to .eslint-doc-generatorrc.js:

{
  "configEmoji": [
    ["recommended-gjs", "![gjs logo](/docs/svgs/gjs.svg)"],
    ["recommended-gts", "![gts logo](/docs/svgs/gts.svg)"]
  ],
}

This will do what you want.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants