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 emoji for type-checked config #519

Closed
bmish opened this issue Feb 7, 2024 · 7 comments · Fixed by #521
Closed

Add emoji for type-checked config #519

bmish opened this issue Feb 7, 2024 · 7 comments · Fixed by #521
Labels
enhancement New feature or request

Comments

@bmish
Copy link
Owner

bmish commented Feb 7, 2024

I'm thinking we can add our current TypeScript-related emoji of ⌨️ to the config name type-checked going along with some of the existing TypeScript/type-related config names we have. We wouldn't use ☑️ for this since it's not necessarily related to the recommended config.

Follow-up to:

Related discussion:

CC: @JoshuaKGoldberg

@ljharb
Copy link

ljharb commented Feb 26, 2024

I’m confused; what does “type-checked” indicate?

@bmish
Copy link
Owner Author

bmish commented Feb 26, 2024

It's just one possible name that plugins might use for configs containing type-aware rules, which would usually have meta.docs.requiresTypeChecking enabled. Discussion in eslint-community/eslint-plugin-eslint-plugin#445.

Note that plugins don't need to use this name or config, as the idea is just to provide emojis for a variety of common or possible config names.

@ljharb
Copy link

ljharb commented Feb 26, 2024

that seems like a really weird name since it appears to describe the config itself rather than the code it’s linting - nobody should care if the plugin code is type-checked or not.

@bmish
Copy link
Owner Author

bmish commented Feb 26, 2024

Hmm perhaps the name is misleading since it's not that the lint rule itself is type-checked but rather that the lint rule takes into account type information while operating on the user's code, so it does have a user-facing impact. Type-checked aka type-aware rules can be smarter as a result.

Either way, I'm not really making a judgment here about whether this is an advisable config name to use, but the name is inspired from typescript-eslint which has been using this convention of type-checked in some of its config names: https://typescript-eslint.io/users/configs#recommended-configurations (CC: @JoshuaKGoldberg)

@ljharb
Copy link

ljharb commented Feb 26, 2024

type-aware seems like a good name for that.

@bmish
Copy link
Owner Author

bmish commented Feb 26, 2024

type-aware sounds nice and concise. I'll defer to @JoshuaKGoldberg on the official typescript-eslint conventions or recommendations but will aim to support any variation here.

@JoshuaKGoldberg
Copy link
Contributor

Oh shoot I missed this till now - type-aware is a really interesting name. cc @bradzacher, I actually like it more than type-checked for the reasons stated.

The problem is, we just did a set of config renames like recommended-requiring-type-checking to recommended-type-checked (typescript-eslint/typescript-eslint#6019) last year. And then we released flat config support over the last couple of months.

So... as much as I prefer "aware", I'm not sure that it can be more than just a nice terminology alias for a while in typescript-eslint itself 😞. Which makes it hard to recommend other configs use it.

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.

3 participants