@cnri/eslint-config

A comprehensive ESLint configuration used for JavaScript and TypeScript projects.

Installation

If you are upgrading from an earlier version of this config with different peer dependencies, you may need to remove them before installing the new ones:

npm remove @babel/eslint-parser @cnri/eslint-config eslint eslint-plugin-import @typescript-eslint/eslint-plugin @typescript-eslint/parser

Install the package. Note npm v7 will automaticalling install its peer dependencies. If you use any of the peer dependencies explicitly (as in the imports of eslint.config.js) install them explicitly as needed to avoid errors linting eslint.config.js; here we install eslint explicitly.

# Install the config and eslint
npm install -D @cnri/eslint-config eslint

# Install peer dependencies, only if needed
npm install -D @eslint/js eslint-plugin-import eslint-plugin-n globals typescript-eslint @stylistic/eslint-plugin

Usage

In your ESLint configuration file (eslint.config.js), import and use this configuration:

import cnriConfig from '@cnri/eslint-config';
import { defineConfig } from 'eslint/config';

export default defineConfig([
    {
        extends: [ cnriConfig ]
    }
]);

You can also extend the configuration with your own rules:

import cnriConfig from '@cnri/eslint-config';
import { defineConfig } from 'eslint/config';

export default defineConfig([
    {
        extends: [ cnriConfig ],
        // Your custom configuration here
    }
]);