LINT-45: Split layers-slices-boundaries

index.js

@@ -6,8 +6,8 @@ module.exports = {
         "sourceType": "module",
     },
     extends: [
-        path.resolve(__dirname, "./rules/public-api-boundaries"),
-        path.resolve(__dirname, "./rules/layers-slices-boundaries"),
-        path.resolve(__dirname, "./rules/import-order")
-    ],
+        "./rules/public-api-boundaries",
+        "./rules/layers-slices-boundaries",
+        "./rules/import-order",
+    ].map(require.resolve),
 };

rules/integration.test.js

@@ -24,7 +24,6 @@ describe("Integration tests:", () => {
         `, {
             filePath: "src/widgets/mock/index.js",
         });
-
         assert.strictEqual(report[0].errorCount, 11);
     });
 

rules/layers-boundaries/index.js

@@ -0,0 +1,34 @@
+const { layersLib } = require("../../utils");
+
+const getLayersRules = () =>
+    layersLib.FS_LAYERS.map((layer) => ({
+        from: layer,
+        disallow: layersLib.getUpperLayers(layer),
+    }));
+
+const getLayersBoundariesElements = () =>
+    layersLib.FS_LAYERS.map((layer) => ({
+        type: layer,
+        pattern: `${layer}/**`,
+        mode: "folder",
+        capture: ["layers"],
+    }));
+
+module.exports = {
+    plugins: ["boundaries"],
+    extends: ["plugin:boundaries/recommended"],
+    ignorePatterns: [".eslintrc.js"],
+    settings: {
+        "boundaries/elements": getLayersBoundariesElements(),
+    },
+    rules: {
+        "boundaries/element-types": [
+            2,
+            {
+                "default": "allow",
+                "message": "\"${file.type}\" is not allowed to import \"${dependency.type}\" | See rules: https://feature-sliced.design/docs/reference/layers/overview ",
+                "rules": getLayersRules(),
+            },
+        ],
+    },
+};

rules/layers-boundaries/index.md

@@ -0,0 +1,16 @@
+# @feature-sliced/layers-slices-boundaries
+
+Reference: [Cross-communication](https://feature-sliced.design/docs/concepts/cross-communication)
+
+```js
+// 👎 Fail
+// 🛣 features/auth-form/index.ts
+import { getRoute } from "pages/auth";
+import { getStore } from "app/store";
+
+
+// 👍 Pass
+// 🛣 features/auth-form/index.ts
+import { Form, Button } from "shared/ui";
+import { getAuthCtx } from "entities/session";
+```

rules/layers-slices-boundaries/index.js

@@ -1,13 +1,12 @@
 const { layersLib } = require("../../utils");
 
 const getLayersRules = () =>
-
     layersLib.FS_LAYERS.map((layer) => ({
         from: layer,
         allow: layersLib.getLowerLayers(layer),
     }));
 
-const getLayersBoundariesElements = () =>
+const getAllBoundariesElements = () =>
     layersLib.FS_LAYERS.map((layer) => ({
         type: layer,
         pattern: `${layer}/*`,
@@ -20,7 +19,7 @@ module.exports = {
     extends: ["plugin:boundaries/recommended"],
     ignorePatterns: [".eslintrc.js"],
     settings: {
-        "boundaries/elements": getLayersBoundariesElements(),
+        "boundaries/elements": getAllBoundariesElements(),
     },
     rules: {
         "boundaries/element-types": [
@@ -32,4 +31,4 @@ module.exports = {
             },
         ],
     },
-};
+};

rules/layers-slices-boundaries/index.test.js

@@ -0,0 +1,89 @@
+const { ESLint } = require("eslint");
+const assert = require("assert");
+const { configLib } = require("../../utils");
+const cfg = require("./");
+
+const eslint = new ESLint({
+    useEslintrc: false,
+    baseConfig: configLib.setParser(
+        configLib.mockImports(cfg),
+    ),
+});
+
+describe("Slices and Layers config:", () => {
+
+    describe("Layers:", () => {
+        it("should lint with cross-import errors.", async () => {
+            const wrongImports = [
+                `import { getRoute } from "pages/auth";`,
+                `import { getStore } from "app/store";`,
+            ];
+
+            const report = await eslint.lintText(wrongImports.join("\n"), {
+                filePath: "src/shared/lib/index.js",
+            });
+            assert.strictEqual(report[0].errorCount, wrongImports.length);
+        });
+
+        it("should lint without errors.", async () => {
+            const validCodeSnippet = [
+                `import { sessionModel } from "entities/session";`,
+                `import { Form, Button } from "shared/ui";`,
+            ].join("\n");
+
+            const report = await eslint.lintText(validCodeSnippet, {
+                filePath: "src/app/ui/app.js",
+            });
+            assert.strictEqual(report[0].errorCount, 0);
+        });
+    });
+
+    describe("Slices:", () => {
+        it("should lint with cross-import errors between pages.", async () => {
+            const report = await eslint.lintText(`
+            import { getAuthCtx } from "pages/logout";
+            import { UserAvatar } from "pages/auth";`,
+                { filePath: "src/pages/map/index.js" });
+
+            assert.strictEqual(report[0].errorCount, 2);
+        });
+
+        it("should lint with cross-import errors between widgets.", async () => {
+            const report = await eslint.lintText(`
+            import { HeaderTitle } from "widgets/header";
+            import { Links } from "widgets/footer";`,
+                { filePath: "src/widgets/mock/index.js" });
+
+            assert.strictEqual(report[0].errorCount, 2);
+        });
+
+        it("should lint with cross-import errors between features.", async () => {
+            const report = await eslint.lintText(`
+            import { getAuthCtx } from "features/logout";
+            import { UserAvatar } from "features/viewer-picker";`,
+                { filePath: "src/features/auth-form/index.js" });
+
+            assert.strictEqual(report[0].errorCount, 2);
+        });
+
+        it("should lint with cross-import errors between entities.", async () => {
+            const report = await eslint.lintText(`
+            import { LoginForm } from "entities/login-form";
+            import { Avatar } from "entities/avatar";`,
+                { filePath: "src/entities/mock/index.js" });
+
+            assert.strictEqual(report[0].errorCount, 2);
+        });
+
+        it("should lint without error", async () => {
+            const report = await eslint.lintText(`
+            import { model } from "../model";
+            import { styles } from "./style.js";
+            import { utils } from "../lib/utils.js";`,
+                { filePath: "src/entities/mock/index.js" });
+
+            assert.strictEqual(report[0].errorCount, 0);
+        });
+
+    });
+});

rules/slices-boundaries/index.js

@@ -0,0 +1,34 @@
+const { layersLib } = require("../../utils");
+
+const getSlicesRules = () =>
+    layersLib.FS_LAYERS.map((layer) => ({
+        from: layer,
+        disallow: layer,
+    }));
+
+const getSlicesBoundariesElements = () =>
+    layersLib.FS_LAYERS.map((layer) => ({
+        type: layer,
+        pattern: `${layer}`,
+        mode: "folder",
+        capture: ["slices"],
+    }));
+
+module.exports = {
+    plugins: ["boundaries"],
+    extends: ["plugin:boundaries/recommended"],
+    ignorePatterns: [".eslintrc.js"],
+    settings: {
+        "boundaries/elements": getSlicesBoundariesElements(),
+    },
+    rules: {
+        "boundaries/element-types": [
+            2,
+            {
+                "default": "allow",
+                "message": "\"${file.type}\" is not allowed to import \"${dependency.type}\" | See rules: https://feature-sliced.design/docs/concepts/app-splitting#group-slices ",
+                "rules": getSlicesRules(),
+            },
+        ],
+    },
+};

rules/layers-slices-boundaries/index.md → rules/slices-boundaries/index.md

@@ -5,15 +5,11 @@ Reference: [Cross-communication](https://feature-sliced.design/docs/concepts/cro
 ```js
 // 👎 Fail
 // 🛣 features/auth-form/index.ts
-import { getRoute } from "pages/auth";
-import { getStore } from "app/store";
 import { getAuthCtx } from "features/logout";
 import { UserAvatar } from "features/viewer-picker";
 
 // 👍 Pass
 // 🛣 features/auth-form/index.ts
 import { sessionModel } from "entities/session";
 import { Form, Button } from "shared/ui";
-import { getAuthCtx } from "entities/session";
-import { UserAvatar } from "entities/user";
 ```

rules/slices-boundaries/slices.test.js

@@ -0,0 +1,61 @@
+const { ESLint } = require("eslint");
+const assert = require("assert");
+const { configLib } = require("../../utils");
+const cfg = require("./");
+
+const eslint = new ESLint({
+    useEslintrc: false,
+    baseConfig: configLib.setParser(
+        configLib.mockImports(cfg),
+    ),
+});
+
+describe("Import boundaries between slices", () => {
+
+    it("should lint with cross-import errors between pages.", async () => {
+        const report = await eslint.lintText(`
+            import { getAuthCtx } from "pages/logout";
+            import { UserAvatar } from "pages/auth";`,
+            { filePath: "src/pages/map/index.js" });
+
+        assert.strictEqual(report[0].errorCount, 2);
+    });
+
+    it("should lint with cross-import errors between widgets.", async () => {
+        const report = await eslint.lintText(`
+            import { HeaderTitle } from "widgets/header";
+            import { Links } from "widgets/footer";`,
+            { filePath: "src/widgets/mock/index.js" });
+
+        assert.strictEqual(report[0].errorCount, 2);
+    });
+
+    it("should lint with cross-import errors between features.", async () => {
+        const report = await eslint.lintText(`
+            import { getAuthCtx } from "features/logout";
+            import { UserAvatar } from "features/viewer-picker";`,
+            { filePath: "src/features/auth-form/index.js" });
+
+        assert.strictEqual(report[0].errorCount, 2);
+    });
+
+    it("should lint with cross-import errors between entities.", async () => {
+        const report = await eslint.lintText(`
+            import { LoginForm } from "entities/login-form";
+            import { Avatar } from "entities/avatar";`,
+            { filePath: "src/entities/mock/index.js" });
+
+        assert.strictEqual(report[0].errorCount, 2);
+    });
+
+    it("should lint without error", async () => {
+        const report = await eslint.lintText(`
+            import { model } from "../model";
+            import { styles } from "./style.js";
+            import { utils } from "../lib/utils.js";`,
+            { filePath: "src/entities/mock/index.js" });
+
+        assert.strictEqual(report[0].errorCount, 0);
+    });
+
+});

utils/config/index.js

@@ -10,9 +10,9 @@ const mockImports = (config, extension = "js") => {
                     extension,
                 },
             },
-        }
-    }
-}
+        },
+    };
+};
 
 function setParser (config, version = "2015") {
     return {
@@ -31,4 +31,8 @@ function setTSParser (config) {
     };
 }
 
-module.exports.configLib = { mockImports, setParser, setTSParser };
+module.exports.configLib = {
+    mockImports,
+    setParser,
+    setTSParser,
+};