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.

Sign up for GitHub

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

Jump to bottom

[Docs] Use emoji for jsx-runtime config and config file for eslint-doc-generator #3504

Merged
merged 1 commit into from Dec 13, 2022
+120 −107
Merged

[Docs] Use emoji for jsx-runtime config and config file for eslint-doc-generator #3504

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 11 additions & 0 deletions .eslint-doc-generatorrc.js
View file
Open in desktop
@@ -0,0 +1,11 @@
/** @type {import('eslint-doc-generator').GenerateOptions} */
ljharb marked this conversation as resolved.
Show resolved Hide resolved
const config = {
configEmoji: [
['jsx-runtime', '🏃'],
['recommended', '☑️'],
],
ignoreConfig: ['all'],
urlConfigs: 'https://github.com/jsx-eslint/eslint-plugin-react/#shareable-configs',
};

module.exports = config;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is there a reason this has to be a JS file? ideally config is static.

(it's also a bit confusing to have "rc" in the name when it's not actually an rc file, but i guess eslintrc already makes that mistake)

Copy link
Contributor Author

@bmish bmish Dec 12, 2022 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any filename or format from here is supported: https://github.com/davidtheclark/cosmiconfig#searchplaces (more info: https://github.com/bmish/eslint-doc-generator#configuration-file).

Note that only a JavaScript format enables us to benefit from the type definitions (auto-complete, hover-over documentation, etc).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since presumably the tool validates the config at runtime, I'm not super worried about the type definitions, but fair point.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah the types are just a convenience. The config file is fully validated at runtime.

2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Expand Up @@ -23,7 +23,9 @@ This change log adheres to standards from [Keep a CHANGELOG](https://keepachange
* [Docs] [`jsx-no-leaked-render`]: Remove mentions of empty strings for React 18 ([#3468][] @karlhorky)
* [Docs] update `eslint-doc-generator` to v1.0.0 ([#3499][] @bmish)
* [meta] add issue template ([#3483][] @ROSSROSALES)
* [Docs] Use emoji for jsx-runtime config and config file for eslint-doc-generator ([#3504][] @bmish)[

[#3504]: https://github.com/jsx-eslint/eslint-plugin-react/pull/3504
[#3499]: https://github.com/jsx-eslint/eslint-plugin-react/pull/3499
[#3494]: https://github.com/jsx-eslint/eslint-plugin-react/pull/3494
[#3493]: https://github.com/jsx-eslint/eslint-plugin-react/pull/3493
Expand Down