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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged

Conversation

bmish
Copy link
Contributor

@bmish bmish commented Dec 12, 2022

  1. Switch to using .eslint-doc-generatorrc.js config file. Optional but nice.
  2. Use 馃弮 emoji to represent jsx-runtime instead of a badge (follow-up to Update eslint-doc-generator to v1.0.0聽#3499 (comment)). The emoji is more consistent with how we represent other configs, more portable (shows up in all docs, not just the README), and just more aesthetic. The badge was also showing up too small and difficult to read for some reason.

@codecov
Copy link

codecov bot commented Dec 12, 2022

Codecov Report

Merging #3504 (c9f5eb2) into master (a60f04d) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #3504   +/-   ##
=======================================
  Coverage   97.57%   97.57%           
=======================================
  Files         130      130           
  Lines        9211     9211           
  Branches     3341     3341           
=======================================
  Hits         8988     8988           
  Misses        223      223           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

.eslint-doc-generatorrc.js Show resolved Hide resolved
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

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.

@bmish bmish force-pushed the eslint-doc-generator-run-emoji-config-file branch from 2a17015 to a7ef065 Compare December 12, 2022 19:05
@ljharb ljharb force-pushed the eslint-doc-generator-run-emoji-config-file branch from a7ef065 to c9f5eb2 Compare December 12, 2022 19:36
@ljharb ljharb merged commit c9f5eb2 into jsx-eslint:master Dec 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

None yet

2 participants