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

Docs: new eslint.config.js - adapt all existing content to new flat config #5938

Closed
2 of 7 tasks
revelt opened this issue Nov 8, 2022 · 1 comment
Closed
2 of 7 tasks
Labels
documentation Documentation ("docs") that needs adding/updating triage Waiting for maintainers to take a look

Comments

@revelt
Copy link

revelt commented Nov 8, 2022

Before You File a Documentation Request Please Confirm You Have Done The Following...

Suggested Changes

The eslint flat config is generally available — no more extends. Let's adapt all our content for both the old and the new flat config. We'll need to add the alternative counterpart snippets and solve how to toggle between them.

Also, if there was a global toggle (in the nav let's say), user would not have to toggle each snippet.

On this occasion, it would be nice to supplement the Custom rules > Testing section because there's no more defineParser(), and people might want few examples how to set up let linter = new Linter({ configType: "flat" }); linter.verifyAndFix(str, [ ... and how to test the plugin works on esprima and @typescript-eslint/parser. Ideally, we should link to more real-life plugin examples — simplistic ruleTester ones, then more complex ones which use test file fixtures and double-check multiple parsers, esprima and @typescript-eslint/parser.

Affected URL(s)

@revelt revelt added documentation Documentation ("docs") that needs adding/updating triage Waiting for maintainers to take a look labels Nov 8, 2022
@bradzacher
Copy link
Member

See #5908
Whilst the flat config is "generally available" it's not actually finished yet. People adopting it now are really "early adopters" and are testing what is still an experimental API.

There's a lot we as a project want to do to truly support flat configs and provide the best possible devx we can.

As a project we're not going to move on any of the flat config related work (including documentation) until we've partnered with ESLint core in "phase 3" of their plan (eslint/eslint#13481) and solidified support from both sides.

@bradzacher bradzacher closed this as not planned Won't fix, can't repro, duplicate, stale Nov 16, 2022
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 24, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Documentation ("docs") that needs adding/updating triage Waiting for maintainers to take a look
Projects
None yet
Development

No branches or pull requests

2 participants