eslint-config

@guardian/eslint-config

ESLint configs for Guardian JavaScript and TypeScript projects.

Installation

npm install --save-dev @guardian/eslint-config

# or
yarn add --dev @guardian/eslint-config

# or
pnpm install --save-dev @guardian/eslint-config

Usage

Example

// eslint.config.js

import guardian from '@guardian/eslint-config';

export default [
	...guardian.configs.recommended,
	...guardian.configs.jest,
	...guardian.configs.react,
	...guardian.configs.storybook,
];

Configs

The package's default export is an object with a configs property that provides configs for different projects.

Some of them are single-purpose, and others compose the single-purpose configs into useful presets.

configs.recommended

Provides a recommended collection of useful configs covering both JavaScript and TypeScript.

Composes:

• configs.javascript
• configs.typescript
• configs.imports
• configs.comments

configs.javascript

Included in configs.recommended.

Provides a collection of configs for checking JavaScript, which are also applied to TypeScript files.

It automatically detects your project type (using package.json#type), and uses an appropriate config for each file.

Composes:

• configs.esm
• configs.cjs

configs.esm

Included in configs.javascript.

Provides a collection of configs for ECMAScript modules.

It assumes everything will be ECMAScript, and will error if you use it on a CommonJS module.

configs.cjs

Included in configs.javascript.

Provides a collection of configs for CommonJS modules.

It assumes everything will be CommonJS, and will error if you use it on an ECMAScript module.

configs.typescript

Included in configs.recommended.

Provides a collection of configs for checking TypeScript.

configs.imports

Included in configs.recommended.

Provides a collection of configs ensuring best practice around module imports and exports.

configs.comments

Included in configs.recommended.

Provides a collection of configs ensuring best practice around code comments.

configs.jest

Provides a collection of configs for checking Jest units tests.

configs.react

Provides a collection of configs for checking React components.

configs.storybook

Provides a collection of configs for checking Storybook stories.

When using the storybook config, be sure to also have eslint-plugin-storybook and storybook installed in your project, otherwise the config will be ignored.