eslint-plugin-advanced-app 0.0.0

package/README.md

@@ -0,0 +1,71 @@
+# eslint-plugin-advanced-app
+
+custom plugin for check fsd import
+
+## Installation
+
+You'll first need to install [ESLint](https://eslint.org/):
+
+```sh
+npm i eslint --save-dev
+```
+
+Next, install `eslint-plugin-advanced-app`:
+
+```sh
+npm install eslint-plugin-advanced-app --save-dev
+```
+
+## Usage
+
+In your [configuration file](https://eslint.org/docs/latest/use/configure/configuration-files#configuration-file), import the plugin `eslint-plugin-advanced-app` and add `advanced-app` to the `plugins` key:
+
+```js
+import { defineConfig } from "eslint/config";
+import advanced-app from "eslint-plugin-advanced-app";
+
+export default defineConfig([
+    {
+        plugins: {
+            advanced-app
+        }
+    }
+]);
+```
+
+
+Then configure the rules you want to use under the `rules` key.
+
+```js
+import { defineConfig } from "eslint/config";
+import advanced-app from "eslint-plugin-advanced-app";
+
+export default defineConfig([
+    {
+        plugins: {
+            advanced-app
+        },
+        rules: {
+            "advanced-app/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/index.js

@@ -0,0 +1,22 @@
+/**
+ * @fileoverview custom plugin for check fsd import
+ * @author Andrey
+ */
+"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-checker.js

@@ -0,0 +1,82 @@
+"use strict";
+
+const path = require('path');
+
+
+module.exports = {
+  meta: {
+    type: null, // `problem`, `suggestion`, or `layout`
+    docs: {
+      description: "feature sliced relative path checker",
+      recommended: false,
+      url: null, // URL to the documentation page for this rule
+    },
+    fixable: null, // Or `code` or `whitespace`
+    schema: [], // Add a schema if the rule has options
+  },
+
+  create(context) {
+    return {
+      ImportDeclaration(node) {
+        // example app/entities/Article
+        const importTo = node.source.value;
+
+        // example C:\Users\tim\Desktop\javascript\production_project\src\entities\Article
+        const fromFilename = context.getFilename();
+
+        if(shouldBeRelative(fromFilename, importTo)) {
+          context.report(node, 'В рамках одного слайса все пути должны быть относительными');
+        }
+      }
+    };
+  },
+};
+
+function isPathRelative(path) {
+  return path === '.' || path.startsWith('./') || path.startsWith('../')
+}
+
+const layers = {
+  'entities': 'entities',
+  'features': 'features',
+  'shared': 'shared',
+  'pages': 'pages',
+  'widgets': 'widgets',
+}
+
+function shouldBeRelative(from, to) {
+  if(isPathRelative(to)) {
+    return false;
+  }
+
+  // example 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('\\')
+
+  const fromLayer = fromArray[1];
+  const fromSlice = fromArray[2];
+
+  if(!fromLayer || !fromSlice || !layers[fromLayer]) {
+    return false;
+  }
+
+  return fromSlice === toSlice && toLayer === fromLayer;
+}
+
+// console.log(shouldBeRelative('C:\\Users\\tim\\Desktop\\javascript\\GOOD_COURSE_test\\src\\entities\\Article', 'entities/Article/fasfasfas'))
+// console.log(shouldBeRelative('C:\\Users\\tim\\Desktop\\javascript\\GOOD_COURSE_test\\src\\entities\\Article', 'entities/ASdasd/fasfasfas'))
+// console.log(shouldBeRelative('C:\\Users\\tim\\Desktop\\javascript\\GOOD_COURSE_test\\src\\entities\\Article', 'features/Article/fasfasfas'))
+// console.log(shouldBeRelative('C:\\Users\\tim\\Desktop\\javascript\\GOOD_COURSE_test\\src\\features\\Article', 'features/Article/fasfasfas'))
+// console.log(shouldBeRelative('C:\\Users\\tim\\Desktop\\javascript\\GOOD_COURSE_test\\src\\entities\\Article', 'app/index.tsx'))
+// console.log(shouldBeRelative('C:/Users/tim/Desktop/javascript/GOOD_COURSE_test/src/entities/Article', 'entities/Article/asfasf/asfasf'))
+// console.log(shouldBeRelative('C:\\Users\\tim\\Desktop\\javascript\\GOOD_COURSE_test\\src\\entities\\Article', '../../model/selectors/getSidebarItems'))
+

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "eslint-plugin-advanced-app",
+  "version": "0.0.0",
+  "description": "custom plugin for check fsd import",
+  "keywords": [
+    "eslint",
+    "eslintplugin",
+    "eslint-plugin"
+  ],
+  "author": "Andrey",
+  "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"
+}