eslint-plugin-big-react-app-plugin 0.1.8 → 0.2.0

package/.history/tests/lib/rules/public-api-imports_20251030073107.js

@@ -0,0 +1,96 @@
+/**
+ * @fileoverview public API path checker
+ * @author vasilii
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const rule = require("../../../lib/rules/public-api-imports"),
+  RuleTester = require("eslint").RuleTester;
+
+
+//------------------------------------------------------------------------------
+// Tests
+//------------------------------------------------------------------------------
+
+const ruleTester = new RuleTester({
+  parserOptions: {ecmaVersion: 6, sourceType: 'module'}
+});
+
+const aliasOptions = [
+  {
+    alias: '@'
+  }
+]
+
+ruleTester.run("public-api-imports", rule, {
+  valid: [
+   {
+      code: "import { addCommentFormActions, addCommentFormReducer } from '../../model/slices/addCommentFormSlice'",
+      errors: [],
+    },
+    {
+      filename: 'C:\Users\ADMIN\Documents\GitHub\ulbi\big-react-app\src\shared\config\storybook\StoreDecorator\StoreDecorator.tsx',
+      code: "import { loginReducer } from '@/features/AuthByUsername/testing'",
+      errors: [],
+      options: [{
+        alias: '@',
+        testFilesPatterns: ['**/*.test.ts', '**/*.test.ts', '**/StoreDecorator.tsx']
+      }],
+    },
+    {
+      code: "import { addCommentFormActions, addCommentFormReducer } from '@/entities/Article'",
+      errors: [],
+      options: aliasOptions,
+    },
+    {
+      filename: 'C:\\Users\\tim\\Desktop\\javascript\\production_project\\src\\entities\\file.test.ts',
+      code: "import { addCommentFormActions, addCommentFormReducer } from '@/entities/Article/testing'",
+      errors: [],
+      options: [{
+        alias: '@',
+        testFilesPatterns: ['**/*.test.ts', '**/*.test.ts', '**/StoreDecorator.tsx']
+      }],
+    },
+    {
+      filename: 'C:\\Users\\tim\\Desktop\\javascript\\production_project\\src\\entities\\StoreDecorator.tsx',
+      code: "import { addCommentFormActions, addCommentFormReducer } from '@/entities/Article/testing'",
+      errors: [],
+      options: [{
+        alias: '@',
+        testFilesPatterns: ['**/*.test.ts', '**/*.test.ts', '**/StoreDecorator.tsx']
+      }],
+    }
+  ],
+
+  invalid: [
+     {
+      code: "import { addCommentFormActions, addCommentFormReducer } from '@/entities/Article/model/file.ts'",
+      errors: [{ message: "Абсолютный импорт разрешен только из Public API (index.ts)"}],
+      options: aliasOptions,
+    },
+    {
+      filename: 'C:\\Users\\tim\\Desktop\\javascript\\production_project\\src\\entities\\StoreDecorator.tsx',
+      code: "import { addCommentFormActions, addCommentFormReducer } from '@/entities/Article/testing/file.tsx'",
+      errors: [{message: 'Абсолютный импорт разрешен только из Public API (index.ts)'}],
+      options: [{
+        alias: '@',
+        testFilesPatterns: ['**/*.test.ts', '**/*.test.ts', '**/StoreDecorator.tsx']
+      }],
+    },
+    {
+      filename: 'C:\\Users\\tim\\Desktop\\javascript\\production_project\\src\\entities\\forbidden.ts',
+      code: "import { addCommentFormActions, addCommentFormReducer } from '@/entities/Article/testing'",
+      errors: [{message: 'Тестовые данные необходимо импортировать из publicApi/testing.ts'}],
+      options: [{
+        alias: '@',
+        testFilesPatterns: ['**/*.test.ts', '**/*.test.ts', '**/StoreDecorator.tsx']
+      }],
+    }
+    
+  ],
+});
+

package/.history/tests/lib/rules/public-api-imports_20251030073112.js

@@ -0,0 +1,96 @@
+/**
+ * @fileoverview public API path checker
+ * @author vasilii
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const rule = require("../../../lib/rules/public-api-imports"),
+  RuleTester = require("eslint").RuleTester;
+
+
+//------------------------------------------------------------------------------
+// Tests
+//------------------------------------------------------------------------------
+
+const ruleTester = new RuleTester({
+  parserOptions: {ecmaVersion: 6, sourceType: 'module'}
+});
+
+const aliasOptions = [
+  {
+    alias: '@'
+  }
+]
+
+ruleTester.run("public-api-imports", rule, {
+  valid: [
+   {
+      code: "import { addCommentFormActions, addCommentFormReducer } from '../../model/slices/addCommentFormSlice'",
+      errors: [],
+    },
+    {
+      filename: 'D:\\KonovalovVasiliy\\GitHub\\ulbi\\big-react-app\\src\\shared\\config\\storybook\\StoreDecorator\\StoreDecorator.tsx',
+      code: "import { loginReducer } from '@/features/AuthByUsername/testing'",
+      errors: [],
+      options: [{
+        alias: '@',
+        testFilesPatterns: ['**/*.test.ts', '**/*.test.ts', '**/StoreDecorator.tsx']
+      }],
+    },
+    {
+      code: "import { addCommentFormActions, addCommentFormReducer } from '@/entities/Article'",
+      errors: [],
+      options: aliasOptions,
+    },
+    {
+      filename: 'C:\\Users\\tim\\Desktop\\javascript\\production_project\\src\\entities\\file.test.ts',
+      code: "import { addCommentFormActions, addCommentFormReducer } from '@/entities/Article/testing'",
+      errors: [],
+      options: [{
+        alias: '@',
+        testFilesPatterns: ['**/*.test.ts', '**/*.test.ts', '**/StoreDecorator.tsx']
+      }],
+    },
+    {
+      filename: 'C:\\Users\\tim\\Desktop\\javascript\\production_project\\src\\entities\\StoreDecorator.tsx',
+      code: "import { addCommentFormActions, addCommentFormReducer } from '@/entities/Article/testing'",
+      errors: [],
+      options: [{
+        alias: '@',
+        testFilesPatterns: ['**/*.test.ts', '**/*.test.ts', '**/StoreDecorator.tsx']
+      }],
+    }
+  ],
+
+  invalid: [
+     {
+      code: "import { addCommentFormActions, addCommentFormReducer } from '@/entities/Article/model/file.ts'",
+      errors: [{ message: "Абсолютный импорт разрешен только из Public API (index.ts)"}],
+      options: aliasOptions,
+    },
+    {
+      filename: 'C:\\Users\\tim\\Desktop\\javascript\\production_project\\src\\entities\\StoreDecorator.tsx',
+      code: "import { addCommentFormActions, addCommentFormReducer } from '@/entities/Article/testing/file.tsx'",
+      errors: [{message: 'Абсолютный импорт разрешен только из Public API (index.ts)'}],
+      options: [{
+        alias: '@',
+        testFilesPatterns: ['**/*.test.ts', '**/*.test.ts', '**/StoreDecorator.tsx']
+      }],
+    },
+    {
+      filename: 'C:\\Users\\tim\\Desktop\\javascript\\production_project\\src\\entities\\forbidden.ts',
+      code: "import { addCommentFormActions, addCommentFormReducer } from '@/entities/Article/testing'",
+      errors: [{message: 'Тестовые данные необходимо импортировать из publicApi/testing.ts'}],
+      options: [{
+        alias: '@',
+        testFilesPatterns: ['**/*.test.ts', '**/*.test.ts', '**/StoreDecorator.tsx']
+      }],
+    }
+    
+  ],
+});
+

package/.history/tests/lib/rules/public-api-imports_20251101143401.js

@@ -0,0 +1,95 @@
+/**
+ * @fileoverview public API path checker
+ * @author vasilii
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const rule = require("../../../lib/rules/public-api-imports"),
+  RuleTester = require("eslint").RuleTester;
+
+
+//------------------------------------------------------------------------------
+// Tests
+//------------------------------------------------------------------------------
+
+const ruleTester = new RuleTester({
+  parserOptions: {ecmaVersion: 6, sourceType: 'module'}
+});
+
+const aliasOptions = [
+  {
+    alias: '@'
+  }
+]
+
+ruleTester.run("public-api-imports", rule, {
+  valid: [
+   {
+      code: "import { addCommentFormActions, addCommentFormReducer } from '../../model/slices/addCommentFormSlice'",
+      errors: [],
+    },
+    {
+      filename: 'D:\\KonovalovVasiliy\\GitHub\\ulbi\\big-react-app\\src\\shared\\config\\storybook\\StoreDecorator\\StoreDecorator.tsx',
+      code: "import { loginReducer } from '@/features/AuthByUsername/testing'",
+      errors: [],
+      options: [{
+        alias: '@',
+        testFilesPatterns: ['**/*.test.ts', '**/*.test.ts', '**/StoreDecorator.tsx']
+      }],
+    },
+    {
+      code: "import { addCommentFormActions, addCommentFormReducer } from '@/entities/Article'",
+      errors: [],
+      options: aliasOptions,
+    },
+    {
+      filename: 'C:\\Users\\tim\\Desktop\\javascript\\production_project\\src\\entities\\file.test.ts',
+      code: "import { addCommentFormActions, addCommentFormReducer } from '@/entities/Article/testing'",
+      errors: [],
+      options: [{
+        alias: '@',
+        testFilesPatterns: ['**/*.test.ts', '**/*.test.ts', '**/StoreDecorator.tsx']
+      }],
+    },
+    {
+      filename: 'C:\\Users\\tim\\Desktop\\javascript\\production_project\\src\\entities\\StoreDecorator.tsx',
+      code: "import { addCommentFormActions, addCommentFormReducer } from '@/entities/Article/testing'",
+      errors: [],
+      options: [{
+        alias: '@',
+        testFilesPatterns: ['**/*.test.ts', '**/*.test.ts', '**/StoreDecorator.tsx']
+      }],
+    }
+  ],
+
+  invalid: [
+     {
+      code: "import { addCommentFormActions, addCommentFormReducer } from '@/entities/Article/model/file.ts'",
+      errors: [{ message: "Абсолютный импорт разрешен только из Public API (index.ts)"}],
+      options: aliasOptions,
+    },
+    {
+      filename: 'C:\\Users\\tim\\Desktop\\javascript\\production_project\\src\\entities\\StoreDecorator.tsx',
+      code: "import { addCommentFormActions, addCommentFormReducer } from '@/entities/Article/testing/file.tsx'",
+      errors: [{message: 'Абсолютный импорт разрешен только из Public API (index.ts)'}],
+      options: [{
+        alias: '@',
+        testFilesPatterns: ['**/*.test.ts', '**/*.test.ts', '**/StoreDecorator.tsx']
+      }],
+    },
+    {
+      filename: 'C:\\Users\\tim\\Desktop\\javascript\\production_project\\src\\entities\\forbidden.ts',
+      code: "import { addCommentFormActions, addCommentFormReducer } from '@/entities/Article/testing'",
+      errors: [{message: 'Тестовые данные необходимо импортировать из publicApi/testing.ts'}],
+      options: [{
+        alias: '@',
+        testFilesPatterns: ['**/*.test.ts', '**/*.test.ts', '**/StoreDecorator.tsx']
+      }],
+    }
+    ],
+});
+

package/.history/tests/lib/rules/public-api-imports_20251101143431.js

@@ -0,0 +1,95 @@
+/**
+ * @fileoverview public API path checker
+ * @author vasilii
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const rule = require("../../../lib/rules/public-api-imports"),
+  RuleTester = require("eslint").RuleTester;
+
+
+//------------------------------------------------------------------------------
+// Tests
+//------------------------------------------------------------------------------
+
+const ruleTester = new RuleTester({
+  parserOptions: {ecmaVersion: 6, sourceType: 'module'}
+});
+
+const aliasOptions = [
+  {
+    alias: '@'
+  }
+]
+
+ruleTester.run("public-api-imports", rule, {
+  valid: [
+   {
+      code: "import { addCommentFormActions, addCommentFormReducer } from '../../model/slices/addCommentFormSlice'",
+      errors: [],
+    },
+    {
+      filename: 'D:\\KonovalovVasiliy\\GitHub\\ulbi\\big-react-app\\src\\shared\\config\\storybook\\StoreDecorator\\StoreDecorator.tsx',
+      code: "import { loginReducer } from '@/features/AuthByUsername/testing'",
+      errors: [],
+      options: [{
+        alias: '@',
+        testFilesPatterns: ['**/*.test.ts', '**/*.test.ts', '**/StoreDecorator.tsx']
+      }],
+    },
+    {
+      code: "import { addCommentFormActions, addCommentFormReducer } from '@/entities/Article'",
+      errors: [],
+      options: aliasOptions,
+    },
+    {
+      filename: 'C:\\Users\\tim\\Desktop\\javascript\\production_project\\src\\entities\\file.test.ts',
+      code: "import { addCommentFormActions, addCommentFormReducer } from '@/entities/Article/testing'",
+      errors: [],
+      options: [{
+        alias: '@',
+        testFilesPatterns: ['**/*.test.ts', '**/*.test.ts', '**/StoreDecorator.tsx']
+      }],
+    },
+    {
+      filename: 'C:\\Users\\tim\\Desktop\\javascript\\production_project\\src\\entities\\StoreDecorator.tsx',
+      code: "import { addCommentFormActions, addCommentFormReducer } from '@/entities/Article/testing'",
+      errors: [],
+      options: [{
+        alias: '@',
+        testFilesPatterns: ['**/*.test.ts', '**/*.test.ts', '**/StoreDecorator.tsx']
+      }],
+    }
+  ],
+
+  invalid: [
+     {
+      code: "import { addCommentFormActions, addCommentFormReducer } from '@/entities/Article/model/file.ts'",
+      errors: [{ message: "Абсолютный импорт разрешен только из Public API (index.ts)"}],
+      options: aliasOptions,
+    },
+    {
+      filename: 'C:\\Users\\tim\\Desktop\\javascript\\production_project\\src\\entities\\StoreDecorator.tsx',
+      code: "import { addCommentFormActions, addCommentFormReducer } from '@/entities/Article/testing/file.tsx'",
+      errors: [{message: 'Абсолютный импорт разрешен только из Public API (index.ts)'}],
+      options: [{
+        alias: '@',
+        testFilesPatterns: ['**/*.test.ts', '**/*.test.ts', '**/StoreDecorator.tsx']
+      }],
+    },
+    {
+      filename: 'C:\\Users\\tim\\Desktop\\javascript\\production_project\\src\\entities\\forbidden.ts',
+      code: "import { addCommentFormActions, addCommentFormReducer } from '@/entities/Article/testing'",
+      errors: [{message: 'Тестовые данные необходимо импортировать из publicApi/testing.ts'}],
+      options: [{
+        alias: '@',
+        testFilesPatterns: ['**/*.test.ts', '**/*.test.ts', '**/StoreDecorator.tsx']
+      }],
+    }
+    ],
+});
+

package/.history/tests/lib/rules/public-api-imports_20251101143526.js

@@ -0,0 +1,87 @@
+/**
+ * @fileoverview public API path checker
+ * @author vasilii
+ */
+"use strict";
+
+const rule = require("../../../lib/rules/public-api-imports"),
+  RuleTester = require("eslint").RuleTester;
+
+
+const ruleTester = new RuleTester({
+  parserOptions: {ecmaVersion: 6, sourceType: 'module'}
+});
+
+const aliasOptions = [
+  {
+    alias: '@'
+  }
+]
+
+ruleTester.run("public-api-imports", rule, {
+  valid: [
+   {
+      code: "import { addCommentFormActions, addCommentFormReducer } from '../../model/slices/addCommentFormSlice'",
+      errors: [],
+    },
+    {
+      filename: 'D:\\KonovalovVasiliy\\GitHub\\ulbi\\big-react-app\\src\\shared\\config\\storybook\\StoreDecorator\\StoreDecorator.tsx',
+      code: "import { loginReducer } from '@/features/AuthByUsername/testing'",
+      errors: [],
+      options: [{
+        alias: '@',
+        testFilesPatterns: ['**/*.test.ts', '**/*.test.ts', '**/StoreDecorator.tsx']
+      }],
+    },
+    {
+      code: "import { addCommentFormActions, addCommentFormReducer } from '@/entities/Article'",
+      errors: [],
+      options: aliasOptions,
+    },
+    {
+      filename: 'C:\\Users\\tim\\Desktop\\javascript\\production_project\\src\\entities\\file.test.ts',
+      code: "import { addCommentFormActions, addCommentFormReducer } from '@/entities/Article/testing'",
+      errors: [],
+      options: [{
+        alias: '@',
+        testFilesPatterns: ['**/*.test.ts', '**/*.test.ts', '**/StoreDecorator.tsx']
+      }],
+    },
+    {
+      filename: 'C:\\Users\\tim\\Desktop\\javascript\\production_project\\src\\entities\\StoreDecorator.tsx',
+      code: "import { addCommentFormActions, addCommentFormReducer } from '@/entities/Article/testing'",
+      errors: [],
+      options: [{
+        alias: '@',
+        testFilesPatterns: ['**/*.test.ts', '**/*.test.ts', '**/StoreDecorator.tsx']
+      }],
+    }
+  ],
+
+  invalid: [
+     {
+      code: "import { addCommentFormActions, addCommentFormReducer } from '@/entities/Article/model/file.ts'",
+      errors: [{ message: "Абсолютный импорт разрешен только из Public API (index.ts)"}],
+      options: aliasOptions,
+    },
+    {
+      filename: 'C:\\Users\\tim\\Desktop\\javascript\\production_project\\src\\entities\\StoreDecorator.tsx',
+      code: "import { addCommentFormActions, addCommentFormReducer } from '@/entities/Article/testing/file.tsx'",
+      errors: [{message: 'Абсолютный импорт разрешен только из Public API (index.ts)'}],
+      options: [{
+        alias: '@',
+        testFilesPatterns: ['**/*.test.ts', '**/*.test.ts', '**/StoreDecorator.tsx']
+      }],
+    },
+    {
+      filename: 'C:\\Users\\tim\\Desktop\\javascript\\production_project\\src\\entities\\forbidden.ts',
+      code: "import { addCommentFormActions, addCommentFormReducer } from '@/entities/Article/testing'",
+      errors: [{message: 'Тестовые данные необходимо импортировать из publicApi/testing.ts'}],
+      options: [{
+        alias: '@',
+        testFilesPatterns: ['**/*.test.ts', '**/*.test.ts', '**/StoreDecorator.tsx']
+      }],
+    }
+    ],
+});
+

package/docs/rules/layer-imports.md

@@ -0,0 +1,35 @@
+# The rule ensures that the layers above are not used in the layers below. (layer-imports)
+
+Please describe the origin of the rule here.
+
+## Rule Details
+
+This rule aims to...
+
+Examples of **incorrect** code for this rule:
+
+```js
+
+// fill me in
+
+```
+
+Examples of **correct** code for this rule:
+
+```js
+
+// fill me in
+
+```
+
+### Options
+
+If there are any options, describe them here. Otherwise, delete this section.
+
+## When Not To Use It
+
+Give a short description of when it would be appropriate to turn off this rule.
+
+## Further Reading
+
+If there are other links that describe the issue this rule addresses, please include them here in a bulleted list.

package/lib/rules/layer-imports.js

@@ -0,0 +1,110 @@
+/**
+ * @fileoverview The rule ensures that the layers above are not used in the layers below.
+ * @author vasilii
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
+
+const path = require('path');
+const {isPathRelative} = require('../helpers');
+const micromatch = require('micromatch');
+module.exports = {
+  meta: {
+    type: null, // `problem`, `suggestion`, or `layout`
+    docs: {
+      description: "saf",
+      category: "Fill me in",
+      recommended: false,
+      url: null, // URL to the documentation page for this rule
+    },
+    fixable: null, // Or `code` or `whitespace`
+    schema: [
+      {
+        type: 'object',
+        properties: {
+          alias: {
+            type: 'string',
+          },
+          ignoreImportPatterns: {
+            type: 'array',
+          }
+        },
+      }
+    ],
+  },
+
+  create(context) {
+    const layers = {
+      'app': ['pages', 'widgets', 'features', 'shared', 'entities'],
+      'pages': ['widgets', 'features', 'shared', 'entities'],
+      'widgets': ['features', 'shared', 'entities'],
+      'features': ['shared', 'entities'],
+      'entities': ['shared', 'entities'],
+      'shared': ['shared'],
+    }
+
+    const availableLayers = {
+      'app': 'app',
+      'entities': 'entities',
+      'features': 'features',
+      'shared': 'shared',
+      'pages': 'pages',
+      'widgets': 'widgets',
+    }
+
+
+    const {alias = '', ignoreImportPatterns = []} = context.options[0] ?? {};
+
+    const getCurrentFileLayer = () => {
+      const currentFilePath = context.getFilename();
+
+      const normalizedPath = path.toNamespacedPath(currentFilePath);
+      const projectPath = normalizedPath?.split('src')[1];
+      const segments = projectPath?.split('\\')
+
+      return segments?.[1];
+    }
+
+    const getImportLayer = (value) => {
+      const importPath = alias ? value.replace(`${alias}/`, '') : value;
+      const segments = importPath?.split('/')
+
+      return segments?.[0]
+    }
+
+    return {
+      ImportDeclaration(node) {
+        const importPath = node.source.value
+        const currentFileLayer = getCurrentFileLayer()
+        const importLayer = getImportLayer(importPath)
+
+        if(isPathRelative(importPath)) {
+          return;
+        }
+
+        if(!availableLayers[importLayer] || !availableLayers[currentFileLayer]) {
+          return;
+        }
+
+        const isIgnored = ignoreImportPatterns.some(pattern => {
+          return micromatch.isMatch(importPath, pattern)
+        });
+
+        if(isIgnored) {
+          return;
+        }
+
+        if(!layers[currentFileLayer]?.includes(importLayer)) {
+          context.report(node, 'Слой может импортировать в себя только нижележащие слои (shared, entities, features, widgets, pages, app)');
+        }
+      }
+    };
+  },
+};

package/lib/rules/public-api-imports.js

@@ -41,6 +41,7 @@ module.exports = {
         // example app/entities/Article
         const value = node.source.value;
         const importTo = alias ? value.replace(`${alias}/`, "")  : value;
+
         //если путь относительный то выходим
         if(isPathRelative(importTo)){
           return; 
@@ -64,7 +65,7 @@ module.exports = {
         
         if(isTestingPublicApi){
           const currentFilePath = context.getFilename();
-          const normalizedPath = path.normalize(currentFilePath).replace(/\\/g, '/')
+          const normalizedPath = currentFilePath.split(path.sep).join('/');
           const isCurrentFileTesting = testFilesPatterns.some(pattern=>micromatch.isMatch(normalizedPath, pattern))
           if(!isCurrentFileTesting){
               context.report({node: node, message: 'Тестовые данные необходимо импортировать из publicApi/testing.ts'});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-big-react-app-plugin",
-  "version": "0.1.8",
+  "version": "0.2.0",
   "description": "plugin for prod proj",
   "keywords": [
     "eslint",