@rebeccastevens/eslint-config

My ESLint Config

An ESLint Shareable Config.

Installation

pnpm add -D  \
  eslint \
  @rebeccastevens/eslint-config

pnpm dlx install-peerdeps @rebeccastevens/eslint-config --dev -o -Y

Note: This project doesn't strictly follow semantic versioning so be sure to pin the version you are using.

Usage

Language

JavaScript (Modern)

Install Peer Dependencies:

pnpm add -D \
  babel-eslint \
  eslint-plugin-eslint-comments \
  eslint-plugin-functional \
  eslint-plugin-import \
  eslint-import-resolver-typescript \
  eslint-plugin-jsdoc \
  eslint-plugin-markdown \
  eslint-plugin-n \
  eslint-plugin-optimize-regex \
  eslint-plugin-promise \
  eslint-plugin-sonarjs \
  eslint-plugin-unicorn

Configure your project's .eslintrc.json file.

{
  "root": true,
  "extends": ["@rebeccastevens/eslint-config/modern"],
  "rules": {
    // Additional, per-project rules...
  },
  "overrides": [
    {
      "files": ["**/*.test.ts"],
      "rules": {}
    }
  ]
}

TypeScript

Install Peer Dependencies:

pnpm add -D  \
  @typescript-eslint/parser \
  @typescript-eslint/eslint-plugin \
  eslint-plugin-eslint-comments \
  eslint-plugin-functional \
  eslint-plugin-import \
  eslint-import-resolver-typescript \
  eslint-plugin-jsdoc \
  eslint-plugin-markdown \
  eslint-plugin-n \
  eslint-plugin-optimize-regex \
  eslint-plugin-promise \
  eslint-plugin-sonarjs \
  eslint-plugin-unicorn

Configure your project's .eslintrc.json file.

{
  "root": true,
  "parserOptions": {
    "project": "tsconfig.json"
  },
  "extends": [
    "@rebeccastevens/eslint-config/modern",
    "@rebeccastevens/eslint-config/typescript"
  ],
  "rules": {
    // Additional, per-project rules...
  },
  "overrides": [
    {
      "files": ["**/*.test.ts"],
      "rules": {}
    }
  ]
}

See ESLint configuration for more information.