eslint-plugin-turbo 2.2.4-canary.9 → 2.3.1-canary.0

package/README.md

@@ -1,6 +1,6 @@
 # `eslint-plugin-turbo`
 
-Ease configuration for Turborepo
+Easy ESLint configuration for Turborepo
 
 ## Installation
 
@@ -16,7 +16,7 @@ npm install eslint --save-dev
 npm install eslint-plugin-turbo --save-dev
 ```
 
-## Usage
+## Usage (Legacy `eslintrc*`)
 
 Add `turbo` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
 
@@ -36,7 +36,7 @@ Then configure the rules you want to use under the rules section.
 }
 ```
 
-### Example
+## Example (Legacy `eslintrc*`)
 
 ```json
 {
@@ -51,3 +51,52 @@ Then configure the rules you want to use under the rules section.
   }
 }
 ```
+
+## Usage (Flat Config `eslint.config.js`)
+
+In ESLint v8, both the legacy system and the new flat config system are supported. In ESLint v9, only the new system will be supported. See the [official ESLint docs](https://eslint.org/docs/latest/use/configure/configuration-files).
+
+```js
+import turbo from "eslint-plugin-turbo";
+
+export default [turbo.configs["flat/recommended"]];
+```
+
+Otherwise, you may configure the rules you want to use under the rules section.
+
+```js
+import turbo from "eslint-plugin-turbo";
+
+export default [
+  {
+    plugins: {
+      turbo,
+    },
+    rules: {
+      "turbo/no-undeclared-env-vars": "error",
+    },
+  },
+];
+```
+
+## Example (Flat Config `eslint.config.js`)
+
+```js
+import turbo from "eslint-plugin-turbo";
+
+export default [
+  {
+    plugins: {
+      turbo,
+    },
+    rules: {
+      "turbo/no-undeclared-env-vars": [
+        "error",
+        {
+          allowList: ["^ENV_[A-Z]+$"],
+        },
+      ],
+    },
+  },
+];
+```

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as eslint from 'eslint';
-import { Rule } from 'eslint';
+import { Rule, ESLint } from 'eslint';
 
 interface EnvironmentConfig {
     legacyConfig: Array<string>;
@@ -24,6 +24,44 @@ interface RuleContextWithOptions extends Rule.RuleContext {
     }>;
 }
 
+declare const plugin: {
+    meta: {
+        name: string;
+        version: string;
+    };
+    rules: {
+        [x: string]: {
+            create: (context: RuleContextWithOptions) => eslint.Rule.RuleListener;
+            meta: eslint.Rule.RuleMetaData;
+        };
+    };
+    configs: {
+        recommended: {
+            settings: {
+                turbo: {
+                    cacheKey: number | ProjectKey;
+                };
+            };
+            plugins: string[];
+            rules: {
+                [x: string]: "error";
+            };
+        };
+        "flat/recommended": {
+            plugins: {
+                readonly turbo: ESLint.Plugin;
+            };
+            rules: {
+                [x: string]: "error";
+            };
+            settings: {
+                turbo: {
+                    cacheKey: number | ProjectKey;
+                };
+            };
+        };
+    };
+};
 declare const rules: {
     [x: string]: {
         create: (context: RuleContextWithOptions) => eslint.Rule.RuleListener;
@@ -39,9 +77,22 @@ declare const configs: {
         };
         plugins: string[];
         rules: {
-            [x: string]: string;
+            [x: string]: "error";
+        };
+    };
+    "flat/recommended": {
+        plugins: {
+            readonly turbo: ESLint.Plugin;
+        };
+        rules: {
+            [x: string]: "error";
+        };
+        settings: {
+            turbo: {
+                cacheKey: number | ProjectKey;
+            };
         };
     };
 };
 
-export { configs, rules };
+export { configs, plugin as default, rules };