fix: naming-convention errors

Added some basic tests for current cases for naming-convention as it’s very complicated.
tablecheck · Dec 5, 2023 · 4821395 · 4821395
1 parent 699d82a
commit 4821395
Show file tree

Hide file tree

Showing 7 changed files with 72 additions and 9 deletions.
diff --git a/packages/eslint-config/package.json b/packages/eslint-config/package.json
@@ -56,9 +56,6 @@
   "files": [
     "dist"
   ],
-  "scripts": {
-    "build": "tsc -p ./tsconfig.build.json"
-  },
   "dependencies": {
     "@emotion/eslint-plugin": "^11.11.0",
     "@nx/eslint-plugin": "^16.5.0",

diff --git a/packages/eslint-config/project.json b/packages/eslint-config/project.json
@@ -4,6 +4,26 @@
   "sourceRoot": "packages/eslint-config/src",
   "projectType": "library",
   "targets": {
+    "build": {
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "tsc -p packages/eslint-config/tsconfig.build.json"
+      }
+    },
+    "test": {
+      "executor": "@nx/linter:eslint",
+      "outputs": ["{options.outputFile}"],
+      "dependsOn": ["build"],
+      "options": {
+        "noEslintrc": true,
+        "eslintConfig": "packages/eslint-config/tests/.eslintrc.cjs",
+        "reportUnusedDisableDirectives": "error",
+        "lintFilePatterns": [
+          "packages/eslint-config/tests/**/*.ts",
+          "packages/eslint-config/tests/**/*.tsx"
+        ]
+      }
+    },
     "quality": {
       "executor": "@tablecheck/nx:quality",
       "outputs": ["{options.outputFile}"],

diff --git a/packages/eslint-config/src/presets/typescript.ts b/packages/eslint-config/src/presets/typescript.ts
@@ -22,6 +22,7 @@ module.exports = {
         ...promiseRules,
         ...emotionRules,
         ...namingRules,
+        'no-unused-vars': 'off',
         '@typescript-eslint/explicit-module-boundary-types': 'off',
       },
     }),
@@ -30,7 +31,6 @@ module.exports = {
       rules: {
         'import/no-default-export': 'off',
         'vars-on-top': 'off',
-        'no-unused-vars': 'off',
         '@typescript-eslint/no-unused-vars': 'off',
         '@typescript-eslint/no-empty-interface': 'warn',
         '@typescript-eslint/explicit-module-boundary-types': 'off',

diff --git a/packages/eslint-config/src/rules/namingConvention.ts b/packages/eslint-config/src/rules/namingConvention.ts
@@ -1,16 +1,18 @@
 import type { Linter } from 'eslint';
 
+const componentRegexpMatch = {
+  regex: '(?<![gs]et)Component$',
+  match: true,
+};
+
 export const namingRules: Linter.RulesRecord = {
   camelcase: 'off',
   '@typescript-eslint/naming-convention': [
     'error',
     {
       selector: 'default',
-      format: ['PascalCase'],
-      filter: {
-        regex: '(?<![gs]et)Component($|[A-Z0-9])',
-        match: true,
-      },
+      format: ['camelCase', 'PascalCase'],
+      filter: componentRegexpMatch,
     },
     {
       selector: 'default',
@@ -81,6 +83,11 @@ export const namingRules: Linter.RulesRecord = {
       modifiers: ['global'],
       format: ['camelCase', 'UPPER_CASE', 'PascalCase'],
     },
+    {
+      selector: 'variable',
+      format: ['PascalCase'],
+      filter: componentRegexpMatch,
+    },
     {
       selector: 'variable',
       format: ['camelCase', 'UPPER_CASE'],

diff --git a/packages/eslint-config/tests/.eslintrc.cjs b/packages/eslint-config/tests/.eslintrc.cjs
@@ -0,0 +1,12 @@
+const { namingRules } = require('../dist/rules/namingConvention');
+
+module.exports = {
+  plugins: ['@typescript-eslint'],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+    project: true,
+  },
+  rules: namingRules,
+};
diff --git a/packages/eslint-config/tests/namingConvention.ts/variables.tsx b/packages/eslint-config/tests/namingConvention.ts/variables.tsx
@@ -0,0 +1,13 @@
+/** Booleans */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const badName = true;
+const isBadName = true;
+const disabled = true;
+
+/** Dereferencing */
+function SomeComponent({ icon: Icon, command }) {
+  const { icon: IconComponent } = command;
+  // eslint-disable-next-line @typescript-eslint/naming-convention
+  const { other: Other } = command;
+  const iconComponentRef = null;
+}
diff --git a/packages/eslint-config/tests/tsconfig.json b/packages/eslint-config/tests/tsconfig.json
@@ -0,0 +1,14 @@
+{
+  "extends": "../tsconfig.json",
+  "include": ["**/*.ts", "**/*.tsx"],
+  "compilerOptions": {
+    "rootDir": ".",
+    "outDir": "dist",
+    "paths": {},
+    "types": ["vitest"],
+    "module": "NodeNext",
+    "resolveJsonModule": true
+  },
+  "exclude": ["node_modules"],
+  "files": []
+}