@lytovka/eslint-config

Installation

This module is distributed via npm and should be installed as one of your project's devDependencies. You should also have required eslint peerDependency installed.

npm i -D eslint @lytovka/eslint-config

Usage

Then, add the extends to your .eslintrc.js:

module.exports = {
  extends: ["@lytovka"],
  rules: {
    // override rules if needed
  },
}

In addition, you can add scripts to your package.json to identify errors and warnings. For example:

{
  "scripts": {
    "lint": "eslint --max-warnings 0 --cache --cache-location ./node_modules/.cache/.eslintcache --ext js,jsx,ts,tsx .",
    "lint:fix": "eslint --fix ."
  }
}

Other configs

Currently this module exposes a few additional configs:

• @lytovka/eslint-config/react: preset for React projects.
• @lytovka/eslint-config/jsx-a11y: preset for accessibility issues in React apps.
• @lytovka/eslint-config/import: preset for import rules (both JavaScript and TypeScript projects).

Feel free to add those configs to the extend property:

module.exports = {
  extends: [
    "@lytovka",
    "@lytovka/eslint-config/react",
    "@lytovka/eslint-config/jsx-a11y",
    "@lytovka/eslint-config/import"
  ],
  rules: {
    // override rules
  },
}

TypeScript rules

By default, this module will search for tsconfig.json in the project root to determine if TypeScript ESLint rules should be enabled. Alternatively, you can overwrite the ESLINT_TSCONFIG_PATH environment variable to scan for a different file. For example:

// .eslintrc.js
process.env.ESLINT_TSCONFIG_PATH = "tsconfig.eslint.json"

module.exports = {
  extends: ["@lytovka"]
}