eslint-plugin-fsd-paths-check 0.0.1

package/README.md

@@ -0,0 +1,71 @@
+# eslint-plugin-path-check
+
+plugin to check typescript imports
+
+## Installation
+
+You'll first need to install [ESLint](https://eslint.org/):
+
+```sh
+npm i eslint --save-dev
+```
+
+Next, install `eslint-plugin-path-check`:
+
+```sh
+npm install eslint-plugin-path-check --save-dev
+```
+
+## Usage
+
+In your [configuration file](https://eslint.org/docs/latest/use/configure/configuration-files#configuration-file), import the plugin `eslint-plugin-path-check` and add `path-check` to the `plugins` key:
+
+```js
+import { defineConfig } from "eslint/config";
+import path-check from "eslint-plugin-path-check";
+
+export default defineConfig([
+    {
+        plugins: {
+            path-check
+        }
+    }
+]);
+```
+
+
+Then configure the rules you want to use under the `rules` key.
+
+```js
+import { defineConfig } from "eslint/config";
+import path-check from "eslint-plugin-path-check";
+
+export default defineConfig([
+    {
+        plugins: {
+            path-check
+        },
+        rules: {
+            "path-check/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 plugin to check typescript imports
+ * @author borispopygai
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const requireIndex = require("requireindex");
+
+//------------------------------------------------------------------------------
+// Plugin Definition
+//------------------------------------------------------------------------------
+
+
+// import all rules in lib/rules
+module.exports.rules = requireIndex(__dirname + "/rules");
+
+
+

package/lib/rules/enforce-relative-path-within-slice.js

@@ -0,0 +1,68 @@
+"use strict";
+
+const path = require("path");
+
+module.exports = {
+  meta: {
+    type: null, // `problem`, `suggestion`, or `layout`
+    docs: {
+      description: "FSD relative path check",
+      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
+    messages: {}, // Add messageId and message
+  },
+
+  create(context) {
+    return {
+      ImportDeclaration(node) {
+        const importTo = node.source.value;
+        const currentFile = context.getFilename();
+
+        if(shouldBeRelative(currentFile, importTo)) {
+          context.report(node, `Imports within the slice should be relative`);
+        }
+      }
+    };
+  },
+};
+
+const fsdLayers = {
+  'shared': 'shared',
+  'entities': 'entities',
+  'features': 'features',
+  'widgets': 'widgets',
+  'pages': 'pages',
+}
+
+function isPathRelative(path) {
+  return path === `.` || path.startsWith(`./`) || path.startsWith('../');
+}
+
+function shouldBeRelative(from, to) {
+  if(isPathRelative(to)) {
+    return false;
+  }
+
+  const toArray = to.split('/');
+  const toLayer = toArray[0];
+  const toSlice = toArray[1];
+
+  if(!toLayer || !toSlice || !fsdLayers[toLayer]) {
+    return false;
+  }
+
+  const fromNormalized = path.toNamespacedPath(from);
+  const fromProject = fromNormalized.split(`src/`)[1];
+  const fromArray = fromProject.split('/');
+  const fromLayer = fromArray[0];
+  const fromSlice = fromArray[1];
+
+  if(!fromLayer || !fromSlice || !fsdLayers[fromLayer]) {
+    return false;
+  }
+
+  return fromSlice === toSlice && fromLayer === toLayer;
+}

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "eslint-plugin-fsd-paths-check",
+  "version": "0.0.1",
+  "description": "plugin to check feature sliced design paths correctness",
+  "keywords": [
+    "eslint",
+    "eslintplugin",
+    "eslint-plugin",
+    "feature-sliced design"
+  ],
+  "author": "affimojas",
+  "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": "^8.26.0",
+    "@eslint/js": "^8.26.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": "^20.19.0 || ^22.13.0 || >=24"
+  },
+  "license": "MIT",
+  "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
+}