eslint-plugin-aetherys-custom-plugin 0.0.1

package/.eslintrc.js

@@ -0,0 +1,19 @@
+"use strict";
+
+module.exports = {
+  root: true,
+  extends: [
+    "eslint:recommended",
+    "plugin:eslint-plugin/recommended",
+    "plugin:node/recommended",
+  ],
+  env: {
+    node: true,
+  },
+  overrides: [
+    {
+      files: ["tests/**/*.js"],
+      env: { mocha: true },
+    },
+  ],
+};

package/README.md

@@ -0,0 +1,41 @@
+# eslint-plugin-aetherys-custom-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-aetherys-custom-plugin`:
+
+```sh
+npm install eslint-plugin-aetherys-custom-plugin --save-dev
+```
+
+## Usage
+
+Add `aetherys-custom-plugin` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
+
+```json
+{
+  "plugins": ["aetherys-custom-plugin"]
+}
+```
+
+Then configure the rules you want to use under the rules section.
+
+```json
+{
+  "rules": {
+    "aetherys-custom-plugin/rule-name": 2
+  }
+}
+```
+
+## Supported Rules
+
+- Fill in provided rules here

package/docs/rules/path-checker.md

@@ -0,0 +1,35 @@
+# feature sliced relative path checker (path-checker)
+
+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/index.js

@@ -0,0 +1,18 @@
+/**
+ * @fileoverview plugin for production project
+ * @author aetherys
+ */
+"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,84 @@
+"use strict";
+
+const path = require("path");
+
+module.exports = {
+  meta: {
+    type: null, // `problem`, `suggestion`, or `layout`
+    docs: {
+      description: "feature sliced relative path checker",
+      category: "Fill me in",
+      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\user\Desktop\prod\advanced-react\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\\user\\Desktop\\javascript\\GOOD_COURSE_test\\src\\entities\\Article', 'entities/Article/fasfasfas'))
+// console.log(shouldBeRelative('C:\\Users\\user\\Desktop\\javascript\\GOOD_COURSE_test\\src\\entities\\Article', 'entities/ASdasd/fasfasfas'))
+// console.log(shouldBeRelative('C:\\Users\\user\\Desktop\\javascript\\GOOD_COURSE_test\\src\\entities\\Article', 'features/Article/fasfasfas'))
+// console.log(shouldBeRelative('C:\\Users\\user\\Desktop\\javascript\\GOOD_COURSE_test\\src\\features\\Article', 'features/Article/fasfasfas'))
+// console.log(shouldBeRelative('C:\\Users\\user\\Desktop\\javascript\\GOOD_COURSE_test\\src\\entities\\Article', 'app/index.tsx'))
+// console.log(shouldBeRelative('C:/Users/user/Desktop/javascript/GOOD_COURSE_test/src/entities/Article', 'entities/Article/asfasf/asfasf'))
+// console.log(shouldBeRelative('C:\\Users\\user\\Desktop\\javascript\\GOOD_COURSE_test\\src\\entities\\Article', '../../model/selectors/getSidebarItems'))

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "eslint-plugin-aetherys-custom-plugin",
+  "version": "0.0.1",
+  "description": "plugin for production project",
+  "keywords": [
+    "eslint",
+    "eslintplugin",
+    "eslint-plugin"
+  ],
+  "author": "aetherys",
+  "main": "lib/index.js",
+  "scripts": {
+    "lint": "eslint .",
+    "test": "mocha tests --recursive"
+  },
+  "dependencies": {
+    "requireindex": "^1.2.0"
+  },
+  "devDependencies": {
+    "eslint": "^8.0.1",
+    "eslint-plugin-eslint-plugin": "^4.0.1",
+    "eslint-plugin-node": "^11.1.0",
+    "mocha": "^9.1.3"
+  },
+  "engines": {
+    "node": "12.x || 14.x || >= 16"
+  },
+  "peerDependencies": {
+    "eslint": ">=6"
+  },
+  "license": "ISC"
+}

package/tests/lib/rules/path-checker.js

@@ -0,0 +1,30 @@
+/**
+ * @fileoverview feature sliced relative path checker
+ * @author aetherys
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const rule = require("../../../lib/rules/path-checker"),
+  RuleTester = require("eslint").RuleTester;
+
+//------------------------------------------------------------------------------
+// Tests
+//------------------------------------------------------------------------------
+
+const ruleTester = new RuleTester();
+ruleTester.run("path-checker", rule, {
+  valid: [
+    // give me some code that won't trigger a warning
+  ],
+
+  invalid: [
+    {
+      code: "asfsa",
+      errors: [{ message: "Fill me in.", type: "Me too" }],
+    },
+  ],
+});