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

Add an emoji for 'recommended-type-checked' #517

Closed
JoshuaKGoldberg opened this issue Feb 5, 2024 · 1 comment · Fixed by #518
Closed

Add an emoji for 'recommended-type-checked' #517

JoshuaKGoldberg opened this issue Feb 5, 2024 · 1 comment · Fixed by #518
Labels
enhancement New feature or request

Comments

@JoshuaKGoldberg
Copy link
Contributor

Coming over from eslint-community/eslint-plugin-eslint-plugin#433 (comment):

I don't love that this doesn't have its own emoji 😞 is there some standard practice that can be done?
Yes I would just give it a different color checkmark like ☑️ in .eslint-doc-generatorrc.js.

Would adding recommended-type-checked: ☑️ to the list of built-in rule config emojis make be reasonable? I don't know of configs other than typescript-eslint that use that (pending eslint-community/eslint-plugin-eslint-plugin#433), but it strikes me as a reasonable preset.

export const EMOJI_CONFIGS = {
a11y: EMOJI_A11Y,
accessibility: EMOJI_A11Y,
all: '🌐',
error: EMOJI_ERROR,
errors: EMOJI_ERROR,
recommended: '✅',

@bmish bmish added the enhancement New feature or request label Feb 5, 2024
@bmish
Copy link
Owner

bmish commented Feb 5, 2024

I'm open to this since this config name recommended-type-checked seems like a common or recommended convention for type-aware rules, as seen here: https://typescript-eslint.io/linting/typed-linting/

My original idea behind using ☑️ for it is that this black/white checkmark is a variation of the green checkmark ✅ used for recommended, the same way that recommended-type-checked is a variation/extension of the recommended config. There's also ✔️ but that is a bit less consistent with the styling.

There's also ⌨️ which could make sense as we're using it for other TypeScript-related configs, but it doesn't have the benefit that ☑️ does of implying a relation to the recommended config.

So it seems we can start with ☑️.

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 a pull request may close this issue.

2 participants