aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/packages/eslint-plugin-turbo/README.md
diff options
context:
space:
mode:
author简律纯 <hsiangnianian@outlook.com>2023-04-28 01:36:44 +0800
committer简律纯 <hsiangnianian@outlook.com>2023-04-28 01:36:44 +0800
commitdd84b9d64fb98746a230cd24233ff50a562c39c9 (patch)
treeb583261ef00b3afe72ec4d6dacb31e57779a6faf /packages/eslint-plugin-turbo/README.md
parent0b46fcd72ac34382387b2bcf9095233efbcc52f4 (diff)
downloadHydroRoll-dd84b9d64fb98746a230cd24233ff50a562c39c9.tar.gz
HydroRoll-dd84b9d64fb98746a230cd24233ff50a562c39c9.zip
Diffstat (limited to 'packages/eslint-plugin-turbo/README.md')
-rw-r--r--packages/eslint-plugin-turbo/README.md53
1 files changed, 53 insertions, 0 deletions
diff --git a/packages/eslint-plugin-turbo/README.md b/packages/eslint-plugin-turbo/README.md
new file mode 100644
index 0000000..83627a1
--- /dev/null
+++ b/packages/eslint-plugin-turbo/README.md
@@ -0,0 +1,53 @@
+# `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]+$"]
+ }
+ ]
+ }
+}
+```