@boundaries/eslint-plugin 5.3.0 → 5.4.0

package/dist/Elements/Elements.d.ts

@@ -16,7 +16,7 @@ export declare function getElementsMatcher(settings: SettingsNormalized): Matche
 export declare function getSpecifiers(node: Rule.Node): string[];
 /**
  * Returns the description of the current file being linted
- * @param fileName The file name
+ * @param fileName The file name (absolute path)
  * @param settings The ESLint rule context settings normalized
  * @returns The description of the current file being linted
  */
@@ -35,7 +35,7 @@ export declare function dependencyDescription({ node, kind, nodeKind, }: {
     /** The kind of the node generating the dependency */
     nodeKind?: string;
 }, 
-/** The file name */
+/** The file name (absolute path) */
 fileName: string, 
 /** The ESLint rule context settings normalized */
 settings: SettingsNormalized, 

package/dist/Elements/Elements.js

@@ -22,30 +22,11 @@ function getElementsMatcher(settings) {
         includePaths: settings.includePaths,
         legacyTemplates: settings.legacyTemplates,
         cache: settings.cache,
+        flagAsExternal: settings.flagAsExternal,
+        rootPath: settings.rootPath,
     });
     return elementsMatcher;
 }
-/**
- * Replaces backslashes with forward slashes in a given path
- * @param filePath The file path to modify
- * @returns The modified file path with forward slashes
- */
-function replacePathSlashes(filePath) {
-    return filePath.replaceAll("\\", "/");
-}
-/**
- * Transforms an absolute path into a project-relative path
- * @param absolutePath The absolute path to transform
- * @param rootPath The root path of the project
- * @returns The relative path from the project root
- */
-function projectPath(absolutePath, rootPath) {
-    if (absolutePath) {
-        // TODO: Use path.relative when possible. With caution because this would break current external paths
-        return replacePathSlashes(absolutePath).replace(`${replacePathSlashes(rootPath)}/`, "");
-    }
-    return "";
-}
 /**
  * Returns the specifiers used in an import or export statement
  * @param node The AST node representing the import or export
@@ -69,14 +50,13 @@ function getSpecifiers(node) {
 }
 /**
  * Returns the description of the current file being linted
- * @param fileName The file name
+ * @param fileName The file name (absolute path)
  * @param settings The ESLint rule context settings normalized
  * @returns The description of the current file being linted
  */
 function elementDescription(fileName, settings) {
     const matcher = getElementsMatcher(settings);
-    const path = projectPath(fileName, settings.rootPath);
-    const result = matcher.describeElement(path);
+    const result = matcher.describeElement(fileName);
     (0, Support_1.debugDescription)(result);
     return result;
 }
@@ -87,7 +67,7 @@ function elementDescription(fileName, settings) {
  * @returns The description of the dependency node
  */
 function dependencyDescription({ node, kind, nodeKind, }, 
-/** The file name */
+/** The file name (absolute path) */
 fileName, 
 /** The ESLint rule context settings normalized */
 settings, 
@@ -95,9 +75,10 @@ settings,
 context) {
     const source = String(node.value);
     const matcher = getElementsMatcher(settings);
+    const resolvedPath = (0, resolve_1.default)(source, context);
     const description = matcher.describeDependency({
-        from: projectPath(fileName, settings.rootPath),
-        to: projectPath((0, resolve_1.default)(source, context), settings.rootPath),
+        from: fileName,
+        to: resolvedPath || undefined,
         source,
         kind: kind || "value", // TODO: Change by runtime in a backwards compatible way
         nodeKind,

package/dist/Public/Rules.types.d.ts

@@ -1,5 +1,5 @@
 import type { DependencyKind } from "@boundaries/elements";
-export type { DependencyKind, CapturedValuesSelector, ElementSelector, ElementSelectors, ElementsSelector, ExternalLibrarySelectorOptions, ExternalLibrarySelectorWithOptions, ExternalLibrarySelector, ExternalLibrarySelectors, ExternalLibrariesSelector, ElementSelectorWithOptions, } from "@boundaries/elements";
+export type { DependencyKind, CapturedValuesSelector, ElementSelector, ElementSelectors, ElementsSelector, ExternalLibrarySelectorOptions, ExternalLibrarySelectorWithOptions, ExternalLibrarySelector, ExternalLibrarySelectors, ExternalLibrariesSelector, ElementSelectorWithOptions, FlagAsExternalOptions, } from "@boundaries/elements";
 export { isElementSelector, isElementsSelector, isExternalLibrarySelector, isExternalLibrariesSelector, } from "@boundaries/elements";
 export type { RulePolicy, RuleBaseOptions, ElementTypesRule, ElementTypesRuleOptions, EntryPointRule, EntryPointRuleOptions, ExternalRule, ExternalRuleOptions, NoPrivateOptions, RuleShortName, RuleName, } from "../Settings";
 export { RULE_POLICIES_MAP, isRulePolicy, RULE_SHORT_NAMES_MAP, RULE_NAMES_MAP, isRuleShortName, isRuleName, } from "../Settings";

package/dist/Rules/Support/DependencyRule.js

@@ -6,12 +6,6 @@ const Settings_1 = require("../../Settings");
 const Support_1 = require("../../Support");
 const Helpers_1 = require("./Helpers");
 const { ADDITIONAL_DEPENDENCY_NODES } = Settings_1.SETTINGS;
-function optionsHaveRules(options) {
-    if (!options) {
-        return false;
-    }
-    return Boolean(options.rules);
-}
 function dependencyRule(ruleMeta, rule, ruleOptions = {}) {
     return {
         ...(0, Helpers_1.meta)(ruleMeta),
@@ -22,9 +16,6 @@ function dependencyRule(ruleMeta, rule, ruleOptions = {}) {
             if (ruleOptions.validate !== false && !options) {
                 return {};
             }
-            if (ruleOptions.validate !== false && optionsHaveRules(options)) {
-                (0, Settings_1.validateRules)(settings, options.rules, ruleOptions.validateRules);
-            }
             // TODO: Remove this check when allowing to select by any other property
             if (file.isIgnored || !file.type) {
                 return {};

package/dist/Settings/Settings.types.d.ts

@@ -1,4 +1,4 @@
-import type { DependencyKind, ElementDescriptors, ElementsSelector, CapturedValues, ExternalLibrariesSelector } from "@boundaries/elements";
+import type { DependencyKind, ElementDescriptors, ElementsSelector, CapturedValues, ExternalLibrariesSelector, FlagAsExternalOptions } from "@boundaries/elements";
 import type { ESLint, Linter, Rule } from "eslint";
 export declare const PLUGIN_NAME: "boundaries";
 export declare const PLUGIN_ENV_VARS_PREFIX: "ESLINT_PLUGIN_BOUNDARIES";
@@ -116,6 +116,7 @@ export declare const SETTINGS: {
     readonly ADDITIONAL_DEPENDENCY_NODES: "boundaries/additional-dependency-nodes";
     readonly LEGACY_TEMPLATES: "boundaries/legacy-templates";
     readonly CACHE: "boundaries/cache";
+    readonly FLAG_AS_EXTERNAL: "boundaries/flag-as-external";
     readonly DEBUG: "ESLINT_PLUGIN_BOUNDARIES_DEBUG";
     readonly ENV_ROOT_PATH: "ESLINT_PLUGIN_BOUNDARIES_ROOT_PATH";
     readonly RULE_ELEMENT_TYPES: "boundaries/element-types";
@@ -176,6 +177,7 @@ export declare const SETTINGS_KEYS_MAP: {
     /** @deprecated Use import/resolver settings instead */
     readonly ALIAS: "boundaries/alias";
     readonly CACHE: "boundaries/cache";
+    readonly FLAG_AS_EXTERNAL: "boundaries/flag-as-external";
 };
 /**
  * Default value for the legacy templates setting.
@@ -259,6 +261,8 @@ export type Settings = {
     [SETTINGS_KEYS_MAP.ALIAS]?: AliasSetting;
     /** Whether to enable caching for the plugin analysis */
     [SETTINGS_KEYS_MAP.CACHE]?: boolean;
+    /** Configuration for categorizing dependencies as external or local */
+    [SETTINGS_KEYS_MAP.FLAG_AS_EXTERNAL]?: FlagAsExternalOptions;
 };
 /**
  * Normalized settings for the eslint-plugin-boundaries plugin.
@@ -281,6 +285,8 @@ export type SettingsNormalized = {
     legacyTemplates: boolean;
     /** Whether caching is enabled */
     cache: boolean;
+    /** Configuration for categorizing dependencies as external or local */
+    flagAsExternal: FlagAsExternalOptions;
 };
 /**
  * Eslint boundaries plugin rules.

package/dist/Settings/Settings.types.js

@@ -96,6 +96,7 @@ exports.SETTINGS = {
     ADDITIONAL_DEPENDENCY_NODES: `${exports.PLUGIN_NAME}/additional-dependency-nodes`,
     LEGACY_TEMPLATES: `${exports.PLUGIN_NAME}/legacy-templates`,
     CACHE: `${exports.PLUGIN_NAME}/cache`,
+    FLAG_AS_EXTERNAL: `${exports.PLUGIN_NAME}/flag-as-external`,
     // env vars
     DEBUG: `${exports.PLUGIN_ENV_VARS_PREFIX}_DEBUG`,
     ENV_ROOT_PATH: `${exports.PLUGIN_ENV_VARS_PREFIX}_ROOT_PATH`,
@@ -177,6 +178,7 @@ exports.SETTINGS_KEYS_MAP = {
     /** @deprecated Use import/resolver settings instead */
     ALIAS: exports.SETTINGS.ALIAS,
     CACHE: exports.SETTINGS.CACHE,
+    FLAG_AS_EXTERNAL: exports.SETTINGS.FLAG_AS_EXTERNAL,
 };
 /**
  * Default value for the legacy templates setting.

package/dist/Settings/Validations.d.ts

@@ -1,6 +1,6 @@
-import type { ElementsSelector, ExternalLibrariesSelector, ElementDescriptor } from "@boundaries/elements";
+import type { ElementDescriptor } from "@boundaries/elements";
 import type { Rule } from "eslint";
-import type { Settings, RuleMainKey, ValidateRulesOptions, RuleOptionsRules, SettingsNormalized } from "./Settings.types";
+import type { Settings, RuleMainKey, SettingsNormalized } from "./Settings.types";
 export declare function elementsMatcherSchema(matcherOptions?: Record<string, unknown>): {
     oneOf: ({
         type: string;
@@ -125,7 +125,6 @@ export declare function rulesOptionsSchema(options?: {
     };
     additionalProperties: boolean;
 }[];
-export declare function validateElementTypesMatcher(elementsMatcher: ElementsSelector | ExternalLibrariesSelector, settings: SettingsNormalized): void;
 export declare function isValidElementAssigner(element: unknown): element is ElementDescriptor;
 export declare function validateSettings(settings: Rule.RuleContext["settings"]): Settings;
 /**
@@ -134,4 +133,3 @@ export declare function validateSettings(settings: Rule.RuleContext["settings"])
  * @returns The normalized settings
  */
 export declare function getSettings(context: Rule.RuleContext): SettingsNormalized;
-export declare function validateRules(settings: SettingsNormalized, rules?: RuleOptionsRules[], options?: ValidateRulesOptions): void;

package/dist/Settings/Validations.js

@@ -1,24 +1,17 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.elementsMatcherSchema = elementsMatcherSchema;
 exports.rulesOptionsSchema = rulesOptionsSchema;
-exports.validateElementTypesMatcher = validateElementTypesMatcher;
 exports.isValidElementAssigner = isValidElementAssigner;
 exports.validateSettings = validateSettings;
 exports.getSettings = getSettings;
-exports.validateRules = validateRules;
 const elements_1 = require("@boundaries/elements");
-const micromatch_1 = __importDefault(require("micromatch"));
 const Common_1 = require("../Support/Common");
 const Debug_1 = require("../Support/Debug");
 const Helpers_1 = require("./Helpers");
 const Settings_1 = require("./Settings");
 const Settings_types_1 = require("./Settings.types");
 const { TYPES, ALIAS, ELEMENTS, DEPENDENCY_NODES, ADDITIONAL_DEPENDENCY_NODES, VALID_DEPENDENCY_NODE_KINDS, DEFAULT_DEPENDENCY_NODES, VALID_MODES, } = Settings_types_1.SETTINGS;
-const invalidMatchers = [];
 const DEFAULT_MATCHER_OPTIONS = {
     type: "object",
 };
@@ -107,26 +100,6 @@ function rulesOptionsSchema(options = {}) {
         },
     ];
 }
-function isValidElementTypesMatcher(matcher, settings) {
-    const matcherToCheck = (0, Common_1.isArray)(matcher) ? matcher[0] : matcher;
-    const typeMatcherToCheck = (0, Common_1.isString)(matcherToCheck)
-        ? matcherToCheck
-        : matcherToCheck.type;
-    return (!typeMatcherToCheck ||
-        (typeMatcherToCheck &&
-            micromatch_1.default.some(settings.elementTypeNames, typeMatcherToCheck)));
-}
-// TODO: Remove this validation. Selectors should not be limited to element types defined in settings when using selector objects
-function validateElementTypesMatcher(elementsMatcher, settings) {
-    const [matcher] = (0, Common_1.isArray)(elementsMatcher)
-        ? elementsMatcher
-        : [elementsMatcher];
-    if (!invalidMatchers.includes(matcher) &&
-        !isValidElementTypesMatcher(matcher, settings)) {
-        invalidMatchers.push(matcher);
-        (0, Debug_1.warnOnce)(`Option '${matcher}' does not match any element type from '${ELEMENTS}' setting`);
-    }
-}
 function isValidElementAssigner(element) {
     if (!element) {
         (0, Debug_1.warnOnce)(`Please provide a valid object to define element types in '${ELEMENTS}' setting`);
@@ -271,6 +244,50 @@ function validateRootPath(rootPath) {
     }
     (0, Debug_1.warnOnce)(`Please provide a valid value in '${Settings_types_1.SETTINGS_KEYS_MAP.ROOT_PATH}' setting. The value should be a string.`);
 }
+function validateFlagAsExternal(flagAsExternal) {
+    if (!flagAsExternal) {
+        return;
+    }
+    if (!(0, Common_1.isObject)(flagAsExternal)) {
+        (0, Debug_1.warnOnce)(`Please provide a valid value in '${Settings_types_1.SETTINGS_KEYS_MAP.FLAG_AS_EXTERNAL}' setting. The value should be an object.`);
+        return;
+    }
+    const validated = {};
+    if (flagAsExternal.unresolvableAlias !== undefined) {
+        if ((0, Common_1.isBoolean)(flagAsExternal.unresolvableAlias)) {
+            validated.unresolvableAlias = flagAsExternal.unresolvableAlias;
+        }
+        else {
+            (0, Debug_1.warnOnce)(`Please provide a valid boolean for 'unresolvableAlias' in '${Settings_types_1.SETTINGS_KEYS_MAP.FLAG_AS_EXTERNAL}' setting.`);
+        }
+    }
+    if (flagAsExternal.inNodeModules !== undefined) {
+        if ((0, Common_1.isBoolean)(flagAsExternal.inNodeModules)) {
+            validated.inNodeModules = flagAsExternal.inNodeModules;
+        }
+        else {
+            (0, Debug_1.warnOnce)(`Please provide a valid boolean for 'inNodeModules' in '${Settings_types_1.SETTINGS_KEYS_MAP.FLAG_AS_EXTERNAL}' setting.`);
+        }
+    }
+    if (flagAsExternal.outsideRootPath !== undefined) {
+        if ((0, Common_1.isBoolean)(flagAsExternal.outsideRootPath)) {
+            validated.outsideRootPath = flagAsExternal.outsideRootPath;
+        }
+        else {
+            (0, Debug_1.warnOnce)(`Please provide a valid boolean for 'outsideRootPath' in '${Settings_types_1.SETTINGS_KEYS_MAP.FLAG_AS_EXTERNAL}' setting.`);
+        }
+    }
+    if (flagAsExternal.customSourcePatterns !== undefined) {
+        if ((0, Common_1.isArray)(flagAsExternal.customSourcePatterns) &&
+            flagAsExternal.customSourcePatterns.every(Common_1.isString)) {
+            validated.customSourcePatterns = flagAsExternal.customSourcePatterns;
+        }
+        else {
+            (0, Debug_1.warnOnce)(`Please provide a valid array of strings for 'customSourcePatterns' in '${Settings_types_1.SETTINGS_KEYS_MAP.FLAG_AS_EXTERNAL}' setting.`);
+        }
+    }
+    return validated;
+}
 // TODO: Remove settings validation in next major version. It should be done by schema validation only
 function validateSettings(settings) {
     deprecateTypes(settings[TYPES]);
@@ -284,6 +301,7 @@ function validateSettings(settings) {
         [Settings_types_1.SETTINGS_KEYS_MAP.LEGACY_TEMPLATES]: validateLegacyTemplates(settings[Settings_types_1.SETTINGS_KEYS_MAP.LEGACY_TEMPLATES]),
         [Settings_types_1.SETTINGS_KEYS_MAP.ADDITIONAL_DEPENDENCY_NODES]: validateAdditionalDependencyNodes(settings[ADDITIONAL_DEPENDENCY_NODES]),
         [Settings_types_1.SETTINGS_KEYS_MAP.CACHE]: settings[Settings_types_1.SETTINGS_KEYS_MAP.CACHE],
+        [Settings_types_1.SETTINGS_KEYS_MAP.FLAG_AS_EXTERNAL]: validateFlagAsExternal(settings[Settings_types_1.SETTINGS_KEYS_MAP.FLAG_AS_EXTERNAL]),
     };
 }
 /**
@@ -335,21 +353,16 @@ function getSettings(context) {
         legacyTemplates: validatedSettings[Settings_types_1.SETTINGS_KEYS_MAP.LEGACY_TEMPLATES] ??
             Settings_types_1.LEGACY_TEMPLATES_DEFAULT,
         cache: validatedSettings[Settings_types_1.SETTINGS_KEYS_MAP.CACHE] ?? Settings_types_1.CACHE_DEFAULT,
+        flagAsExternal: {
+            unresolvableAlias: validatedSettings[Settings_types_1.SETTINGS_KEYS_MAP.FLAG_AS_EXTERNAL]
+                ?.unresolvableAlias ?? true,
+            inNodeModules: validatedSettings[Settings_types_1.SETTINGS_KEYS_MAP.FLAG_AS_EXTERNAL]?.inNodeModules ??
+                true,
+            outsideRootPath: validatedSettings[Settings_types_1.SETTINGS_KEYS_MAP.FLAG_AS_EXTERNAL]
+                ?.outsideRootPath ?? false,
+            customSourcePatterns: validatedSettings[Settings_types_1.SETTINGS_KEYS_MAP.FLAG_AS_EXTERNAL]
+                ?.customSourcePatterns ?? [],
+        },
     };
     return result;
 }
-function validateRules(settings, rules = [], options = {}) {
-    const mainKey = (0, Helpers_1.rulesMainKey)(options.mainKey);
-    for (const rule of rules) {
-        //@ts-expect-error TODO: Add a different schema validation for each rule type, so keys are properly validated
-        validateElementTypesMatcher([rule[mainKey]], settings);
-        if (!options.onlyMainKey) {
-            if (rule.allow) {
-                validateElementTypesMatcher(rule.allow, settings);
-            }
-            if (rule.disallow) {
-                validateElementTypesMatcher(rule.disallow, settings);
-            }
-        }
-    }
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@boundaries/eslint-plugin",
-  "version": "5.3.0",
+  "version": "5.4.0",
   "description": "Eslint plugin checking architecture boundaries between elements",
   "keywords": [
     "eslint",
@@ -53,14 +53,16 @@
     "eslint-import-resolver-node": "0.3.9",
     "eslint-module-utils": "2.12.1",
     "micromatch": "4.0.8",
-    "@boundaries/elements": "1.1.1"
+    "@boundaries/elements": "1.2.0"
   },
   "engines": {
     "node": ">=18.18"
   },
   "devDependencies": {
     "@types/estree": "1.0.8",
-    "@types/micromatch": "4.0.9"
+    "@types/micromatch": "4.0.9",
+    "eslint-plugin-eslint-plugin": "7.2.0",
+    "eslint-plugin-local-rules": "3.0.2"
   },
   "scripts": {
     "eslint": "eslint",