@taiga-ui/eslint-plugin-experience-next 0.255.0 → 0.256.0

package/eslint.config.cjs.js

@@ -14,6 +14,7 @@ var unicorn = require('eslint-plugin-unicorn');
 var unusedImports = require('eslint-plugin-unused-imports');
 var globals = require('globals');
 var tseslint = require('typescript-eslint');
+var path = require('node:path');
 
 function getDefaultExportFromCjs (x) {
 	return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, 'default') ? x['default'] : x;
@@ -348,6 +349,118 @@ var src = {
 
 var eslint = /*@__PURE__*/getDefaultExportFromCjs(src);
 
+const MESSAGE_ID = 'no-deep-imports';
+const ERROR_MESSAGE = 'Deep imports of Taiga UI packages are prohibited';
+const DEFAULT_OPTIONS = {
+  currentProject: '',
+  deepImport: String.raw`(?<=^@taiga-ui/[\w-]+)(/.+)$`,
+  ignoreImports: [],
+  importDeclaration: '^@taiga-ui*',
+  projectName: String.raw`(?<=^@taiga-ui/)([-\w]+)`
+};
+const config = {
+  create(context) {
+    const {
+      currentProject,
+      deepImport,
+      ignoreImports,
+      importDeclaration,
+      projectName
+    } = {
+      ...DEFAULT_OPTIONS,
+      ...(context.options[0] || {})
+    };
+    const isDeepImport = source => !!source.match(new RegExp(deepImport, 'g'))?.length;
+    const isInsideTheSameEntryPoint = source => {
+      const filePath = path.relative(context.getCwd(), context.getFilename()).replaceAll(/\\+/g, '/');
+      const [currentFileProjectName] = currentProject && new RegExp(currentProject, 'g').exec(filePath) || [];
+      const [importSourceProjectName] = source.match(new RegExp(projectName, 'g')) || [];
+      return Boolean(currentFileProjectName && importSourceProjectName && currentFileProjectName === importSourceProjectName);
+    };
+    const shouldIgnore = source => ignoreImports.some(p => source.match(new RegExp(p, 'g')));
+    return {
+      [`ImportDeclaration[source.value=/${importDeclaration}/]`]({
+        source: sourceNode
+      }) {
+        const importSource = sourceNode?.value || '';
+        if (!isDeepImport(importSource) || isInsideTheSameEntryPoint(importSource) || shouldIgnore(importSource)) {
+          return;
+        }
+        context.report({
+          fix: fixer => {
+            const [start, end] = sourceNode.range;
+            return fixer.replaceTextRange([start + 1, end - 1],
+            //  keeps quotes
+            importSource.replaceAll(new RegExp(deepImport, 'g'), ''));
+          },
+          messageId: MESSAGE_ID,
+          node: sourceNode
+        });
+      }
+    };
+  },
+  meta: {
+    docs: {
+      description: ERROR_MESSAGE
+    },
+    fixable: 'code',
+    messages: {
+      [MESSAGE_ID]: ERROR_MESSAGE
+    },
+    schema: [{
+      additionalProperties: false,
+      properties: {
+        currentProject: {
+          description: 'RegExp string to pick out current project name of processed file',
+          type: 'string'
+        },
+        deepImport: {
+          description: 'RegExp string to pick out deep import part',
+          type: 'string'
+        },
+        ignoreImports: {
+          description: 'RegExp string to exclude import declarations which is selected by importDeclaration-option',
+          items: {
+            type: 'string'
+          },
+          type: 'array'
+        },
+        importDeclaration: {
+          description: 'RegExp string to detect import declarations for which this rule should be applied',
+          type: 'string'
+        }
+      },
+      type: 'object'
+    }],
+    type: 'problem'
+  }
+};
+
+const plugin = {
+  configs: {},
+  meta: {
+    name: '@taiga-ui/experience'
+  },
+  rules: {
+    'no-deep-imports': config
+  }
+};
+// https://eslint.org/docs/latest/extend/plugins
+// assign configs here so we can reference `plugin`
+Object.assign(plugin.configs, {
+  recommended: [{
+    plugins: {
+      '@taiga-ui/experience': plugin
+    },
+    rules: {
+      '@taiga-ui/experience/no-deep-imports': ['error', {
+        currentProject: String.raw`(?<=projects/)([-\w]+)`,
+        ignoreImports: [String.raw`\?raw`, '@taiga-ui/testing/cypress', '@taiga-ui/testing/setup-jest']
+      }]
+    }
+  }]
+});
+
 let angularVersion = 16;
 const tsconfig = projectJsonExist('tsconfig.eslint.json') || projectJsonExist('tsconfig.json');
 const parserOptions = tsconfig ? {
@@ -366,11 +479,12 @@ try {
 } catch {}
 var eslint_config = tseslint.config(progress.configs['recommended-ci'], require('eslint-plugin-de-morgan').configs.recommended, require('eslint-plugin-import').flatConfigs.recommended, require('eslint-plugin-import').flatConfigs.typescript, require('eslint-plugin-promise').configs['flat/recommended'], {
   ignores: ['*/icons/all.ts', '**/tests-report/**', '**/snapshots/**', '**/test-results/**', '**/.nx/**', '404.html', '*.jpg', '*.svg', '*.less', '*.scss', '*.txt', '*.png', '*.jpg', '*.webmanifest', '*.pdf', '*.mp3', '*.ogv', '*.mp4', '*.ico', '*.xml', '*.md', 'LICENSE', 'jest.preset.js', '*.config.js', 'node_modules', 'dist', '**/node_modules/**', '**/*@dasherize__/**', '**/coverage/**', 'eslintrc.js', '.eslintrc.js', '**/*.d.ts', '**/dist/**', '**/docs/**', '**/bin/**', '.cache/**', '.git/**', '.idea/**']
-}, eslint.configs.recommended, tseslint.configs.recommended, require('eslint-config-prettier'), {
+}, eslint.configs.recommended, plugin.configs.recommended, tseslint.configs.recommended, require('eslint-config-prettier'), {
   files: ['**/*.ts', '**/*.js'],
   plugins: {
     '@stylistic': stylistic,
     '@stylistic/ts': stylisticTs,
+    '@taiga-ui/experience': plugin,
     'decorator-position': require('eslint-plugin-decorator-position'),
     perfectionist: require('eslint-plugin-perfectionist'),
     prettier,

package/eslint.config.esm.js

@@ -12,6 +12,7 @@ import unicorn from 'eslint-plugin-unicorn';
 import unusedImports from 'eslint-plugin-unused-imports';
 import globals from 'globals';
 import tseslint from 'typescript-eslint';
+import path from 'node:path';
 
 function getDefaultExportFromCjs (x) {
 	return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, 'default') ? x['default'] : x;
@@ -346,6 +347,118 @@ var src = {
 
 var eslint = /*@__PURE__*/getDefaultExportFromCjs(src);
 
+const MESSAGE_ID = 'no-deep-imports';
+const ERROR_MESSAGE = 'Deep imports of Taiga UI packages are prohibited';
+const DEFAULT_OPTIONS = {
+  currentProject: '',
+  deepImport: String.raw`(?<=^@taiga-ui/[\w-]+)(/.+)$`,
+  ignoreImports: [],
+  importDeclaration: '^@taiga-ui*',
+  projectName: String.raw`(?<=^@taiga-ui/)([-\w]+)`
+};
+const config = {
+  create(context) {
+    const {
+      currentProject,
+      deepImport,
+      ignoreImports,
+      importDeclaration,
+      projectName
+    } = {
+      ...DEFAULT_OPTIONS,
+      ...(context.options[0] || {})
+    };
+    const isDeepImport = source => !!source.match(new RegExp(deepImport, 'g'))?.length;
+    const isInsideTheSameEntryPoint = source => {
+      const filePath = path.relative(context.getCwd(), context.getFilename()).replaceAll(/\\+/g, '/');
+      const [currentFileProjectName] = currentProject && new RegExp(currentProject, 'g').exec(filePath) || [];
+      const [importSourceProjectName] = source.match(new RegExp(projectName, 'g')) || [];
+      return Boolean(currentFileProjectName && importSourceProjectName && currentFileProjectName === importSourceProjectName);
+    };
+    const shouldIgnore = source => ignoreImports.some(p => source.match(new RegExp(p, 'g')));
+    return {
+      [`ImportDeclaration[source.value=/${importDeclaration}/]`]({
+        source: sourceNode
+      }) {
+        const importSource = sourceNode?.value || '';
+        if (!isDeepImport(importSource) || isInsideTheSameEntryPoint(importSource) || shouldIgnore(importSource)) {
+          return;
+        }
+        context.report({
+          fix: fixer => {
+            const [start, end] = sourceNode.range;
+            return fixer.replaceTextRange([start + 1, end - 1],
+            //  keeps quotes
+            importSource.replaceAll(new RegExp(deepImport, 'g'), ''));
+          },
+          messageId: MESSAGE_ID,
+          node: sourceNode
+        });
+      }
+    };
+  },
+  meta: {
+    docs: {
+      description: ERROR_MESSAGE
+    },
+    fixable: 'code',
+    messages: {
+      [MESSAGE_ID]: ERROR_MESSAGE
+    },
+    schema: [{
+      additionalProperties: false,
+      properties: {
+        currentProject: {
+          description: 'RegExp string to pick out current project name of processed file',
+          type: 'string'
+        },
+        deepImport: {
+          description: 'RegExp string to pick out deep import part',
+          type: 'string'
+        },
+        ignoreImports: {
+          description: 'RegExp string to exclude import declarations which is selected by importDeclaration-option',
+          items: {
+            type: 'string'
+          },
+          type: 'array'
+        },
+        importDeclaration: {
+          description: 'RegExp string to detect import declarations for which this rule should be applied',
+          type: 'string'
+        }
+      },
+      type: 'object'
+    }],
+    type: 'problem'
+  }
+};
+
+const plugin = {
+  configs: {},
+  meta: {
+    name: '@taiga-ui/experience'
+  },
+  rules: {
+    'no-deep-imports': config
+  }
+};
+// https://eslint.org/docs/latest/extend/plugins
+// assign configs here so we can reference `plugin`
+Object.assign(plugin.configs, {
+  recommended: [{
+    plugins: {
+      '@taiga-ui/experience': plugin
+    },
+    rules: {
+      '@taiga-ui/experience/no-deep-imports': ['error', {
+        currentProject: String.raw`(?<=projects/)([-\w]+)`,
+        ignoreImports: [String.raw`\?raw`, '@taiga-ui/testing/cypress', '@taiga-ui/testing/setup-jest']
+      }]
+    }
+  }]
+});
+
 let angularVersion = 16;
 const tsconfig = projectJsonExist('tsconfig.eslint.json') || projectJsonExist('tsconfig.json');
 const parserOptions = tsconfig ? {
@@ -364,11 +477,12 @@ try {
 } catch {}
 var eslint_config = tseslint.config(progress.configs['recommended-ci'], require('eslint-plugin-de-morgan').configs.recommended, require('eslint-plugin-import').flatConfigs.recommended, require('eslint-plugin-import').flatConfigs.typescript, require('eslint-plugin-promise').configs['flat/recommended'], {
   ignores: ['*/icons/all.ts', '**/tests-report/**', '**/snapshots/**', '**/test-results/**', '**/.nx/**', '404.html', '*.jpg', '*.svg', '*.less', '*.scss', '*.txt', '*.png', '*.jpg', '*.webmanifest', '*.pdf', '*.mp3', '*.ogv', '*.mp4', '*.ico', '*.xml', '*.md', 'LICENSE', 'jest.preset.js', '*.config.js', 'node_modules', 'dist', '**/node_modules/**', '**/*@dasherize__/**', '**/coverage/**', 'eslintrc.js', '.eslintrc.js', '**/*.d.ts', '**/dist/**', '**/docs/**', '**/bin/**', '.cache/**', '.git/**', '.idea/**']
-}, eslint.configs.recommended, tseslint.configs.recommended, require('eslint-config-prettier'), {
+}, eslint.configs.recommended, plugin.configs.recommended, tseslint.configs.recommended, require('eslint-config-prettier'), {
   files: ['**/*.ts', '**/*.js'],
   plugins: {
     '@stylistic': stylistic,
     '@stylistic/ts': stylisticTs,
+    '@taiga-ui/experience': plugin,
     'decorator-position': require('eslint-plugin-decorator-position'),
     perfectionist: require('eslint-plugin-perfectionist'),
     prettier,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@taiga-ui/eslint-plugin-experience-next",
-  "version": "0.255.0",
+  "version": "0.256.0",
   "description": "An ESLint plugin to enforce a consistent code styles across taiga-ui projects",
   "license": "Apache-2.0",
   "main": "./eslint.config.cjs.js",
@@ -9,7 +9,7 @@
     "@smarttools/eslint-plugin-rxjs": ">=1.0.18",
     "@stylistic/eslint-plugin": ">=4.0.1",
     "@stylistic/eslint-plugin-ts": ">=4.0.1",
-    "@typescript-eslint/eslint-plugin": ">=8.24.1",
+    "@typescript-eslint/eslint-plugin": ">=8.25.0",
     "angular-eslint": ">=19.1.0",
     "eslint": ">=9.21.0",
     "eslint-config-prettier": ">=10.0.1",
@@ -27,7 +27,7 @@
     "eslint-plugin-unicorn": ">=57.0.0",
     "eslint-plugin-unused-imports": ">=4.1.4",
     "globals": ">=16.0.0",
-    "typescript-eslint": ">=8.24.1"
+    "typescript-eslint": ">=8.25.0"
   },
   "publishConfig": {
     "access": "public"

package/plugin/index.d.ts

@@ -0,0 +1,15 @@
+import type { Linter } from 'eslint';
+declare const plugin: {
+    configs: {
+        readonly recommended: {
+            readonly rules: Readonly<Linter.RulesRecord>;
+        };
+    };
+    meta: {
+        name: string;
+    };
+    rules: {
+        'no-deep-imports': import("eslint").Rule.RuleModule;
+    };
+};
+export default plugin;

package/plugin/no-deep-imports.d.ts

@@ -0,0 +1,3 @@
+import type { Rule } from 'eslint';
+declare const config: Rule.RuleModule;
+export default config;