ContextQMD
Back to Turborepo

`eslint-config-turbo`

packages/eslint-config-turbo/README.md

2.9.91.2 KB
Original Source

eslint-config-turbo

Ease configuration for Turborepo

Installation

  1. You'll first need to install ESLint:
sh
npm install eslint --save-dev
  1. Next, install eslint-config-turbo:
sh
npm install eslint-config-turbo --save-dev

Usage (Flat Config eslint.config.js)

js
import turboConfig from "eslint-config-turbo/flat";

export default [
  ...turboConfig
  // Other configuration
];

You can also configure rules available in the configuration:

js
import turboConfig from "eslint-config-turbo/flat";

export default [
  ...turboConfig,
  // Other configuration
  {
    rules: {
      "turbo/no-undeclared-env-vars": [
        "error",
        {
          allowList: ["^ENV_[A-Z]+$"]
        }
      ]
    }
  }
];

Usage (Legacy eslintrc*)

Add turbo to the extends section of your eslint configuration file. You can omit the eslint-config- prefix:

json
{
  "extends": ["turbo"]
}

You can also configure rules available in the configuration:

json
{
  "extends": ["turbo"],
  "rules": {
    "turbo/no-undeclared-env-vars": [
      "error",
      {
        "allowList": ["^ENV_[A-Z]+$"]
      }
    ]
  }
}