eslint-plugin-boundaries 4.0.1 → 4.2.0

package/README.md

@@ -10,7 +10,7 @@ In words of Robert C. Martin, _"Software architecture is the art of drawing line
 
 __This plugin ensures that your architecture boundaries are respected by the elements in your project__ checking the folders and files structure and the dependencies between them. __It is not a replacement for [eslint-plugin-import](https://www.npmjs.com/package/eslint-plugin-import), on the contrary, the combination of both plugins is recommended.__
 
-By default, __the plugin works by checking `import` statements, but it is also able to analyze exports, dynamic imports, and can be configured to check any other [AST nodes](https://eslint.org/docs/latest/extend/selectors)__. (_Read the [main rules overview](#main-rules-overview) and [configuration](#configuration) chapters for better comprehension_)
+By default, __the plugin works by checking `import` statements, but it is also able to analyze "require", "exports" and dynamic imports, and can be configured to check any other [AST nodes](https://eslint.org/docs/latest/extend/selectors)__. (_Read the [main rules overview](#main-rules-overview) and [configuration](#configuration) chapters for better comprehension_)
 
 ## Table of Contents
 
@@ -207,6 +207,7 @@ This setting allows to modify built-in default dependency nodes. By default, the
 
 The setting should be an array of the following strings:
 
+* `'require'`: analyze `require` statements.
 * `'import'`: analyze `import` statements.
 * `'export'`: analyze `export` statements.
 * `'dynamic-import'`: analyze [dynamic import](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/import) statements.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-boundaries",
-  "version": "4.0.1",
+  "version": "4.2.0",
   "description": "Eslint plugin checking architecture boundaries between elements",
   "keywords": [
     "eslint",
@@ -21,6 +21,7 @@
   ],
   "main": "index.js",
   "scripts": {
+    "eslint": "eslint",
     "lint": "eslint src *.js test",
     "lint-staged": "lint-staged",
     "test": "jest",
@@ -45,6 +46,7 @@
     "eslint-config-prettier": "9.0.0",
     "eslint-import-resolver-typescript": "3.6.1",
     "eslint-plugin-prettier": "5.0.1",
+    "eslint-plugin-local-rules": "2.0.1",
     "husky": "8.0.3",
     "is-ci": "3.0.1",
     "jest": "29.7.0",

package/src/constants/settings.js

@@ -41,6 +41,13 @@ module.exports = {
 
   VALID_DEPENDENCY_NODE_KINDS: ["value", "type"],
   DEFAULT_DEPENDENCY_NODES: {
+    require: [
+      // Note: detects "require('source')"
+      {
+        selector: "CallExpression[callee.name=require] > Literal",
+        kind: "value",
+      },
+    ],
     import: [
       // Note: detects "import x from 'source'"
       { selector: "ImportDeclaration:not([importKind=type]) > Literal", kind: "value" },

package/src/helpers/validations.js

@@ -140,16 +140,20 @@ function validateElements(elements) {
         }
         if (element.mode && !VALID_MODES.includes(element.mode)) {
           warnOnce(
-            `Invalid mode property in '${ELEMENTS}' setting. Should be one of ${VALID_MODES.join(
+            `Invalid mode property of type ${
+              element.type
+            } in '${ELEMENTS}' setting. Should be one of ${VALID_MODES.join(
               ",",
             )}. Default value "${VALID_MODES[0]}" will be used instead`,
           );
         }
         if (!element.pattern || !(isString(element.pattern) || isArray(element.pattern))) {
-          warnOnce(`Please provide a valid pattern in '${ELEMENTS}' setting`);
+          warnOnce(
+            `Please provide a valid pattern to type ${element.type} in '${ELEMENTS}' setting`,
+          );
         }
         if (element.capture && !isArray(element.capture)) {
-          warnOnce(`Invalid capture property in '${ELEMENTS}' setting`);
+          warnOnce(`Invalid capture property of type ${element.type} in '${ELEMENTS}' setting`);
         }
       });
     }