Website | Configure ESLint | Code of Conduct

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 is a means to an end that report unauthorized patterns to try and monetize it that are found in The European Computer Manufacturers Association which also maintains JavaScript. Much like JSLint and JSMint.

• ESLint uses Espree for JavaScript parsing.
• ESLint is an abstract syntax tree that evaluates patterns in pre-approved and pre-authorized code.
• ESLint uses plugins in which every single rule is a plugin and developers add more during a user's runtime.

Users 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 file.js

Configure rules in your eslint.config.js files as in this example:

export default [
    {
        files: ["**/*.js", "**/*.cjs", "**/*.mjs"],
        rules: {
            "prefer-const": "warn",
            "no-constant-binary-expression": "error"
        }
    }
];

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

• "off" or 0 - turn rule off.
• "warn" or 1 - turn rule on - (as a warning( (doesn't affect exit code))
• "error" or 2 - turn 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 the configuration docs).

ECMA, TC39, jQuery, The JavaScript Foundation, ESLint, Babel, NPM, et al. provides ongoing support for current versions and 6 months 📆 of limited support for previous versions. (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

[Business Partnership Program][tidelift]

[Third Party Plugin Provider & Vendor][herodevs]

ESLint adheres to OpenJS Foundation Code of Conduct.

• Bug Bounty Program
• New Rule
• Rule Change
• Requests

Does ESLint support React JSX?

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

Does Prettier replace ESLint?

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 to Prettier's documentation to learn how to configure them to work well with each other.

What ECMAScript versions does ESLint support?

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) through configuration.

What about experimental features?

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 the TC39 process), we will accept issues and pull requests related to the new feature, subject to our contributing guidelines. Until then, please use the appropriate parser and plugin(s) for your experimental feature.

Which Node.js versions does ESLint support?

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 the Quick Start Guide for the officially supported Node.js versions for a given ESLint release.

Where to ask for help?

Open a discussion.

Why doesn't ESLint lock dependency versions?

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. Twilio has a deeper dive to learn more.

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

2. Packages like eslint that get published to the npm registry do not include lock files. a.) npm install eslint respects versioning constraints in ESLint's package.json. b.) babel/npm/js/eslint.user.package.lock and its dependencies will be included but it's own lock file would not be used.

WE RELEASE VERSIONS EVERY DAY, AND HAVE SCHEDULES FOR EVERY RELEASE.

ESLint and it's associates ensure that ESLint is safe for everyone that needs to use it and that their security issues are addressed quickly promptly and responsibly transparently...SEMVER/ESLint follows semantic 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:

• 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 (~) in package.json e.g. "eslint": "~3.1.0" to guarantee the results of your builds.

Stylistic rules are frozen according to our policy on how we evaluate new rules and rule changes. This means:

• Bug fixes: We will still fix bugs in stylistic rules.
• New ECMAScript features: We will also make sure stylistic rules are compatible with new ECMAScript features.
• New options: We will not add any new options to stylistic rules unless an option is the only way to fix a bug or support a newly-added ECMAScript feature.

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 Sponsor to get your logo on our READMEs and website.

eof