ContextQMD
Back to Eslint

ESLint Configuration

packages/eslint-config-eslint/README.md

10.3.03.6 KB
Original Source

ESLint Configuration

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

Contains the ESLint configuration used for projects maintained by the ESLint team.

Installation

You can install ESLint using npm or other package managers:

shell
npm install eslint -D
# or
yarn add eslint -D
# or
pnpm install eslint -D
# or
bun add eslint -D

Then install this configuration:

shell
npm install eslint-config-eslint -D
# or
yarn add eslint-config-eslint -D
# or
pnpm install eslint-config-eslint -D
# or
bun add eslint-config-eslint -D

Usage

ESM ("type":"module") projects

In your eslint.config.js file, add:

js
import { defineConfig } from "eslint/config";
import eslintConfigESLint from "eslint-config-eslint";

export default defineConfig([eslintConfigESLint]);

Note: This configuration array contains configuration objects with the files property.

  • files: ["**/*.js"]: ESM-specific configurations.
  • files: ["**/*.cjs"]: CommonJS-specific configurations.

CommonJS projects

In your eslint.config.js file, add:

js
const { defineConfig } = require("eslint/config");
const eslintConfigESLintCJS = require("eslint-config-eslint/cjs");

module.exports = defineConfig([eslintConfigESLintCJS]);

Base config

Note that the above configurations are intended for files that will run in Node.js. For files that will not run in Node.js, you should use the base config.

Here's an example of an eslint.config.js file for a website project with scripts that run in browser and CommonJS configuration files and tools that run in Node.js:

js
const { defineConfig } = require("eslint/config");
const eslintConfigESLintBase = require("eslint-config-eslint/base");
const eslintConfigESLintCJS = require("eslint-config-eslint/cjs");

module.exports = defineConfig([
	{
		files: ["scripts/*.js"],
		extends: [eslintConfigESLintBase],
	},
	{
		files: ["eslint.config.js", ".eleventy.js", "tools/*.js"],
		extends: [eslintConfigESLintCJS],
	},
]);

Formatting config

Note that none of the above configurations includes formatting rules. If you want to enable formatting rules, add the formatting config.

js
import { defineConfig } from "eslint/config";
import eslintConfigESLint from "eslint-config-eslint";
import eslintConfigESLintFormatting from "eslint-config-eslint/formatting";

export default defineConfig([eslintConfigESLint, eslintConfigESLintFormatting]);

Where to ask for help?

Open a discussion or stop by our Discord server instead of filing an issue.