GithubHelp home page GithubHelp logo

Comments (7)

ljharb avatar ljharb commented on June 2, 2024 1

type-aware seems like a good name for that.

from eslint-doc-generator.

JoshuaKGoldberg avatar JoshuaKGoldberg commented on June 2, 2024 1

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.

ljharb avatar ljharb commented on June 2, 2024

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

from eslint-doc-generator.

bmish avatar bmish commented on June 2, 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.

from eslint-doc-generator.

ljharb avatar ljharb commented on June 2, 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.

from eslint-doc-generator.

bmish avatar bmish commented on June 2, 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)

from eslint-doc-generator.

bmish avatar bmish commented on June 2, 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.

from eslint-doc-generator.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.