Skip to content

Docs: Separate typescript package installation in getting started page #10113

Closed as not planned
@rchandu

Description

@rchandu

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

Suggested Changes

Prior discussion: #9653 (comment)

I suggest we separate out typescript installation as part of the getting started page. This would allow us to handle 2 different kinds of users differently:

  1. Install typescript - we provide code to install typescript along with the greatest supported version of typescript package
  2. Already have typesctipt - We show information of what typescript versions are officially supported & others can use but no guarantees.

This would help users who are integrating this package first time & creating bugs. This currently happens because getting started page recommends installing latest typescript always.

Affected URL(s)

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

Additional Info

Context for bugs created because of CLI message mentioning that typescript version is supported: https://github.com/typescript-eslint/typescript-eslint/issues?q=%22not+officially+supported+%22

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationDocumentation ("docs") that needs adding/updatinglocked due to agePlease open a new issue if you'd like to say more. See https://typescript-eslint.io/contributing.wontfixThis will not be worked on

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions