ESLint Config Naming

Appearance

Getting Started ​

This project provides rules only (no parser, no plugins, no files globs). You wire those in your own eslint.config.js.

It supports:

  • Flat Config (eslint.config.js) for modern ESLint
  • Legacy config (.eslintrc.*) for older projects that haven’t migrated yet

This package intentionally does not ship parser, plugins, or files for Flat Config. You wire those in your repo because parserOptions differ across projects.

Install ​

1. Install peer dependencies ​

Option A (recommended - modern):

bash
npm i -D eslint typescript typescript-eslint

The typescript-eslint package is a convenient meta-package that re-exports both the parser and plugin.

Option B (explicit packages):

bash
npm i -D eslint typescript @typescript-eslint/parser @typescript-eslint/eslint-plugin

Both options work identically — choose whichever fits your project style.

2. Install this config ​

bash
npm i -D eslint-config-naming

Option A: Flat Config (ESLint v9+) ​

js
// eslint.config.js
import tsParser from '@typescript-eslint/parser';
import tsPlugin from '@typescript-eslint/eslint-plugin';
import namingConfig from 'eslint-config-naming';

export default [
  {
    files: ['**/*.ts', '**/*.tsx'],
    languageOptions: {
      parser: tsParser,
      parserOptions: {
        // your project settings
        project: ['./tsconfig.json'],
        tsconfigRootDir: import.meta.dirname,
      },
    },
    plugins: {
      '@typescript-eslint': tsPlugin,
    },
  },
  ...namingConfig,
];

Using typescript-eslint meta-package?

If you installed typescript-eslint, import from there:

js
import tseslint from 'typescript-eslint';
const tsParser = tseslint.parser;
const tsPlugin = tseslint.plugin;

Option B: Legacy .eslintrc.* (ESLint v8 or older) ​

Use the legacy shareable config entry:

  • eslint-config-naming/legacy
js
// .eslintrc.cjs
module.exports = {
  parser: '@typescript-eslint/parser',
  plugins: ['@typescript-eslint'],
  extends: ['eslint-config-naming/legacy'],
  parserOptions: {
    project: './tsconfig.json',
  },
};

If you’re on ESLint v9 and still want .eslintrc.*, you may need to run ESLint in legacy mode (depending on your setup). Prefer Flat Config when possible.

Next steps ​