fix(eslint-plugin-nestjs-tools): follow eslint plugin recommendations

getlarge · Sep 13, 2024 · 45dc0a0 · 45dc0a0
1 parent 93c44b4
commit 45dc0a0
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 8 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -63,6 +63,7 @@
     "dotenv": "^16.4.5",
     "eslint": "~8.57.0",
     "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-eslint-plugin": "^6.2.0",
     "eslint-plugin-import": "^2.29.0",
     "eslint-plugin-max-params-no-constructor": "^0.0.4",
     "eslint-plugin-simple-import-sort": "^12.0.0",

diff --git a/packages/eslint-plugin/.eslintrc.json b/packages/eslint-plugin/.eslintrc.json
@@ -1,10 +1,12 @@
 {
-  "extends": ["../../.eslintrc.json"],
+  "extends": ["../../.eslintrc.json", "plugin:eslint-plugin/recommended"],
   "ignorePatterns": ["!**/*"],
   "overrides": [
     {
       "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
-      "rules": {}
+      "rules": {
+        "eslint-plugin/require-meta-docs-description": "error"
+      }
     },
     {
       "files": ["*.ts", "*.tsx"],

diff --git a/packages/eslint-plugin/src/lib/return-class-instance.ts b/packages/eslint-plugin/src/lib/return-class-instance.ts
@@ -31,7 +31,7 @@ export const rule = ESLintUtils.RuleCreator(() => __filename)({
   meta: {
     type: 'problem',
     docs: {
-      description: 'Ensure service methods return class instances',
+      description: 'enforce service methods return class instances',
     },
     schema: [],
     messages: {