eslint-cdk-plugin 1.0.1 → 1.0.3

package/README.md

@@ -29,33 +29,60 @@ pnpm install -D eslint-cdk-plugin
 
 ## 🚀 Usage
 
-#### Use recommended config
+Note: This plugin uses typescript type information and must be used in conjunction with [typescript-eslint](https://typescript-eslint.io/getting-started).
+
+### When using recommended config
 
 ```js
 // eslint.config.mjs
 import eslintCdkPlugin from "eslint-cdk-plugin";
+import tsEslint from "typescript-eslint";
+
 export default [
+  ...tsEslint.configs.recommended,
   {
+    files: ["lib/**/*.ts", "bin/*.ts"],
+    languageOptions: {
+      parserOptions: {
+        projectService: true,
+        project: "./tsconfig.json",
+      },
+    },
+    // ✅ Add plugins
     plugins: {
       cdk: eslintCdkPlugin,
     },
+    // ✅ Add rules (use recommended rules)
     rules: {
       ...eslintCdkPlugin.configs.recommended.rules,
+      "cdk/no-import-private": "error",
     },
   },
 ];
 ```
 
-#### Use custom config
+### When using custom config
 
 ```js
 // eslint.config.mjs
+import tsEslint from "typescript-eslint";
 import eslintCdkPlugin from "eslint-cdk-plugin";
+
 export default [
+  ...tsEslint.configs.recommended,
   {
+    files: ["lib/**/*.ts", "bin/*.ts"],
+    languageOptions: {
+      parserOptions: {
+        projectService: true,
+        project: "./tsconfig.json",
+      },
+    },
+    // ✅ Add plugins
     plugins: {
       cdk: eslintCdkPlugin,
     },
+    // ✅ Add rules (use custom rules)
     rules: {
       "cdk/no-class-in-interface": "error",
       "cdk/no-construct-stack-suffix": "error",