eslint-plugin-fsd-paths-check 0.0.4 → 0.0.6

package/README.md

@@ -1,6 +1,6 @@
 # eslint-plugin-path-check
 
-plugin to check typescript imports
+Plugin to check feature sliced design paths correctness
 
 ## Installation
 
@@ -10,24 +10,23 @@ You'll first need to install [ESLint](https://eslint.org/):
 npm i eslint --save-dev
 ```
 
-Next, install `eslint-plugin-path-check`:
+Next, install `eslint-plugin-fsd-paths-check`:
 
 ```sh
-npm install eslint-plugin-path-check --save-dev
+npm install eslint-plugin-fsd-paths-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:
+In your [configuration file](https://eslint.org/docs/latest/use/configure/configuration-files#configuration-file), import the plugin `eslint-plugin-fsd-paths-check` and add `fsd-paths-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
+            [`fsd-paths-check`]
         }
     }
 ]);
@@ -38,15 +37,14 @@ 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
+            [`fsd-paths-check`]
         },
         rules: {
-            "path-check/rule-name": "warn"
+            "fsd-paths-check/rule-name": "warn"
         }
     }
 ]);

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

@@ -11,16 +11,27 @@ module.exports = {
       url: null, // URL to the documentation page for this rule
     },
     fixable: `code`,
-    schema: [], // Add a schema if the rule has options
+    schema: [
+      {
+        type: `object`,
+        properties: {
+          alias: {
+            type: `string`,
+          }
+        }
+      }
+    ],
     messages: {
       useRelativePathWithinSlice: `Imports within the slice should be relative`
     },
   },
 
   create(context) {
+    const alias = context.options[0]?.alias ?? ``;
     return {
       ImportDeclaration(node) {
-        const importTo = node.source.value;
+        const value = node.source.value;
+        const importTo = alias ? value.replace(`${alias}`, ``) : value;
         const currentFile = context.getFilename();
 
         if(shouldBeRelative(currentFile, importTo)) {
@@ -30,9 +41,10 @@ module.exports = {
             fix(fixer) {
               const projectFromPath = getProjectPath(currentFile);
               const currentDir = path.dirname(projectFromPath);
-              const relativePath = path.relative(currentDir, node.source.value);
+              const relativePath = path.relative(currentDir, importTo);
+              const finalRelativePath = relativePath.startsWith(`.`) ? relativePath : `./${relativePath}`;
 
-              return fixer.replaceText(node.source, `"${relativePath}"`);
+              return fixer.replaceText(node.source, `'${finalRelativePath}'`);
             }
           });
         }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "eslint-plugin-fsd-paths-check",
-  "version": "0.0.4",
-  "description": "plugin to check feature sliced design paths correctness",
+  "version": "0.0.6",
+  "description": "Plugin to check feature sliced design paths correctness",
   "keywords": [
     "eslint",
     "eslintplugin",