eslint-plugin-stratified-design 0.4.0

package/lib/helpers/lowerLevelImports/4 layer.js

@@ -0,0 +1,61 @@
+const p = require("path");
+
+/**
+ * @param {string} from
+ * @param {string} to
+ * @returns the relative path from `from` to `to`
+ */
+const toRelative = (from, to) => {
+  const rel = p.relative(from, to);
+  return `${to}/`.startsWith(`${from}/`) ? `./${rel}` : rel;
+};
+
+/**
+ * @param {string} path
+ * @returns path to segments
+ */
+const toSegments = (path) => path.split("/");
+
+/**
+ * @param {string[]} segments
+ * @returns segments to path
+ */
+const toPath = (segments) => segments.join("/");
+
+const joinPath = p.join;
+
+const resolvePath = p.resolve;
+
+const parsePath = p.parse;
+
+/**
+ * @param {any[]} array
+ * @param {(item: any) => boolean} callback
+ * @returns {number}
+ */
+const findLastIndex = (array, callback) => {
+  return array.reduce((lastIndex, _, index) => {
+    if (lastIndex >= 0) return lastIndex;
+    const trueIndex = array.length - 1 - index;
+    return callback(array[trueIndex]) ? trueIndex : -1;
+  }, -1);
+};
+
+/**
+ * @param {any[]} array1
+ * @param {any[]} array2
+ */
+const equal = (array1, array2) => {
+  return array1.every((item, index) => item === array2[index]);
+};
+
+module.exports = {
+  toRelative,
+  toSegments,
+  toPath,
+  joinPath,
+  resolvePath,
+  parsePath,
+  findLastIndex,
+  equal,
+};

package/lib/helpers/lowerLevelImports/index.js

@@ -0,0 +1,23 @@
+const {
+  createRootDir,
+  reportHasProperLevel: reportHasProperLayerLevel,
+  reportInSubDirOfFileDir: reportInSubDirOf,
+  FINISHED,
+  reportHasProperLevelNumber: reportHasProperLayerLevelNumber,
+  parseFileSource,
+  createModulePath: createModulePathFromSource,
+} = require("./1 layer");
+const { findLevel, createStructure, createAliases } = require("./3 layer");
+
+module.exports = {
+  FINISHED,
+  createRootDir,
+  parseFileSource,
+  reportHasProperLayerLevel,
+  reportInSubDirOf,
+  reportHasProperLayerLevelNumber,
+  createModulePathFromSource,
+  findLevel,
+  createStructure,
+  createAliases,
+};

package/lib/index.js

@@ -0,0 +1,22 @@
+/**
+ * @fileoverview Stratified Design
+ * @author Hodoug Joung
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const requireIndex = require("requireindex");
+
+//------------------------------------------------------------------------------
+// Plugin Definition
+//------------------------------------------------------------------------------
+
+
+// import all rules in lib/rules
+module.exports.rules = requireIndex(__dirname + "/rules");
+
+
+

package/lib/rules/lower-level-imports.js

@@ -0,0 +1,165 @@
+/**
+ * @fileoverview Require that lower level modules be imported (lower-level-imports)
+ * @author Hodoug Joung
+ */
+
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const {
+  reportHasProperLayerLevel,
+  reportInSubDirOf,
+  FINISHED,
+  reportHasProperLayerLevelNumber,
+  createModulePathFromSource,
+  findLevel,
+  createStructure,
+  createAliases,
+  parseFileSource,
+  createRootDir,
+} = require("../helpers/lowerLevelImports/");
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+const layerNamePattern = "^[^/]+(/[^/]+)*$";
+
+const layerSchema = {
+  oneOf: [
+    { type: "string", pattern: layerNamePattern },
+    {
+      type: "object",
+      properties: {
+        name: {
+          type: "string",
+          pattern: layerNamePattern,
+        },
+        interface: { type: "boolean" },
+        isNodeModule: { type: "boolean" },
+      },
+      required: ["name"],
+      additionalProperties: false,
+    },
+  ],
+};
+
+/** @type {import('eslint').Rule.RuleModule} */
+module.exports = {
+  meta: {
+    type: "problem",
+    fixable: "code",
+    schema: {
+      type: "array",
+      items: [
+        {
+          type: "object",
+          properties: {
+            structure: {
+              type: "array",
+              items: layerSchema,
+            },
+            root: {
+              type: "string",
+              pattern: "^\\.{1,2}(/[^/]+)*$",
+            },
+            aliases: {
+              type: "object",
+              patternProperties: {
+                ["^.+$"]: {
+                  type: "string",
+                  pattern: "^\\.{1,2}(/[^/]+)*/?$",
+                },
+              },
+              additionalProperties: false,
+            },
+            exclude: {
+              type: "array",
+              items: [{ type: "string" }],
+            },
+            include: {
+              type: "array",
+              items: [{ type: "string" }],
+            },
+            useLevelNumber: {
+              type: "boolean",
+            },
+          },
+          additionalProperties: false,
+        },
+      ],
+      additionalItems: false,
+    },
+    messages: {
+      "not-lower-level": "'{{module}}' is NOT LOWER level than '{{file}}'",
+      interface: "An INTERFACE prevents '{{file}}' from importing '{{module}}'",
+      "not-registered:file":
+        "'{{file}}' does NOT registered at layer structure",
+      "not-registered:module":
+        "'{{module}}' does NOT registered at layer structure",
+    },
+  },
+  create(context) {
+    const options = {
+      root: "./",
+      structure: [],
+      exclude: ["**/*.{test,spec}.{js,ts,jsx,tsx}"],
+      include: ["**/*.{js,ts,jsx,tsx}"],
+      aliases: {},
+      useLevelNumber: false,
+      ...(context.options[0] || {}),
+    };
+
+    const cwd = context.getCwd();
+    const rootDir = createRootDir(cwd, options);
+
+    const { fileDir, filePath, isExcludedFile } = parseFileSource(
+      options,
+      context.getFilename()
+    );
+
+    const structure = createStructure(options, rootDir);
+
+    const createModulePath = createModulePathFromSource(
+      cwd,
+      fileDir,
+      createAliases(options)
+    );
+
+    const fileLevel = findLevel(structure)(filePath);
+
+    const reportHasProperLevelNumber = reportHasProperLayerLevelNumber(
+      context,
+      options,
+      rootDir,
+      filePath
+    );
+
+    const reportInSubDirOfFileDir = reportInSubDirOf(fileDir);
+
+    const reportHasProperLevel = reportHasProperLayerLevel(
+      context,
+      structure,
+      rootDir,
+      fileLevel,
+      filePath
+    );
+
+    return {
+      ImportDeclaration(node) {
+        if (isExcludedFile) return;
+
+        const modulePath = createModulePath(node.source.value);
+
+        if (reportHasProperLevelNumber(node, modulePath) === FINISHED) return;
+
+        if (reportInSubDirOfFileDir(node, modulePath) === FINISHED) return;
+
+        reportHasProperLevel(node, modulePath);
+      },
+    };
+  },
+};

package/lib/rules/no-same-level-funcs.js

@@ -0,0 +1,50 @@
+/**
+ * @fileoverview Disallow calling functions in the same file.
+ * @author Hodoug Joung
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+/** @type {import('eslint').Rule.RuleModule} */
+module.exports = {
+  meta: {
+    type: "problem",
+    fixable: "code",
+    schema: [],
+    messages: {
+      "no-same-level-funcs": "Disallow calling {{func}} in the same file.",
+    },
+  },
+
+  create(context) {
+    let funcNames;
+    return {
+      Program(node) {
+        funcNames = node.body.reduce((names, { type, id, declarations }) => {
+          if (type === "FunctionDeclaration") {
+            names.push(id.name);
+          } else if (
+            type === "VariableDeclaration" &&
+            (declarations[0].init.type === "ArrowFunctionExpression" ||
+              declarations[0].init.type === "FunctionExpression")
+          ) {
+            names.push(declarations[0].id.name);
+          }
+          return names;
+        }, []);
+      },
+      CallExpression(node) {
+        if (funcNames.includes(node.callee.name)) {
+          context.report({
+            node,
+            messageId: "no-same-level-funcs",
+            data: { func: node.callee.name },
+          });
+        }
+      },
+    };
+  },
+};

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "eslint-plugin-stratified-design",
+  "version": "0.4.0",
+  "description": "ESlint rules for stratified design",
+  "keywords": [
+    "eslint",
+    "eslintplugin",
+    "eslint-plugin",
+    "stratified",
+    "stratified design"
+  ],
+  "author": "Hodoug Joung",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/anisotropy/eslint-plugin-stratified-design"
+  },
+  "homepage": "https://github.com/anisotropy/eslint-plugin-stratified-design",
+  "main": "./lib/index.js",
+  "exports": "./lib/index.js",
+  "scripts": {
+    "lint": "eslint .",
+    "test": "mocha tests --recursive"
+  },
+  "dependencies": {
+    "minimatch": "^9.0.1",
+    "requireindex": "^1.2.0"
+  },
+  "devDependencies": {
+    "eslint": "^8.19.0",
+    "eslint-plugin-eslint-plugin": "^5.0.0",
+    "eslint-plugin-node": "^11.1.0",
+    "mocha": "^10.0.0"
+  },
+  "engines": {
+    "node": "^14.17.0 || ^16.0.0 || >= 18.0.0"
+  },
+  "peerDependencies": {
+    "eslint": ">=7"
+  },
+  "license": "ISC"
+}

package/tests/lib/rules/lower-level-imports.js

@@ -0,0 +1,314 @@
+/**
+ * @fileoverview test for lower-level-imports
+ * @author Hodoug Joung
+ */
+"use strict";
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const rule = require("../../../lib/rules/lower-level-imports"),
+  RuleTester = require("eslint").RuleTester;
+
+//------------------------------------------------------------------------------
+// Tests
+//------------------------------------------------------------------------------
+
+const structure = [
+  "layer1/subLayer1",
+  "layer1/subLayer2",
+  { name: "layer2/subLayer1", interface: true },
+  "layer2/subLayer2",
+  { name: "node-module", isNodeModule: true },
+  "layer3/subLayer1",
+  "layer3/subLayer2",
+  "layer3/subLayer3",
+];
+
+const ruleTester = new RuleTester({
+  parserOptions: { ecmaVersion: 2022, sourceType: "module" },
+});
+
+ruleTester.run("lower-level-imports", rule, {
+  valid: [
+    {
+      code: "import { func } from './otherLayerB/otherSubLayer'",
+      filename: "./src/otherLayerA.js",
+      options: [{ structure, root: "./src" }],
+    },
+    {
+      code: "import { func } from '../layer1/subLayer2'",
+      filename: "./src/layer1/subLayer1.js",
+      options: [{ structure, root: "./src" }],
+    },
+    {
+      code: "import { func } from '@/layer1/subLayer2'",
+      filename: "./src/layer1/subLayer1.js",
+      options: [{ structure, root: "./src", aliases: { "@/": "./src/" } }],
+    },
+    {
+      code: "import { func } from '@/layer1/subLayer2/otherLayerA'",
+      filename: "./src/layer1/subLayer1.js",
+      options: [{ structure, root: "./src", aliases: { "@/": "./src/" } }],
+    },
+    {
+      code: "import { func } from '@/layer1/subLayer2/otherLayerB'",
+      filename: "./src/layer1/subLayer1/otherLayerA.js",
+      options: [{ structure, root: "./src", aliases: { "@/": "./src/" } }],
+    },
+    {
+      code: "import { func } from 'node-module'",
+      filename: "./src/otherLayerA.js",
+      options: [{ structure, root: "./src" }],
+    },
+    {
+      code: "import { func } from 'node-module'",
+      filename: "./src/layer2/subLayer1.js",
+      options: [{ structure, root: "./src" }],
+    },
+    {
+      code: "import { func } from '@/layer2/subLayer1'",
+      filename: "./src/layer1/subLayer2.js",
+      options: [{ structure, root: "./src", aliases: { "@/": "./src/" } }],
+    },
+    {
+      code: "import { func } from '@/layer3/subLayer1'",
+      filename: "./src/layer2/subLayer1.js",
+      options: [{ structure, root: "./src", aliases: { "@/": "./src/" } }],
+    },
+    {
+      code: "import { func } from './otherLayerB'",
+      filename: "./src/otherLayerA.test.js",
+      options: [
+        {
+          structure,
+          root: "./src",
+          exclude: ["**/*.{test,spec}.{js,ts,jsx,tsx}"],
+        },
+      ],
+    },
+    {
+      code: "import { func } from './otherLayerB'",
+      filename: "./src/otherLayerA.test.js",
+      options: [
+        { structure, root: "./src", include: ["**/*.{js,ts,jsx,tsx}"] },
+      ],
+    },
+    {
+      code: "import { func } from './otherLayerB'",
+      filename: "./src/otherLayerA.test.js",
+      options: [
+        {
+          structure,
+          root: "./src",
+          include: ["**/*.js"],
+          exclude: ["**/otherLayerA.test.js"],
+        },
+      ],
+    },
+    {
+      code: "import { func } from './2 otherLayerB'",
+      filename: "./src/1 otherLayerA.js",
+      options: [{ structure, root: "./src", useLevelNumber: true }],
+    },
+    {
+      code: "import { func } from './1 otherSubLayerB'",
+      filename: "./src/otherLayerA/index.js",
+      options: [{ structure, root: "./src", useLevelNumber: true }],
+    },
+    {
+      code: "import { func } from './1 otherSubLayerB'",
+      filename: "./src/otherLayerA/subLayer.js",
+      options: [{ structure, root: "./src", useLevelNumber: true }],
+    },
+    {
+      code: "import { func } from '@/component/99 library'",
+      filename: "./src/component/1 layer/CompA/index.ts",
+      options: [
+        {
+          structure,
+          root: "./src",
+          useLevelNumber: true,
+          aliases: { "@/": "./src/" },
+        },
+      ],
+    },
+    {
+      code: "import { func } from '@/component/99 library'",
+      filename: "./src/component/1 layer/CompA/ComponentA.ts",
+      options: [
+        {
+          structure,
+          root: "./src",
+          useLevelNumber: true,
+          aliases: { "@/": "./src/" },
+        },
+      ],
+    },
+    {
+      code: "import { func } from '@/component/99 library'",
+      filename: "./src/component/1 layer/CompA/1 style.tsx",
+      options: [
+        {
+          structure,
+          root: "./src",
+          useLevelNumber: true,
+          aliases: { "@/": "./src/" },
+        },
+      ],
+    },
+    {
+      code: "import { func } from '@/component/1 layer/2 style'",
+      filename: "./src/component/1 layer/1 style.tsx",
+      options: [
+        {
+          structure,
+          root: "./src",
+          useLevelNumber: true,
+          aliases: { "@/": "./src/" },
+        },
+      ],
+    },
+  ],
+  invalid: [
+    {
+      code: "import { func } from './otherLayerB'",
+      filename: "./src/otherLayerA.js",
+      options: [{ structure, root: "./src" }],
+      errors: [
+        {
+          messageId: "not-registered:file",
+          data: { module: "./otherLayerB", file: "./otherLayerA" },
+        },
+      ],
+    },
+    {
+      code: "import { func } from 'node-module'",
+      filename: "./src/layer3/subLayer1.js",
+      options: [{ structure, root: "./src" }],
+      errors: [
+        {
+          messageId: "not-lower-level",
+          data: { module: "node-module", file: "./layer3/subLayer1" },
+        },
+      ],
+    },
+    {
+      code: "import { func } from '@/layer2/subLayer2'",
+      filename: "./src/layer1/subLayer2.js",
+      options: [{ structure, root: "./src", aliases: { "@/": "./src/" } }],
+      errors: [
+        {
+          messageId: "interface",
+          data: { module: "./layer2/subLayer2", file: "./layer1/subLayer2" },
+        },
+      ],
+    },
+    {
+      code: "import { func } from '@/layer3/subLayer2/1 otherLayerA'",
+      filename: "./src/layer3/subLayer1.js",
+      options: [
+        {
+          structure,
+          useLevelNumber: true,
+          root: "./src",
+          aliases: { "@/": "./src/" },
+        },
+      ],
+      errors: [
+        {
+          messageId: "interface",
+          data: {
+            module: "./layer3/subLayer2/1 otherLayerA",
+            file: "./layer3/subLayer1",
+          },
+        },
+      ],
+    },
+    {
+      code: "import { func } from '@/layer3/subLayer2/1 otherLayerA'",
+      filename: "./src/layer3/subLayer1/1 otherLayerA.js",
+      options: [
+        {
+          structure,
+          useLevelNumber: true,
+          root: "./src",
+          aliases: { "@/": "./src/" },
+        },
+      ],
+      errors: [
+        {
+          messageId: "interface",
+          data: {
+            module: "./layer3/subLayer2/1 otherLayerA",
+            file: "./layer3/subLayer1/1 otherLayerA",
+          },
+        },
+      ],
+    },
+    {
+      code: "import { func } from '@/component/2 layer/CompA'",
+      filename: "./src/component/1 layer.ts",
+      options: [
+        {
+          structure,
+          root: "./src",
+          useLevelNumber: true,
+          aliases: { "@/": "./src/" },
+        },
+      ],
+      errors: [
+        {
+          messageId: "interface",
+          data: {
+            module: "./component/2 layer/CompA",
+            file: "./component/1 layer",
+          },
+        },
+      ],
+    },
+    {
+      code: "import { func } from '@/component/1 layer/1 style'",
+      filename: "./src/component/1 layer/2 style.ts",
+      options: [
+        {
+          structure,
+          root: "./src",
+          useLevelNumber: true,
+          aliases: { "@/": "./src/" },
+        },
+      ],
+      errors: [
+        {
+          messageId: "not-lower-level",
+          data: {
+            module: "./component/1 layer/1 style",
+            file: "./component/1 layer/2 style",
+          },
+        },
+      ],
+    },
+    {
+      code: "import { func } from '@/component/2 layer/1 style'",
+      filename: "./src/component/1 layer/1 style.ts",
+      options: [
+        {
+          structure,
+          root: "./src",
+          useLevelNumber: true,
+          aliases: { "@/": "./src/" },
+        },
+      ],
+      errors: [
+        {
+          messageId: "interface",
+          data: {
+            module: "./component/2 layer/1 style",
+            file: "./component/1 layer/1 style",
+          },
+        },
+      ],
+    },
+  ],
+});