Comments (7)
type-aware
seems like a good name for that.
from eslint-doc-generator.
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.
from eslint-doc-generator.
I’m confused; what does “type-checked” indicate?
from eslint-doc-generator.
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.
from eslint-doc-generator.
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.
from eslint-doc-generator.
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)
from eslint-doc-generator.
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.
from eslint-doc-generator.
Related Issues (20)
- Consider addition config list columns
- Various improvements to rule option lists HOT 4
- Process fails with `--init-rule-docs` when no docs need to be created HOT 1
- Add more default config emojis
- Deprecate and remove support for badges defined in READMEs
- Make the `path-rule-doc` parameter can accept a function HOT 2
- Support ESM HOT 4
- Custom properties like `description` not allowed on ESLint flat configs
- Docs get regenerated HOT 4
- Support additional rule metadata for deprecations
- Support option defaults from `meta.defaultOptions` for rule option lists
- Add notice link to explain "type information" HOT 2
- Add notice link to explain rule options
- Add an emoji for 'recommended-type-checked' HOT 1
- Duplicated auto-generated rules header on Windows HOT 4
- False Option warning on Windows HOT 3
- Peer dependency warnings on ESLint v9 HOT 6
- Support ESLint v9 HOT 5
- Respect existing newline character choice
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from eslint-doc-generator.