eslint-plugin-boundaries 3.3.0 → 3.4.0

package/README.md

@@ -228,6 +228,37 @@ Files or dependencies matching these [`micromatch` patterns](https://github.com/
 
 > Note: The `boundaries/include` option has preference over `boundaries/ignore`. If you define `boundaries/include`, use `boundaries/ignore` to ignore subsets of included files.
 
+#### __`boundaries/root-path`__
+
+Use this setting only if you are facing issues with the plugin when executing the lint command from a different path than the project root.
+
+<details>
+<summary>How to define the root path of the project</summary>
+
+By default, the plugin uses the current working directory (`process.cwd()`) as root path of the project. This path is used as the base path when resolving file matchers from rules and `boundaries/elements` settings. This is specially important when using the `basePattern` option or the `full` mode in the `boundaries/elements` setting. This may produce unexpected results [when the lint command is executed from a different path than the project root](https://github.com/javierbrea/eslint-plugin-boundaries/issues/296). To fix this, you can define a different root path using this option.
+
+For example, supposing that the `.eslintrc.js` file is located in the project root, you could define the root path as in:
+
+```js
+{
+  settings: {
+    "boundaries/root-path": path.resolve(__dirname)
+  }
+}
+```
+
+Note that the path should be absolute and resolved before passing it to the plugin. Otherwise, it will be resolved using the current working directory, and the problem will persist. In case you are defining the configuration in a `.eslintrc.(yml|json)` file, and you don't want to hardcode an absolute path, you can use the next environment variable to define the root path when executing the lint command:
+
+```bash
+ESLINT_PLUGIN_BOUNDARIES_ROOT_PATH=../../project-root npm run lint
+```
+
+You can also provide an absolute path in the environment variable, but it may be more useful to use a relative path to the project root. Remember that it will be resolved from the path where the lint command is executed.
+
+</details>
+
+
+
 ### Predefined configurations
 
 This plugin is distributed with two different predefined configurations: "recommended" and "strict".

package/package.json

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

package/src/constants/plugin.js

@@ -1,5 +1,7 @@
 const PLUGIN_NAME = "boundaries";
+const PLUGIN_ENV_VARS_PREFIX = "ESLINT_PLUGIN_BOUNDARIES";
 
 module.exports = {
   PLUGIN_NAME,
+  PLUGIN_ENV_VARS_PREFIX,
 };

package/src/constants/settings.js

@@ -1,4 +1,4 @@
-const { PLUGIN_NAME } = require("./plugin");
+const { PLUGIN_NAME, PLUGIN_ENV_VARS_PREFIX } = require("./plugin");
 
 const {
   ELEMENT_TYPES,
@@ -15,6 +15,11 @@ module.exports = {
   ELEMENTS: `${PLUGIN_NAME}/elements`,
   IGNORE: `${PLUGIN_NAME}/ignore`,
   INCLUDE: `${PLUGIN_NAME}/include`,
+  ROOT_PATH: `${PLUGIN_NAME}/root-path`,
+
+  // env vars
+  DEBUG: `${PLUGIN_ENV_VARS_PREFIX}_DEBUG`,
+  ENV_ROOT_PATH: `${PLUGIN_ENV_VARS_PREFIX}_ROOT_PATH`,
 
   // rules
   RULE_ELEMENT_TYPES: `${PLUGIN_NAME}/${ELEMENT_TYPES}`,

package/src/core/elementsInfo.js

@@ -3,7 +3,7 @@ const micromatch = require("micromatch");
 const resolve = require("eslint-module-utils/resolve").default;
 
 const { IGNORE, INCLUDE, VALID_MODES } = require("../constants/settings");
-const { getElements } = require("../helpers/settings");
+const { getElements, getRootPath } = require("../helpers/settings");
 const { debugFileInfo } = require("../helpers/debug");
 const { isArray } = require("../helpers/utils");
 
@@ -184,9 +184,9 @@ function replacePathSlashes(absolutePath) {
   return absolutePath.replace(/\\/g, "/");
 }
 
-function projectPath(absolutePath) {
+function projectPath(absolutePath, rootPath) {
   if (absolutePath) {
-    return replacePathSlashes(absolutePath).replace(`${replacePathSlashes(process.cwd())}/`, "");
+    return replacePathSlashes(absolutePath).replace(`${replacePathSlashes(rootPath)}/`, "");
   }
 }
 
@@ -195,7 +195,7 @@ function externalModulePath(source, baseModuleValue) {
 }
 
 function importInfo(source, context) {
-  const path = projectPath(resolve(source, context));
+  const path = projectPath(resolve(source, context), getRootPath(context.settings));
   const isExternalModule = isExternal(source, path);
   const resultCache = importsCache.load(isExternalModule ? source : path, context.settings);
   let elementCache;
@@ -237,7 +237,7 @@ function importInfo(source, context) {
 }
 
 function fileInfo(context) {
-  const path = projectPath(context.getFilename());
+  const path = projectPath(context.getFilename(), getRootPath(context.settings));
   const resultCache = filesCache.load(path, context.settings);
   let elementCache;
   let result;

package/src/helpers/debug.js

@@ -1,6 +1,7 @@
 const chalk = require("chalk");
 
 const { PLUGIN_NAME } = require("../constants/plugin");
+const { isDebugModeEnabled } = require("./settings");
 
 const warns = [];
 const debuggedFiles = [];
@@ -13,12 +14,6 @@ function warn(message) {
   trace(message, "yellow");
 }
 
-function debug(message) {
-  if (process.env.ESLINT_PLUGIN_BOUNDARIES_DEBUG) {
-    trace(message, "grey");
-  }
-}
-
 function success(message) {
   trace(message, "green");
 }
@@ -32,7 +27,7 @@ function warnOnce(message) {
 
 function debugFileInfo(fileInfo) {
   const fileInfoKey = fileInfo.path || fileInfo.source;
-  if (process.env.ESLINT_PLUGIN_BOUNDARIES_DEBUG && !debuggedFiles.includes(fileInfoKey)) {
+  if (isDebugModeEnabled() && !debuggedFiles.includes(fileInfoKey)) {
     debuggedFiles.push(fileInfoKey);
     if (fileInfo.type) {
       success(`'${fileInfoKey}' is of type '${fileInfo.type}'`);
@@ -44,7 +39,6 @@ function debugFileInfo(fileInfo) {
 }
 
 module.exports = {
-  debug,
   success,
   debugFileInfo,
   warnOnce,

package/src/helpers/settings.js

@@ -1,5 +1,13 @@
-const { TYPES, ELEMENTS, VALID_MODES } = require("../constants/settings");
+const {
+  TYPES,
+  ELEMENTS,
+  VALID_MODES,
+  ROOT_PATH,
+  ENV_ROOT_PATH,
+  DEBUG,
+} = require("../constants/settings");
 const { isString } = require("./utils");
+const { isAbsolute, resolve } = require("path");
 
 function isLegacyType(type) {
   return isString(type);
@@ -34,8 +42,24 @@ function getElementsTypeNames(settings) {
   return getElements(settings).map((element) => element.type);
 }
 
+function getRootPath(settings) {
+  const rootPathUserSetting = process.env[ENV_ROOT_PATH] || settings[ROOT_PATH];
+  if (rootPathUserSetting) {
+    return isAbsolute(rootPathUserSetting)
+      ? rootPathUserSetting
+      : resolve(process.cwd(), rootPathUserSetting);
+  }
+  return process.cwd();
+}
+
+function isDebugModeEnabled() {
+  return process.env[DEBUG];
+}
+
 module.exports = {
   isLegacyType,
   getElements,
   getElementsTypeNames,
+  isDebugModeEnabled,
+  getRootPath,
 };