@zalib/linter 2.0.1 → 2.0.2

package/README.md

@@ -6,29 +6,35 @@ npm i --save-dev --save-exact @zalib/linter
 ## Подключение конфигов
 
 ### eslint
-Пример конфига **.eslintrc.js** из корня сервиса.
+Начиная с версии **eslint@9** изменился подход к файлам настройки. Файлы .eslintignore и .eslint.js заменяются одним файлом eslint.config.js (по умолчанию). Пример конфига **eslint.config.js** из корня сервиса.
 ```
-const jsEslintConfig = require('@zalib/linter/eslint/node-js');
-const tsEslintConfig = require('@zalib/linter/eslint/node-ts');
+const { defineConfig } = require('eslint/config');
 
-module.exports = {
-  overrides: [
-    {
-      ...jsEslintConfig,
-      files: ['*.js'],
-    },
-    {
-      ...tsEslintConfig,
-      files: ['*.ts'],
-      parser: '@typescript-eslint/parser',
-      parserOptions: {
-        include: ['./src/**/*.ts', './test/**/*.ts'],
-        project: './tsconfig.json',
-      },
-    },
-  ],
-  root: true,
-};
+module.exports = defineConfig([
+  {
+    ignores: ['**/node_modules/**', '**/dist/**'],
+  },
+  require('@zalib/linter/eslint/node')(),
+  require('@zalib/linter/eslint/node-ts')(), // если нужен
+]);
+```
+
+Если необходимо ограничить путь к файлам только определенными директориями или для TS-проекта файл tsconfig.json имеет специфический путь или имя, тогда подключение нужно проводить с указанием необходимых параметров:
+```
+const { defineConfig } = require('eslint/config');
+
+module.exports = defineConfig([
+  {
+    ignores: ['**/node_modules/**', '**/dist/**'],
+  },
+  require('@zalib/linter/eslint/node')({
+    files: ['src/**/*.js', 'src/**/*.ts'] // или просто ['src/**/*.js']
+  }),
+  require('@zalib/linter/eslint/node-ts')({
+    files: ['src/**/*.ts', 'examples/**/*.ts'],
+    tsconfig: './tsconfig.dev.json'
+  }),
+]);
 ```
 
 ### prettier
@@ -43,9 +49,9 @@ module.exports = {
 Добавить в **package.json** в секцию **scripts**:
 ```
 "format": "prettier --write 'src/**/*.ts'",
-"lint": "eslint 'src/**/*.{ts,js}' --quiet",
-"lint:fix": "eslint 'src/**/*.{js,ts}' --quiet --fix",
-"lint:warns": "eslint 'src/**/*.ts' --max-warnings 0",
+"lint": "eslint --quiet",
+"lint:fix": "eslint --quiet --fix",
+"lint:warns": "eslint --max-warnings 0",
 ```
 
 ### Автоматизация при работе в репозитории

package/eslint/helpers/index.js

@@ -0,0 +1,16 @@
+/**
+ * Хелпер для проверки установки плагина
+ */
+const isModuleInstalled = (moduleName) => {
+  try {
+    require.resolve(moduleName);
+
+    return true;
+  } catch {
+    return false;
+  }
+};
+
+module.exports = {
+  isModuleInstalled,
+};

package/eslint/nestjs.js

@@ -0,0 +1,11 @@
+const nestjsPlugin = require('./plugin-nestjs');
+
+module.exports = ({ files } = {}) => ({
+  files: files || ['**/*.controller.ts'],
+  plugins: {
+    nestjs: nestjsPlugin,
+  },
+  rules: {
+    'nestjs/api-response': 'error',
+  },
+});

package/eslint/node-ts.js

@@ -1,4 +1,11 @@
-const nodeBaseConfig = require('./node');
+/* eslint-disable sort-keys */
+/* eslint-disable max-lines-per-function */
+
+const tsParser = require('@typescript-eslint/parser');
+const tsEslintPlugin = require('@typescript-eslint/eslint-plugin');
+const tsImportSortPlugin = require('eslint-plugin-simple-import-sort');
+const tsSortPlugin = require('eslint-plugin-typescript-sort');
+const tsImportPlugin = require('eslint-plugin-import');
 
 function eslintMembersGroup(suffix) {
   return [
@@ -28,31 +35,42 @@ function eslintMembersGroup(suffix) {
   ];
 }
 
-module.exports = {
-  env: {
-    ...nodeBaseConfig.env,
+module.exports = ({ files, tsconfig } = {}) => ({
+  files: files || ['**/*.ts'],
+  languageOptions: {
+    parser: tsParser,
+    parserOptions: {
+      ecmaFeatures: { modules: true },
+      project: tsconfig || './tsconfig.json',
+      sourceType: 'module',
+    },
+  },
+  plugins: {
+    '@typescript-eslint': tsEslintPlugin,
+    'simple-import-sort': tsImportSortPlugin,
+    'typescript-sort': tsSortPlugin,
+    import: tsImportPlugin,
+  },
+  settings: {
+    'import/resolver': {
+      typescript: {
+        project: tsconfig || './tsconfig.json',
+      },
+    },
   },
-  extends: [
-    ...nodeBaseConfig.extends,
-    'typescript/base',
-    'plugin:@typescript-eslint/recommended',
-    'plugin:@typescript-eslint/recommended-requiring-type-checking',
-    'plugin:import/errors',
-    'plugin:import/typescript',
-    'plugin:import/warnings',
-  ],
-  files: ['*.ts'],
-  parser: '@typescript-eslint/parser',
-  plugins: [
-    ...nodeBaseConfig.plugins,
-    '@typescript-eslint', 
-    'simple-import-sort',
-    'typescript-sort',
-  ],
   rules: {
-    ...nodeBaseConfig.rules,
-    '@typescript-eslint/await-thenable': 1,
-    '@typescript-eslint/brace-style': 0,
+    ...tsEslintPlugin.configs.recommended.rules,
+    ...tsEslintPlugin.configs['recommended-requiring-type-checking'].rules,
+    ...tsImportPlugin.configs.errors.rules,
+    ...tsImportPlugin.configs.warnings.rules,
+    ...tsImportPlugin.configs.typescript.rules,
+
+    'import/no-unresolved': 'error',
+    'import/extensions': ['error', 'ignorePackages', { ts: 'never' }],
+
+    '@typescript-eslint/await-thenable': 'warn',
+    '@typescript-eslint/brace-style': 'off',
+    /*
     '@typescript-eslint/comma-dangle': [
       2,
       {
@@ -66,6 +84,7 @@ module.exports = {
         tuples: 'always-multiline',
       },
     ],
+    */
     '@typescript-eslint/explicit-function-return-type': [
       'error',
       {
@@ -73,7 +92,7 @@ module.exports = {
       },
     ],
     '@typescript-eslint/explicit-member-accessibility': [
-      2,
+      'error',
       {
         accessibility: 'explicit',
         overrides: {
@@ -81,8 +100,8 @@ module.exports = {
         },
       },
     ],
-    '@typescript-eslint/explicit-module-boundary-types': 2,
-    '@typescript-eslint/indent': 0,
+    '@typescript-eslint/explicit-module-boundary-types': 'error',
+    '@typescript-eslint/indent': 'off',
     '@typescript-eslint/member-ordering': [
       'error',
       {
@@ -116,7 +135,7 @@ module.exports = {
       },
     ],
     '@typescript-eslint/naming-convention': [
-      2,
+      'error',
       {
         format: ['camelCase'],
         leadingUnderscore: 'forbid',
@@ -178,21 +197,10 @@ module.exports = {
         selector: 'enumMember',
         trailingUnderscore: 'forbid',
       },
-      // Правило, разрешающее написание "_id" с нижним подчеркиванием
-      {
-        filter: {
-          match: true,
-          regex: '^_id$',
-        },
-        format: null,
-        leadingUnderscore: 'allow',
-        selector: 'typeProperty',
-        trailingUnderscore: 'forbid',
-      },
     ],
-    '@typescript-eslint/no-base-to-string': 0,
+    '@typescript-eslint/no-base-to-string': 'off',
     '@typescript-eslint/no-empty-function': [
-      2,
+      'error',
       {
         allow: [
           'constructors',
@@ -201,13 +209,13 @@ module.exports = {
           'decoratedFunctions',
           'overrideMethods',
           'setters',
-        ]
-      }
+        ],
+      },
     ],
-    '@typescript-eslint/no-explicit-any': 2,
-    '@typescript-eslint/no-floating-promises': 0,
+    '@typescript-eslint/no-explicit-any': 'error',
+    '@typescript-eslint/no-floating-promises': 'off',
     '@typescript-eslint/no-magic-numbers': [
-      1,
+      'warn',
       {
         ignore: [-1, 0, 1],
         ignoreArrayIndexes: true,
@@ -217,15 +225,15 @@ module.exports = {
         ignoreReadonlyClassProperties: true,
       },
     ],
-    '@typescript-eslint/no-misused-promises': 0,
-    '@typescript-eslint/no-unsafe-argument': 0,
-    '@typescript-eslint/no-unsafe-assignment': 0,
-    '@typescript-eslint/no-unsafe-call': 0,
-    '@typescript-eslint/no-unsafe-member-access': 0,
-    '@typescript-eslint/no-unsafe-return': 0,
-    '@typescript-eslint/require-await': 1,
+    '@typescript-eslint/no-misused-promises': 'off',
+    '@typescript-eslint/no-unsafe-argument': 'off',
+    '@typescript-eslint/no-unsafe-assignment': 'off',
+    '@typescript-eslint/no-unsafe-call': 'off',
+    '@typescript-eslint/no-unsafe-member-access': 'off',
+    '@typescript-eslint/no-unsafe-return': 'off',
+    '@typescript-eslint/require-await': 'warn',
     '@typescript-eslint/restrict-template-expressions': [
-      2,
+      'error',
       {
         allowAny: true,
         allowBoolean: true,
@@ -233,25 +241,25 @@ module.exports = {
         allowNumber: true,
       },
     ],
-    '@typescript-eslint/return-await': [2, 'in-try-catch'],
-    'import/default': 2,
-    'import/export': 2,
-    'import/first': 2,
-    'import/named': 2,
-    'import/namespace': 2,
-    'import/newline-after-import': 2,
-    'import/no-cycle': 2,
+    '@typescript-eslint/return-await': ['error', 'in-try-catch'],
+    'import/default': 'error',
+    'import/export': 'error',
+    'import/first': 'error',
+    'import/named': 'error',
+    'import/namespace': 'error',
+    'import/newline-after-import': 'error',
+    'import/no-cycle': 'error',
     'import/no-extraneous-dependencies': [
-      2,
+      'error',
       {
         devDependencies: true,
       },
     ],
-    'import/order': 0,
-    'import/prefer-default-export': 0,
-    'max-classes-per-file': 0,
+    'import/order': 'off',
+    'import/prefer-default-export': 'off',
+    'max-classes-per-file': 'off',
     'simple-import-sort/imports': [
-      2,
+      'error',
       {
         groups: [
           // Side effect imports.
@@ -272,9 +280,9 @@ module.exports = {
         ],
       },
     ],
-    'sort-imports': 0,
-    'typescript-sort/interface': 2,
-    'typescript-sort/type': 2,
-    'typescript-sort/enum': 2,
+    'sort-imports': 'off',
+    'typescript-sort/interface': 'error',
+    'typescript-sort/type': 'error',
+    'typescript-sort/enum': 'error',
   },
-};
+});

package/eslint/node.js

@@ -1,28 +1,26 @@
-module.exports = {
-  env: {
-    browser: false,
-    es6: true,
-    jest: true,
-    'jest/globals': true,
-    node: true,
+const jestPlugin = require('eslint-plugin-jest');
+const prettierPlugin = require('eslint-plugin-prettier');
+const { isModuleInstalled } = require('./helpers');
+
+module.exports = ({ files } = {}) => ({
+  files: files || ['**/*.js', '**/*.ts'],
+  plugins: {
+    jest: jestPlugin,
+    prettier: prettierPlugin,
   },
-  extends: [
-    'eslint:recommended',
-    'plugin:jest/recommended',
-    'plugin:jest/style',
-    'prettier',
-    'plugin:prettier/recommended',
-  ],
-  plugins: ['jest'],
   rules: {
+    ...jestPlugin.configs.recommended.rules,
+    ...jestPlugin.configs.style.rules,
+    ...prettierPlugin.configs.recommended.rules,
+
     'arrow-parens': [
-      1,
+      'warn',
       'always',
       {
         requireForBlockBody: true,
       },
     ],
-    'class-methods-use-this': 0,
+    'class-methods-use-this': 'off',
     'comma-dangle': [
       'error',
       {
@@ -33,13 +31,14 @@ module.exports = {
         objects: 'always-multiline',
       },
     ],
-    complexity: [2, { max: 10 }],      
-    'function-paren-newline': 0,
-    'implicit-arrow-linebreak': 0,
-    'import/extensions': 0,
-    'import/no-unresolved': 0,
+    complexity: ['error', { max: 10 }],
+    'function-paren-newline': 'off',
+    'implicit-arrow-linebreak': 'off',
+    'import/extensions': 'off',
+    'import/no-unresolved': 'off',
+    'jest/no-deprecated-functions': isModuleInstalled('jest') ? 'error' : 'off',
     'max-lines': [
-      2,
+      'error',
       {
         max: 500,
         skipBlankLines: false,
@@ -47,27 +46,27 @@ module.exports = {
       },
     ],
     'max-lines-per-function': [
-      2,
+      'error',
       {
         max: 200,
         skipBlankLines: false,
         skipComments: true,
       },
     ],
-    'max-params': [2, { max: 3 }],
-    'no-await-in-loop': 0,
-    'no-continue': 0,
-    'no-empty-function': 0,
+    'max-params': ['error', { max: 3 }],
+    'no-await-in-loop': 'off',
+    'no-continue': 'off',
+    'no-empty-function': 'off',
     'no-plusplus': [
-      2,
+      'error',
       {
         allowForLoopAfterthoughts: true,
       },
     ],
-    'no-promise-executor-return': 0,
-    'no-restricted-syntax': 0,
+    'no-promise-executor-return': 'off',
+    'no-restricted-syntax': 'off',
     'padding-line-between-statements': [
-      2,
+      'error',
       {
         blankLine: 'always',
         next: '*',
@@ -84,8 +83,10 @@ module.exports = {
         prev: 'if',
       },
     ],
-    'require-await': 0,
-    'sort-imports': 2,
-    'sort-keys': 2,
+    'prettier/prettier': 'error',
+    'require-await': 'off',
+    'sort-imports': 'error',
+    'sort-keys': 'error',
+    strict: 'off',
   },
-};
+});

package/eslint/plugin-nestjs/api-response.js

@@ -0,0 +1,64 @@
+/* eslint-disable complexity */
+
+const controllerMethods = new Set(['Get', 'Post', 'Put', 'Delete', 'Patch']);
+const decoratorTypes = new Set(['ClassDeclaration', 'MethodDefinition']);
+
+module.exports = {
+  create(context) {
+    // собирает декораторы узла
+    function getNodeDecorators(node) {
+      return decoratorTypes.has(node.type) && node.decorators
+        ? node.decorators
+            .map(({ expression }) => expression.callee?.name)
+            .filter(Boolean)
+        : [];
+    }
+
+    // проверка на игнорирование метода
+    function ignoreControllerMethod(node) {
+      if (node.key.name === 'constructor') return true;
+
+      const methodDecorators = getNodeDecorators(node);
+      const parentDecorators = getNodeDecorators(node.parent.parent);
+
+      // игнорировать, если это не метод @ApiController
+      if (!parentDecorators.includes('ApiController')) return true;
+
+      // игнорировать, если есть декоратор @AnyResponse
+      if (methodDecorators.includes('AnyResponse')) return true;
+
+      // игнорировать, если нет декоратора роутинга
+      return !node.decorators?.some(({ expression }) =>
+        controllerMethods.has(expression.callee?.name),
+      );
+    }
+
+    // рекурсивный проход по описанию типа
+    function isApiResponseType(typeAnnotation, level = 0) {
+      if (level === 0 && typeAnnotation?.typeName?.name === 'Promise') {
+        const typeArgument = typeAnnotation.typeParameters?.params[0];
+
+        return isApiResponseType(typeArgument, level + 1);
+      }
+
+      if (typeAnnotation?.type === 'TSVoidKeyword') return true;
+
+      return (
+        typeAnnotation?.type === 'TSTypeReference' &&
+        typeAnnotation.typeName?.name === 'ApiResponse'
+      );
+    }
+
+    return {
+      MethodDefinition(node) {
+        if (ignoreControllerMethod(node)) return;
+
+        if (!isApiResponseType(node.value.returnType?.typeAnnotation)) {
+          const message = 'The return type must be "ApiResponse<T>" or "void"';
+
+          context.report({ message, node });
+        }
+      },
+    };
+  },
+};

package/eslint/plugin-nestjs/index.js

@@ -0,0 +1,5 @@
+module.exports = {
+  rules: {
+    'api-response': require('./api-response'),
+  },
+};

package/eslint.config.js

@@ -0,0 +1,6 @@
+const { defineConfig } = require('eslint/config');
+
+module.exports = defineConfig([
+  { ignores: ['**/node_modules/**'] },
+  require('./eslint/node')(),
+]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zalib/linter",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "Linter configs",
   "author": "https://github.com/wsp-repo/",
   "license": "UNLICENSED",
@@ -20,7 +20,9 @@
   },
   "scripts": {
     "build": "exit 0",
-    "lint": "exit 0",
+    "lint": "eslint --quiet",
+    "lint:fix": "eslint --quiet --fix",
+    "lint:warns": "eslint --max-warnings 0",
     "release:patch": "npm version patch",
     "release:minor": "npm version minor",
     "release:major": "npm version major",
@@ -30,17 +32,14 @@
     "@typescript-eslint/eslint-plugin": "8.32.1",
     "@typescript-eslint/parser": "8.32.1",
     "eslint": "9.27.0",
-    "eslint-config-base": "1.0.0",
     "eslint-config-prettier": "10.1.5",
-    "eslint-config-typescript": "3.0.0",
+    "eslint-import-resolver-typescript": "4.3.5",
     "eslint-plugin-import": "2.31.0",
     "eslint-plugin-jest": "28.11.0",
     "eslint-plugin-prettier": "5.4.0",
     "eslint-plugin-simple-import-sort": "12.1.1",
-    "jest": "29.7.0",
+    "eslint-plugin-typescript-sort": "0.1.11",
     "prettier": "3.5.3"
   },
-  "devDependencies": {
-    "typescript": "5.8.3"
-  }
+  "prettier": "./prettier"
 }

package/.eslintrc.js

@@ -1,9 +0,0 @@
-module.exports = {
-  overrides: [
-    {
-      extends: ['./eslint/node-js'],
-      files: ['*.js'],
-    },
-  ],
-  root: true,
-};

package/eslint/node-js.js

@@ -1,23 +0,0 @@
-const nodeBaseConfig = require('./node');
-
-module.exports = {
-  env: {
-    ...nodeBaseConfig.env,
-  },
-  extends: [
-    ...nodeBaseConfig.extends,
-    'eslint:recommended',
-    'plugin:jest/recommended',
-    'plugin:jest/style',
-    'prettier',
-    'plugin:prettier/recommended'
-  ],
-  files: ['*.js'],
-  plugins: [
-    ...nodeBaseConfig.plugins,
-  ],
-  rules: {
-    ...nodeBaseConfig.rules,
-    strict: 0,
-  },
-};

package/prettier.config.js

@@ -1 +0,0 @@
-module.exports = require('./prettier');