eslint-plugin-gapone-plugin 0.0.8

package/README.md

@@ -0,0 +1,68 @@
+# eslint-plugin-max-plugin
+
+plugin for production project
+
+## Installation
+
+You'll first need to install [ESLint](https://eslint.org/):
+
+```sh
+npm i eslint --save-dev
+```
+
+Next, install `eslint-plugin-max-plugin-path-checker`:
+
+```sh
+npm install eslint-plugin-max-plugin-path-checker --save-dev
+```
+
+## Usage
+
+In your [configuration file](https://eslint.org/docs/latest/use/configure/configuration-files#configuration-file), import the plugin `eslint-plugin-max-plugin` and add `max-plugin` to the `plugins` key:
+
+```js
+import { defineConfig } from "eslint/config";
+import max-plugin from "eslint-plugin-max-plugin";
+
+export default defineConfig([
+    {
+        plugins: {
+            max-plugin
+        }
+    }
+]);
+```
+
+Then configure the rules you want to use under the `rules` key.
+
+```js
+import { defineConfig } from "eslint/config";
+import max-plugin from "eslint-plugin-max-plugin";
+
+export default defineConfig([
+    {
+        plugins: {
+            max-plugin
+        },
+        rules: {
+            "max-plugin/rule-name": "warn"
+        }
+    }
+]);
+```
+
+## Configurations
+
+<!-- begin auto-generated configs list -->
+
+TODO: Run eslint-doc-generator to generate the configs list (or delete this section if no configs are offered).
+
+<!-- end auto-generated configs list -->
+
+## Rules
+
+<!-- begin auto-generated rules list -->
+
+TODO: Run eslint-doc-generator to generate the rules list.
+
+<!-- end auto-generated rules list -->

package/lib/helpers/index.js

@@ -0,0 +1,7 @@
+function isPathRelative(path) {
+    return path === '.' || path.startsWith('./') || path.startsWith('../');
+}
+
+module.exports = {
+    isPathRelative,
+};

package/lib/index.js

@@ -0,0 +1,18 @@
+/**
+ * @fileoverview plugin for production project
+ * @author max
+ */
+'use strict';
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const requireIndex = require('requireindex');
+
+//------------------------------------------------------------------------------
+// Plugin Definition
+//------------------------------------------------------------------------------
+
+// import all rules in lib/rules
+module.exports.rules = requireIndex(__dirname + '/rules');

package/lib/rules/path-cheker.js

@@ -0,0 +1,96 @@
+'use strict';
+const path = require('path');
+const { isPathRelative } = require('../helpers');
+
+module.exports = {
+    meta: {
+        type: 'problem', // `problem`, `suggestion`, or `layout`
+        docs: {
+            description: 'feature sliced relative path cheker',
+            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',
+                    },
+                },
+            },
+        ], // Add a schema if the rule has options
+        messages: {
+            invalidPath:
+                'В рамках одного слайса все пути должны быть относительными',
+        }, // Add messageId and message
+    },
+
+    create(context) {
+        const alias = context.options[0]?.alias || '';
+
+        return {
+            ImportDeclaration(node) {
+                // "Example" app/entities/Article
+                const value = node.source.value;
+                const importTo = alias ? value.replace(`${alias}/`, '') : value;
+
+                // "Example" D:\frontEnd\full-case\src\entities/Article
+                const fromFilename = context.getFilename();
+
+                if (shouldBeRelation(fromFilename, importTo)) {
+                    context.report({
+                        node,
+                        messageId: 'invalidPath',
+                    });
+                }
+            },
+        };
+    },
+};
+
+const layers = {
+    entities: 'entities',
+    features: 'features',
+    shared: 'shared',
+    pages: 'pages',
+    widgets: 'widgets',
+};
+
+function shouldBeRelation(from, to) {
+    if (isPathRelative(to)) {
+        return false;
+    }
+
+    // "Example" app/entities/Article
+    const toArray = to.split('/');
+    const toLayer = toArray[0]; // entities (СЛОЙ)
+    const toSlice = toArray[1]; // Article (СЛАЙС)
+
+    if (!toLayer || !toSlice || !layers[toLayer]) {
+        return false;
+    }
+
+    const normalizedPath = path.toNamespacedPath(from);
+    const projectFrom = normalizedPath.split('src')[1];
+    const fromArray = projectFrom.split('\\');
+    console.log(fromArray);
+
+    const fromLayer = fromArray[1];
+    const fromSlice = fromArray[2];
+
+    if (!fromLayer || !fromSlice || !layers[fromLayer]) {
+        return false;
+    }
+
+    return fromSlice == toSlice && toLayer === fromLayer;
+    // "Example" D:\frontEnd\full-case\src\entities/Article
+}
+
+// console.log(
+//     shouldBeRelation(
+//         'D:\\frontEnd\\full-case\\src\\entities\\Article\\index.tsx',
+//         'entities/Article'
+//     )
+// );

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

@@ -0,0 +1,67 @@
+const { isPathRelative } = require('../helpers');
+
+/** @type {import('eslint').Rule.RuleModule} */
+module.exports = {
+    meta: {
+        type: 'problem', // `problem`, `suggestion`, or `layout`
+        docs: {
+            description: 'desc',
+            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',
+                    },
+                },
+            },
+        ], // Add a schema if the rule has options
+        messages: {
+            noPublicApiImports:
+                'Абсолютный импорт разрешен только из Public Api (index.ts)',
+        }, // Add messageId and message
+    },
+
+    create(context) {
+        const alias = context.options[0]?.alias || '';
+
+        const checkingLayers = {
+            entities: 'entities',
+            features: 'features',
+            pages: 'pages',
+            widgets: 'widgets',
+        };
+
+        return {
+            ImportDeclaration(node) {
+                const value = node.source.value;
+                const importTo = alias ? value.replace(`${alias}/`, '') : value;
+
+                if (isPathRelative(importTo)) {
+                    return;
+                }
+
+                const segments = importTo.split('/');
+
+                const layer = segments[0];
+
+                if (!checkingLayers[layer]) {
+                    return;
+                }
+
+                const isImportNotFromPublickApi = segments.length > 2;
+
+                if (isImportNotFromPublickApi) {
+                    context.report({
+                        node,
+                        messageId: 'noPublicApiImports',
+                    });
+                }
+            },
+        };
+    },
+};

package/package.json

@@ -0,0 +1,42 @@
+{
+    "name": "eslint-plugin-gapone-plugin",
+    "version": "0.0.8",
+    "description": "plugin for production project",
+    "keywords": [
+        "eslint",
+        "eslintplugin",
+        "eslint-plugin"
+    ],
+    "author": "max",
+    "main": "./lib/index.js",
+    "exports": "./lib/index.js",
+    "files": [
+        "lib"
+    ],
+    "scripts": {
+        "lint": "npm-run-all \"lint:*\"",
+        "lint:eslint-docs": "npm-run-all \"update:eslint-docs -- --check\"",
+        "lint:js": "eslint .",
+        "test": "mocha tests --recursive",
+        "update:eslint-docs": "eslint-doc-generator"
+    },
+    "dependencies": {
+        "requireindex": "^1.2.0"
+    },
+    "devDependencies": {
+        "eslint": "^9.0.0",
+        "@eslint/js": "^9.0.0",
+        "eslint-doc-generator": "^2.0.0",
+        "eslint-plugin-eslint-plugin": "^6.0.0",
+        "eslint-plugin-n": "^17.0.0",
+        "mocha": "^11.0.0",
+        "npm-run-all2": "^6.1.2"
+    },
+    "engines": {
+        "node": "^18.18.0 || ^20.9.0 || >=21.1.0"
+    },
+    "peerDependencies": {
+        "eslint": ">=8.57.0"
+    },
+    "license": "MIT"
+}