Repository files navigation

Website |Configure ESLint |Rules |Contribute to ESLint |Report Bugs |Code of Conduct |Twitter |Discord |Mastodon |Bluesky

ESLint is a tool for identifying and reporting on patterns found in ECMAScript/JavaScript code. In many ways, it is similar to JSLint and JSHint with a few exceptions:

• ESLint usesEspree for JavaScript parsing.
• ESLint uses an AST to evaluate patterns in code.
• ESLint is completely pluggable, every single rule is a plugin and you can add more at runtime.

1. Installation and Usage
2. Configuration
3. Version Support
4. Code of Conduct
5. Filing Issues
6. Frequently Asked Questions
7. Releases
8. Security Policy
9. Semantic Versioning Policy
10. License
11. Team
12. Sponsors
13. Technology Sponsors

Prerequisites:Node.js (^18.18.0,^20.9.0, or>=21.1.0) built with SSL support. (If you are using an official Node.js distribution, SSL is always built in.)

You can install and configure ESLint using this command:

npm init @eslint/config@latest

After that, you can run ESLint on any file or directory like this:

npx eslint yourfile.js

To use ESLint with pnpm, we recommend setting up a.npmrc file with at least the following settings:

auto-install-peers=truenode-linker=hoisted

This ensures that pnpm installs dependencies in a way that is more compatible with npm and is less likely to produce errors.

You can configure rules in youreslint.config.js files as in this example:

import{defineConfig}from"eslint/config";exportdefaultdefineConfig([{files:["**/*.js","**/*.cjs","**/*.mjs"],rules:{"prefer-const":"warn","no-constant-binary-expression":"error",},},]);

The names"prefer-const" and"no-constant-binary-expression" are the names ofrules in ESLint. The first value is the error level of the rule and can be one of these values:

• "off" or0 - turn the rule off
• "warn" or1 - turn the rule on as a warning (doesn't affect exit code)
• "error" or2 - turn the rule on as an error (exit code will be 1)

The three error levels allow you fine-grained control over how ESLint applies rules (for more configuration options and details, see theconfiguration docs).

The ESLint team provides ongoing support for the current version and six months of limited support for the previous version. Limited support includes critical bug fixes, security issues, and compatibility issues only.

ESLint offers commercial support for both current and previous versions through our partners,Tidelift andHeroDevs.

SeeVersion Support for more details.

ESLint adheres to theOpenJS Foundation Code of Conduct.

Before filing an issue, please be sure to read the guidelines for what you're reporting:

• Bug Report
• Propose a New Rule
• Proposing a Rule Change
• Request a Change

Yes, ESLint natively supports parsing JSX syntax (this must be enabled inconfiguration). Please note that supporting JSX syntaxis not the same as supporting React. React applies specific semantics to JSX syntax that ESLint doesn't recognize. We recommend usingeslint-plugin-react if you are using React and want React semantics.

No, ESLint and Prettier have different jobs: ESLint is a linter (looking for problematic patterns) and Prettier is a code formatter. Using both tools is common, refer toPrettier's documentation to learn how to configure them to work well with each other.

ESLint has full support for ECMAScript 3, 5, and every year from 2015 up until the most recent stage 4 specification (the default). You can set your desired ECMAScript syntax and other settings (like global variables) throughconfiguration.

ESLint's parser only officially supports the latest final ECMAScript standard. We will make changes to core rules in order to avoid crashes on stage 3 ECMAScript syntax proposals (as long as they are implemented using the correct experimental ESTree syntax). We may make changes to core rules to better work with language extensions (such as JSX, Flow, and TypeScript) on a case-by-case basis.

In other cases (including if rules need to warn on more or fewer cases due to new syntax, rather than just not crashing), we recommend you use other parsers and/or rule plugins. If you are using Babel, you can use@babel/eslint-parser and@babel/eslint-plugin to use any option available in Babel.

Once a language feature has been adopted into the ECMAScript standard (stage 4 according to theTC39 process), we will accept issues and pull requests related to the new feature, subject to ourcontributing guidelines. Until then, please use the appropriate parser and plugin(s) for your experimental feature.

ESLint updates the supported Node.js versions with each major release of ESLint. At that time, ESLint's supported Node.js versions are updated to be:

1. The most recent maintenance release of Node.js
2. The lowest minor version of the Node.js LTS release that includes the features the ESLint team wants to use.
3. The Node.js Current release

ESLint is also expected to work with Node.js versions released after the Node.js Current release.

Refer to theQuick Start Guide for the officially supported Node.js versions for a given ESLint release.

Open adiscussion or stop by ourDiscord server.

Lock files likepackage-lock.json are helpful for deployed applications. They ensure that dependencies are consistent between environments and across deployments.

Packages likeeslint that get published to the npm registry do not include lock files.npm install eslint as a user will respect version constraints in ESLint'spackage.json. ESLint and its dependencies will be included in the user's lock file if one exists, but ESLint's own lock file would not be used.

We intentionally don't lock dependency versions so that we have the latest compatible dependency versions in development and CI that our users get when installing ESLint in a project.

The Twilio blog has adeeper dive to learn more.

We have scheduled releases every two weeks on Friday or Saturday. You can follow arelease issue for updates about the scheduling of any particular release.

ESLint takes security seriously. We work hard to ensure that ESLint is safe for everyone and that security issues are addressed quickly and responsibly. Read the fullsecurity policy.

ESLint followssemantic versioning. However, due to the nature of ESLint as a code quality tool, it's not always clear when a minor or major version bump occurs. To help clarify this for everyone, we've defined the following semantic versioning policy for ESLint:

• Patch release (intended to not break your lint build)
  • A bug fix in a rule that results in ESLint reporting fewer linting errors.
  • A bug fix to the CLI or core (including formatters).
  • Improvements to documentation.
  • Non-user-facing changes such as refactoring code, adding, deleting, or modifying tests, and increasing test coverage.
  • Re-releasing after a failed release (i.e., publishing a release that doesn't work for anyone).
• Minor release (might break your lint build)
  • A bug fix in a rule that results in ESLint reporting more linting errors.
  • A new rule is created.
  • A new option to an existing rule that does not result in ESLint reporting more linting errors by default.
  • A new addition to an existing rule to support a newly-added language feature (within the last 12 months) that will result in ESLint reporting more linting errors by default.
  • An existing rule is deprecated.
  • A new CLI capability is created.
  • New capabilities to the public API are added (new classes, new methods, new arguments to existing methods, etc.).
  • A new formatter is created.
  • eslint:recommended is updated and will result in strictly fewer linting errors (e.g., rule removals).
• Major release (likely to break your lint build)
  • eslint:recommended is updated and may result in new linting errors (e.g., rule additions, most rule option updates).
  • A new option to an existing rule that results in ESLint reporting more linting errors by default.
  • An existing formatter is removed.
  • Part of the public API is removed or changed in an incompatible way. The public API includes:
    • Rule schemas
    • Configuration schema
    • Command-line options
    • Node.js API
    • Rule, formatter, parser, plugin APIs

According to our policy, any minor update may report more linting errors than the previous release (ex: from a bug fix). As such, we recommend using the tilde (~) inpackage.json e.g."eslint": "~3.1.0" to guarantee the results of your builds.

MIT License

Copyright OpenJS Foundation and other contributors, <www.openjsf.org>

Permission is hereby granted, free of charge, to any person obtaining a copyof this software and associated documentation files (the "Software"), to dealin the Software without restriction, including without limitation the rightsto use, copy, modify, merge, publish, distribute, sublicense, and/or sellcopies of the Software, and to permit persons to whom the Software isfurnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included inall copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THEAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHERLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS INTHE SOFTWARE.

These folks keep the project moving and are resources for help.

The people who manage releases, review feature requests, and meet regularly to ensure ESLint is properly maintained.

Nicholas C. Zakas

Francesco Trotta

Milos Djermanovic

The people who review and implement new features.

唯然	Nitin Kumar

The people who review and fix bugs and help triage issues.

Josh Goldberg ✨

Tanuj Kanti

Team members who focus specifically on eslint.org

Amaresh S M

Strek

Percy Ma

The following companies, organizations, and individuals support ESLint's ongoing maintenance and development.Become a Sponsorto get your logo on our READMEs andwebsite.