diff options
Diffstat (limited to 'packages/eslint-plugin-turbo/README.md')
| -rw-r--r-- | packages/eslint-plugin-turbo/README.md | 53 |
1 files changed, 0 insertions, 53 deletions
diff --git a/packages/eslint-plugin-turbo/README.md b/packages/eslint-plugin-turbo/README.md deleted file mode 100644 index 83627a1..0000000 --- a/packages/eslint-plugin-turbo/README.md +++ /dev/null @@ -1,53 +0,0 @@ -# `eslint-plugin-turbo` - -Ease configuration for Turborepo - -## Installation - -1. You'll first need to install [ESLint](https://eslint.org/): - -```sh -npm install eslint --save-dev -``` - -2. Next, install `eslint-plugin-turbo`: - -```sh -npm install eslint-plugin-turbo --save-dev -``` - -## Usage - -Add `turbo` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix: - -```json -{ - "plugins": ["turbo"] -} -``` - -Then configure the rules you want to use under the rules section. - -```json -{ - "rules": { - "turbo/no-undeclared-env-vars": "error" - } -} -``` - -### Example - -```json -{ - "plugins": ["turbo"], - "rules": { - "turbo/no-undeclared-env-vars": [ - "error", - { - "allowList": ["^ENV_[A-Z]+$"] - } - ] - } -} -``` |
