Skip to content

Docs: Don’t suggest tseslint.config helper in Getting Started #8496

@heymartinadams

Description

@heymartinadams

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

Suggested Changes

The “Getting Started” section currently shows a how-to using the tseslint.config helper package.
Screenshot of Getting Started section that uses tseslint.config

However, as mentioned in #8211 (comment), that was incredibly confusing to me, given that I — as do most other devs — have a number of plugins we need to connect to ESLint.

The Getting Started section isn’t the place to introduce this helper, since it creates the impression that this is the only possible way to use the typescript-eslint package. I get that you might think that the tseslint.config helper makes things easier for us — and it might, for some —, but for me it made things more confusing, and therefore more difficult.

Affected URL(s)

https://typescript-eslint.io/getting-started

Metadata

Metadata

Assignees

Labels

accepting prsGo ahead, send a pull request that resolves this issuedocumentationDocumentation ("docs") that needs adding/updating

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions