eslint-plugin-stratified-design 0.4.0 → 0.4.2-beta

package/.github/workflows/release.yml

@@ -8,11 +8,33 @@ jobs:
   publish:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v3
         with:
           node-version: 16
           registry-url: https://registry.npmjs.org/
-      - run: npm ci
-      - run: npm test
-      - run: npm publish
+
+      - name: Update package version
+        run: npm run versioning
+
+      - name: Commit and push package.json
+        run: |
+          git config --local user.email "action@github.com"
+          git config --local user.name "GitHub Action"
+          git commit -a -m "Update package version"
+          TARGET_COMMITISH=$(jq -r '.release.target_commitish' $GITHUB_EVENT_PATH)
+          git push origin HEAD:${TARGET_COMMITISH}
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Test
+        run: npm test
+
+      - name: Publish
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

package/README.md

@@ -31,7 +31,7 @@ Then configure the rules you wish to use under the rules section:
 ```json
 {
   "rules": {
-    "stratified-design/rule-name": ["error"]
+    "stratified-design/[rule-name]": ["error"]
   }
 }
 ```

package/docs/rules/lower-level-imports.md

@@ -22,21 +22,21 @@ The syntax to specify the level structure is as follows:
 
 In the folder array, the file or folder on the left is considered to be at a higher level than the one on the right.
 
-To designate a layer as an interface layer, set `interface` to `true`:
+To designate a layer as an abstract barrier, set `barrier` to `true`:
 
 ```json
 "lower-level-imports": ["error", {
-  "structure": ["layer1", { "name": "layer2", "interface": true }, "layer3"],
+  "structure": ["layer1", { "name": "layer2", "barrier": true }, "layer3"],
 }]
 ```
 
-For the 'interface layer,' refer to "[Grokking Simplicity](https://grokkingsimplicity.com)."
+For the 'abstract barrier,' refer to "[Grokking Simplicity](https://grokkingsimplicity.com)."
 
-To locate a node module in the structure, set `isNodeModule` to `true`:
+To locate a node module in the structure, set `nodeModule` to `true`:
 
 ```json
 "lower-level-imports": ["error", {
-  "structure": ["layer1", { "name": "nodeModule", "isNodeModule": true }, "layer3"],
+  "structure": ["layer1", { "name": "nodeModule", "nodeModule": true }, "layer3"],
 }]
 ```
 
@@ -120,7 +120,7 @@ import { func } from "../layer1";
 
 ```js
 /* "lower-level-imports": ["error", {
-  "structure": ["layer1", { name: "layer2", interface: true }, "layer3"]
+  "structure": ["layer1", { name: "layer2", barrier: true }, "layer3"]
 }] */
 // ./src/layer1.js
 import { func } from "../layer3/entry";
@@ -128,7 +128,7 @@ import { func } from "../layer3/entry";
 
 ```js
 /* "lower-level-imports": ["error", {
-  "structure":  ["layer1", { "name": "nodeModule", "isNodeModule": true }, "layer3"],
+  "structure":  ["layer1", { "name": "nodeModule", "nodeModule": true }, "layer3"],
 }] */
 // ./src/layer3/entry.js
 import { func } from "nodeModule";

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

@@ -108,7 +108,7 @@ const reportHasProperLevelNumber = (context, options, rootDir, filePath) => {
     })();
 
     if (isInterfaceError) {
-      report("interface");
+      report("barrier");
       return FINISHED;
     }
 
@@ -123,7 +123,7 @@ const reportHasProperLevelNumber = (context, options, rootDir, filePath) => {
     })();
 
     if (fileLevel === null) {
-      report("interface");
+      report("barrier");
       return FINISHED;
     }
 
@@ -159,7 +159,7 @@ const reportInSubDirOfFileDir = (fileDir) => {
 /**
  * Report error about using `options.structure`
  * @param {import('eslint').Rule.RuleContext} context
- * @param {{[string]: string | {name: string, isNodeModule: boolean, interface: boolean}}} structure
+ * @param {{[string]: {name: string; nodeModule: boolean; nodeModule: boolean; isNodeModule: boolean; interface: boolean}}} structure
  * @param {string} rootDir
  * @param {number | null} fileLevel
  * @param {string} filePath
@@ -201,7 +201,7 @@ const reportHasProperLevel = (
     }
 
     if (hasInterface(moduleLevel)) {
-      report("interface");
+      report("barrier");
       return FINISHED;
     }
 

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

@@ -13,7 +13,7 @@ const {
 const createStructure = (options, rootDir) => {
   return options.structure.map((layer) => {
     const theLayer = typeof layer === "string" ? { name: layer } : layer;
-    return theLayer.isNodeModule
+    return theLayer.nodeModule || theLayer.isNodeModule
       ? theLayer
       : { ...theLayer, name: joinPath(rootDir, theLayer.name) };
   });
@@ -63,7 +63,7 @@ const isNodeModule = (rootDir) => {
 
 /**
  * Find the layer level for a module
- * @param {{[string]: string | {name: string, isNodeModule: boolean, interface: boolean}}} structure
+ * @param {{[string]: {name: string; nodeModule: boolean; barrier: boolean; isNodeModule: boolean, interface: boolean}}} structure
  * @returns the level of the module with `path`
  */
 const findLevel = (structure) => {
@@ -83,7 +83,7 @@ const findLevel = (structure) => {
 
 /**
  * Check if there is an interface between file layer and module layer
- * @param {{[string]: string | {name: string, isNodeModule: boolean, interface: boolean}}} structure
+ * @param {{[string]: {name: string; nodeModule: boolean; barrier: boolean; isNodeModule: boolean, interface: boolean}}} structure
  * @param {number} fileLevel
  */
 const hasInterface = (structure, fileLevel) => {
@@ -93,7 +93,7 @@ const hasInterface = (structure, fileLevel) => {
   return (moduleLevel) => {
     const layerInterface = structure
       .slice(fileLevel + 1, moduleLevel)
-      .find((layer) => layer.interface);
+      .find((layer) => layer.barrier || layer.interface);
     return Boolean(layerInterface);
   };
 };

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

@@ -38,7 +38,9 @@ const layerSchema = {
           type: "string",
           pattern: layerNamePattern,
         },
+        barrier: { type: "boolean" },
         interface: { type: "boolean" },
+        nodeModule: { type: "boolean" },
         isNodeModule: { type: "boolean" },
       },
       required: ["name"],
@@ -95,7 +97,8 @@ module.exports = {
     },
     messages: {
       "not-lower-level": "'{{module}}' is NOT LOWER level than '{{file}}'",
-      interface: "An INTERFACE prevents '{{file}}' from importing '{{module}}'",
+      barrier:
+        "An ABSTRACT BARRIER prevents '{{file}}' from importing '{{module}}'",
       "not-registered:file":
         "'{{file}}' does NOT registered at layer structure",
       "not-registered:module":

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-stratified-design",
-  "version": "0.4.0",
+  "version": "0.4.2-beta",
   "description": "ESlint rules for stratified design",
   "keywords": [
     "eslint",
@@ -19,7 +19,8 @@
   "exports": "./lib/index.js",
   "scripts": {
     "lint": "eslint .",
-    "test": "mocha tests --recursive"
+    "test": "mocha tests --recursive",
+    "versioning": "node ./scripts/versioning"
   },
   "dependencies": {
     "minimatch": "^9.0.1",

package/scripts/versioning.js

@@ -0,0 +1,38 @@
+const fs = require("fs");
+
+function updatePackageVersion() {
+  const githubEventPath = process.env.GITHUB_EVENT_PATH || "";
+  const packageJsonPath = "package.json";
+
+  const version = (() => {
+    try {
+      const githubEventString = fs.readFileSync(githubEventPath, "utf-8");
+      const githubEvent = JSON.parse(githubEventString);
+      const tagName = githubEvent.release.tag_name;
+      const version = tagName.replace(/^v(.*)/, "$1");
+      return version;
+    } catch (error) {
+      throw new Error("Error parsing GITHUB_EVENT_PATH:", error);
+    }
+  })();
+
+  const packageJson = (() => {
+    try {
+      const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf8"));
+      packageJson.version = version;
+      const updatedPackageJson = JSON.stringify(packageJson, null, 2) + "\n";
+      return updatedPackageJson;
+    } catch (error) {
+      throw new Error("Error parsing package.json:", error);
+    }
+  })();
+
+  try {
+    fs.writeFileSync(packageJsonPath, packageJson, "utf8");
+    console.log(`Successfully updated version to ${version}`);
+  } catch (error) {
+    throw new Error("Error writing package.json:", error);
+  }
+}
+
+updatePackageVersion();

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

@@ -18,9 +18,9 @@ const rule = require("../../../lib/rules/lower-level-imports"),
 const structure = [
   "layer1/subLayer1",
   "layer1/subLayer2",
-  { name: "layer2/subLayer1", interface: true },
+  { name: "layer2/subLayer1", barrier: true },
   "layer2/subLayer2",
-  { name: "node-module", isNodeModule: true },
+  { name: "node-module", nodeModule: true },
   "layer3/subLayer1",
   "layer3/subLayer2",
   "layer3/subLayer3",
@@ -200,7 +200,7 @@ ruleTester.run("lower-level-imports", rule, {
       options: [{ structure, root: "./src", aliases: { "@/": "./src/" } }],
       errors: [
         {
-          messageId: "interface",
+          messageId: "barrier",
           data: { module: "./layer2/subLayer2", file: "./layer1/subLayer2" },
         },
       ],
@@ -218,7 +218,7 @@ ruleTester.run("lower-level-imports", rule, {
       ],
       errors: [
         {
-          messageId: "interface",
+          messageId: "barrier",
           data: {
             module: "./layer3/subLayer2/1 otherLayerA",
             file: "./layer3/subLayer1",
@@ -239,7 +239,7 @@ ruleTester.run("lower-level-imports", rule, {
       ],
       errors: [
         {
-          messageId: "interface",
+          messageId: "barrier",
           data: {
             module: "./layer3/subLayer2/1 otherLayerA",
             file: "./layer3/subLayer1/1 otherLayerA",
@@ -260,7 +260,7 @@ ruleTester.run("lower-level-imports", rule, {
       ],
       errors: [
         {
-          messageId: "interface",
+          messageId: "barrier",
           data: {
             module: "./component/2 layer/CompA",
             file: "./component/1 layer",
@@ -302,7 +302,7 @@ ruleTester.run("lower-level-imports", rule, {
       ],
       errors: [
         {
-          messageId: "interface",
+          messageId: "barrier",
           data: {
             module: "./component/2 layer/1 style",
             file: "./component/1 layer/1 style",

package/tests-in-package/node_modules/.package-lock.json

@@ -1,56 +0,0 @@
-{
-  "name": "tests-in-package",
-  "lockfileVersion": 3,
-  "requires": true,
-  "packages": {
-    "..": {
-      "version": "0.3.2",
-      "dev": true,
-      "license": "ISC",
-      "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"
-      }
-    },
-    "../..": {
-      "name": "@anisotropy/eslint-plugin-stratified-design",
-      "version": "0.0.0",
-      "dev": true,
-      "license": "ISC",
-      "dependencies": {
-        "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"
-      }
-    },
-    "../../lib": {
-      "extraneous": true
-    },
-    "node_modules/eslint-plugin-stratified-design": {
-      "resolved": "..",
-      "link": true
-    }
-  }
-}