eslint-plugin-boundaries 2.7.0 → 2.8.0

package/README.md

@@ -259,7 +259,7 @@ Some rules require extra configuration, and it has to be defined in each specifi
 
 #### Main format of rules options
 
-The docs of each rule contains an specification of their own options, but __the main rules share the format in which the options have to be defined__. The format described here is valid for options of [`element-types`](docs/rules/element-types.md), [`external`](docs/rules/external.md) and [`entry-point`](docs/rules/entry-point.md) rules, __except the `message` property, which for the moment is only supported in the [`element-types`](docs/rules/element-types.md) and [`entry-point`](docs/rules/entry-point.md) rules settings.
+The docs of each rule contains an specification of their own options, but __the main rules share the format in which the options have to be defined__. The format described here is valid for options of [`element-types`](docs/rules/element-types.md), [`external`](docs/rules/external.md) and [`entry-point`](docs/rules/entry-point.md) rules, __except the `message` property, which for the moment is only supported in the [`element-types`](docs/rules/element-types.md), [`entry-point`](docs/rules/entry-point.md) and [`no-private`](docs/rules/no-private.md) rules settings.
 
 Options set an "allow/disallow" value by default, and provide an array of rules. Each matching rule will override the default value and the value returned by previous matching rules. So, the final result of the options, once processed for each case, will be "allow" or "disallow", and this value will be applied by the plugin rule in the correspondant way, making it to produce an eslint error or not.
 
@@ -331,6 +331,7 @@ Available properties in error templates both from `file` or `dependency` are:
 
 * `type`: Element's type.
 * `internalPath`: File path being analyzed or imported. Relative to the element's root path.
+* `parent`: If the element is child of another element, it is also available in this property, which contains correspondent `type`, `internalPath` and captured properties as well.
 * ...All captured properties are also available
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-boundaries",
-  "version": "2.7.0",
+  "version": "2.8.0",
   "description": "Eslint plugin checking architecture boundaries between elements",
   "keywords": [
     "eslint",

package/src/helpers/messages.js

@@ -79,12 +79,31 @@ function ruleElementMessage(elementPatterns, elementCapturedValues) {
   return elementMatcherMessage(elementPatterns, elementCapturedValues);
 }
 
+function elementPropertiesToReplaceInTemplate(element) {
+  return { ...element.capturedValues, type: element.type, internalPath: element.internalPath };
+}
+
 function customErrorMessage(message, file, dependency) {
-  return replaceObjectValuesInTemplates(
-    replaceObjectValuesInTemplates(message, { ...file.capturedValues, type: file.type }, "file"),
-    { ...dependency.capturedValues, type: dependency.type, internalPath: dependency.internalPath },
+  let replacedMessage = replaceObjectValuesInTemplates(
+    replaceObjectValuesInTemplates(message, elementPropertiesToReplaceInTemplate(file), "file"),
+    elementPropertiesToReplaceInTemplate(dependency),
     "dependency"
   );
+  if (file.parents[0]) {
+    replacedMessage = replaceObjectValuesInTemplates(
+      replacedMessage,
+      elementPropertiesToReplaceInTemplate(file.parents[0]),
+      "file.parent"
+    );
+  }
+  if (dependency.parents[0]) {
+    replacedMessage = replaceObjectValuesInTemplates(
+      replacedMessage,
+      elementPropertiesToReplaceInTemplate(dependency.parents[0]),
+      "dependency.parent"
+    );
+  }
+  return replacedMessage;
 }
 
 function elementCapturedValuesMessage(capturedValues) {

package/src/rules/no-private.js

@@ -3,6 +3,14 @@ const { RULE_NO_PRIVATE } = require("../constants/settings");
 const dependencyRule = require("../rules-factories/dependency-rule");
 
 const { dependencyLocation } = require("../helpers/rules");
+const { customErrorMessage, elementMessage } = require("../helpers/messages");
+
+function errorMessage(file, dependency, options) {
+  if (options.message) {
+    return customErrorMessage(options.message, file, dependency);
+  }
+  return `Dependency is private of element ${elementMessage(dependency.parents[0])}`;
+}
 
 module.exports = dependencyRule(
   {
@@ -15,12 +23,15 @@ module.exports = dependencyRule(
           allowUncles: {
             type: "boolean",
           },
+          message: {
+            type: "string",
+          },
         },
         additionalProperties: false,
       },
     ],
   },
-  function ({ dependency, node, context, options }) {
+  function ({ file, dependency, node, context, options }) {
     if (
       !dependency.isIgnored &&
       dependency.isLocal &&
@@ -32,7 +43,7 @@ module.exports = dependencyRule(
       (!options || !options.allowUncles || dependency.relationship !== "uncle")
     ) {
       context.report({
-        message: `Dependency is private of another element`,
+        message: errorMessage(file, dependency, options),
         node: node,
         ...dependencyLocation(node, context),
       });