Guide · Open source
How to use typescript-eslint: setup and TypeScript linting basics
Updated · written with AI from the project's own documentation and checked against our catalogue data
typescript-eslint is a set of packages that let ESLint, a popular linter for JavaScript, understand and check TypeScript code. This guide explains what it does, what you need before starting, and how to set it up in a project. By the end you will know where it fits in a TypeScript workflow and what to check before adopting it.
typescript-eslinttypescript-eslint/typescript-eslint · ★ 16.5k · MIT Install options & downloads Quick start
- 1Confirm prerequisites. Make sure your project already uses Node.js, ESLint and TypeScript.
- 2Get the source. Clone the repository with git clone https://github.com/typescript-eslint/typescript-eslint if you want the monorepo locally.
- 3Open the documentation. Go to typescript-eslint.io for setup instructions for the latest released version.
- 4Set up the parser and plugin. Follow the documentation to add the parser, plugin rules and shared configuration to your ESLint setup.
- 5Run ESLint on TypeScript files. Run your linter on your TypeScript code and review the reported problems.
- 6Agree on a shared config. Use the shared configuration so the whole team applies the same checks.
What typescript-eslint does
typescript-eslint provides a parser, plugin rules, and shared configuration. Together these let ESLint read TypeScript syntax and report problems or style issues in your code.
The project describes its work as static analysis, which means it checks code without running it.
- Parser: lets ESLint read TypeScript source.
- Plugin rules: TypeScript-aware lint rules.
- Shared configuration: a common setup you can extend across a codebase.
Check the prerequisites
The project lists Node.js, ESLint and TypeScript as prerequisites. typescript-eslint only extends ESLint, so it is not useful on its own in a project that does not use ESLint or TypeScript.
- Node.js
- ESLint
- TypeScript
Get the typescript-eslint source
The README's install instruction is to clone the repository. This gives you the monorepo source, which contains all of the packages. The README points to the documentation site at typescript-eslint.io for documentation on the latest released version, and that site is the place to find how to configure the packages in a project.
git clone https://github.com/typescript-eslint/typescript-eslintRead the documentation for configuration
The README does not walk through configuration in detail. Use the documentation at typescript-eslint.io to find the current package names and setup steps for your ESLint and TypeScript versions. The README also links to a canary-release documentation site for the newest unreleased changes.
- Use typescript-eslint.io for the latest released version.
- Use the canary documentation only if you need unreleased changes.
Use it across a team
Because typescript-eslint offers shared configuration, a team can agree on one set of rules and apply it across a TypeScript codebase. This helps keep checks consistent between developers.
What people use it for
- Catching problems in TypeScript code through static analysis without running it.
- Enforcing a consistent code style across a TypeScript codebase.
- Applying TypeScript-aware lint rules inside an existing ESLint setup.
- Sharing one lint configuration across several developers on the same project.
Frequently asked questions
Is typescript-eslint free?
Yes. The project is licensed under the MIT license, which is a permissive open-source license. The README describes it as permissive MIT licensed.
What do I need before installing typescript-eslint?
The project lists Node.js, ESLint and TypeScript as prerequisites. It extends ESLint, so you need ESLint in your project for it to be useful.
Does typescript-eslint work without ESLint?
No. The tools only extend ESLint, so a project that does not use ESLint is not a good fit.
Is typescript-eslint a standalone app?
No. It is a set of developer packages, not an application with a graphical interface.
How does typescript-eslint compare to Biome or oxc?
The source material only lists ESLint, Biome and oxc as comparable projects. It does not compare their features, so check each project's documentation to decide which fits your needs.
Where is the official documentation?
The README points to typescript-eslint.io for documentation on the latest released version. A canary-release documentation site is also linked for newer unreleased changes.
New agent skills, repos and AI tools — every week
The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.
Our verdict
typescript-eslint suits JavaScript and TypeScript developers who already use ESLint and want consistent, TypeScript-aware checks across a team. If your project does not use TypeScript or ESLint, or you want a standalone app with a graphical interface, it is not the right tool, and you may want to compare alternatives such as ESLint, Biome or oxc.
Install options & downloads