@boundaries/eslint-plugin 5.2.0-beta.1 → 5.2.0

package/README.md

@@ -320,6 +320,18 @@ You can also provide an absolute path in the environment variable, but it may be
 
 </details>
 
+#### __`boundaries/cache`__
+
+Enable or disable the cache mechanism used to boost performance. By default, it is enabled. We recommend to keep it enabled unless you experience issues. In such case, please, open an issue describing the problem.
+
+```js
+export default [{
+  settings: {
+    "boundaries/cache": true // or false to disable the cache
+  }
+}]
+```
+
 ### Predefined configurations
 
 The plugin is distributed with two different predefined configurations: "recommended" and "strict".

package/dist/Elements/Elements.js

@@ -21,6 +21,7 @@ function getElementsMatcher(settings) {
         ignorePaths: settings.ignorePaths,
         includePaths: settings.includePaths,
         legacyTemplates: settings.legacyTemplates,
+        cache: settings.cache,
     });
     return elementsMatcher;
 }

package/dist/Rules/ElementTypes.js

@@ -26,8 +26,8 @@ function createSafeMatcherFunction(dependencyDescription, matcher) {
             });
         }
         catch (error) {
-            (0, Support_1.warnOnce)(`Error occurred while matching dependency: ${String(error)}`);
-            return { isMatch: false };
+            (0, Support_1.warnOnce)(`Error occurred while matching dependency with selector ${JSON.stringify(dependencySelector)}: ${String(error)}`);
+            return { isMatch: false, from: null, to: null };
         }
     };
 }
@@ -65,17 +65,20 @@ function createRuleMatchContext(rule, dependencyDescription) {
  */
 function evaluatePolicyMatches(rule, context, isMatch, settings) {
     const { targetElementDirection, policyElementDirection, denyKeyToUse, capturedValuesTemplateData, dependencySelectorsGlobals, targetElementSelector, } = context;
+    const templateData = settings.legacyTemplates
+        ? capturedValuesTemplateData
+        : {};
     const disallowPolicyMatches = rule[denyKeyToUse]
         ? isMatch({
             [targetElementDirection]: targetElementSelector,
             [policyElementDirection]: rule[denyKeyToUse],
-        }, settings.legacyTemplates ? capturedValuesTemplateData : {}, dependencySelectorsGlobals)
+        }, templateData, dependencySelectorsGlobals)
         : { isMatch: false };
     const allowPolicyMatches = !disallowPolicyMatches.isMatch && rule.allow
         ? isMatch({
             [targetElementDirection]: targetElementSelector,
             [policyElementDirection]: rule.allow,
-        }, settings.legacyTemplates ? capturedValuesTemplateData : {}, dependencySelectorsGlobals)
+        }, templateData, dependencySelectorsGlobals)
         : { isMatch: false };
     return { disallowPolicyMatches, allowPolicyMatches };
 }
@@ -220,6 +223,13 @@ function elementRulesAllowDependency(dependency, settings, ruleOptions = {}) {
     const rulesResults = getRulesResults(ruleOptions, dependency, matcher, settings);
     const { isAllowed, ruleIndexMatching } = determineRuleResult(rulesResults);
     const finalIsAllowed = ruleIndexMatching === null ? defaultIsAllowed : isAllowed;
+    if (finalIsAllowed) {
+        return {
+            result: finalIsAllowed,
+            ruleReport: null,
+            report: null,
+        };
+    }
     const message = getRuleMessage(ruleIndexMatching, ruleOptions);
     const ruleReport = createRuleReport(ruleIndexMatching, message, dependency, rulesResults);
     const reportPath = getReportPath(ruleIndexMatching, rulesResults, dependency);

package/dist/Rules/External.js

@@ -98,6 +98,7 @@ exports.default = (0, Support_2.dependencyRule)({
         (0, elements_1.isCoreDependencyElement)(dependency.to)) {
         const adaptedRuleOptions = {
             ...options,
+            // @ts-expect-error TODO: Fix type
             rules: options && options.rules
                 ? options.rules.map((rule) => ({
                     ...rule,

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

@@ -114,6 +114,7 @@ export declare const SETTINGS: {
     readonly DEPENDENCY_NODES: "boundaries/dependency-nodes";
     readonly ADDITIONAL_DEPENDENCY_NODES: "boundaries/additional-dependency-nodes";
     readonly LEGACY_TEMPLATES: "boundaries/legacy-templates";
+    readonly CACHE: "boundaries/cache";
     readonly DEBUG: "ESLINT_PLUGIN_BOUNDARIES_DEBUG";
     readonly ENV_ROOT_PATH: "ESLINT_PLUGIN_BOUNDARIES_ROOT_PATH";
     readonly RULE_ELEMENT_TYPES: "boundaries/element-types";
@@ -173,11 +174,16 @@ export declare const SETTINGS_KEYS_MAP: {
     readonly TYPES: "boundaries/types";
     /** @deprecated Use import/resolver settings instead */
     readonly ALIAS: "boundaries/alias";
+    readonly CACHE: "boundaries/cache";
 };
 /**
  * Default value for the legacy templates setting.
  */
 export declare const LEGACY_TEMPLATES_DEFAULT: true;
+/**
+ * Default value for the cache setting.
+ */
+export declare const CACHE_DEFAULT: true;
 /**
  * Valid keys for the plugin settings.
  */
@@ -250,6 +256,8 @@ export type Settings = {
     [SETTINGS_KEYS_MAP.TYPES]?: ElementDescriptors;
     /** @deprecated Use "import/resolver" setting instead */
     [SETTINGS_KEYS_MAP.ALIAS]?: AliasSetting;
+    /** Whether to enable caching for the plugin analysis */
+    [SETTINGS_KEYS_MAP.CACHE]?: boolean;
 };
 /**
  * Normalized settings for the eslint-plugin-boundaries plugin.
@@ -270,6 +278,8 @@ export type SettingsNormalized = {
     dependencyNodes: DependencyNodeSelector[];
     /** Whether legacy template syntax support is enabled */
     legacyTemplates: boolean;
+    /** Whether caching is enabled */
+    cache: boolean;
 };
 /**
  * Eslint boundaries plugin rules.

package/dist/Settings/Settings.types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RULE_POLICIES_MAP = exports.RULE_POLICY_DISALLOW = exports.RULE_POLICY_ALLOW = exports.LEGACY_TEMPLATES_DEFAULT = exports.SETTINGS_KEYS_MAP = exports.SETTINGS = exports.DEPENDENCY_NODE_KEYS_MAP = exports.FROM = exports.RULE_SHORT_NAMES = exports.RULE_NAMES = exports.RULE_NAMES_MAP = exports.RULE_SHORT_NAMES_MAP = exports.NO_UNKNOWN = exports.NO_UNKNOWN_FILES = exports.NO_PRIVATE = exports.NO_IGNORED = exports.EXTERNAL = exports.ENTRY_POINT = exports.ELEMENT_TYPES = exports.DEPENDENCY_NODE_EXPORT = exports.DEPENDENCY_NODE_DYNAMIC_IMPORT = exports.DEPENDENCY_NODE_IMPORT = exports.DEPENDENCY_NODE_REQUIRE = exports.PLUGIN_ISSUES_URL = exports.REPO_URL = exports.PLUGIN_ENV_VARS_PREFIX = exports.PLUGIN_NAME = void 0;
+exports.RULE_POLICIES_MAP = exports.RULE_POLICY_DISALLOW = exports.RULE_POLICY_ALLOW = exports.CACHE_DEFAULT = exports.LEGACY_TEMPLATES_DEFAULT = exports.SETTINGS_KEYS_MAP = exports.SETTINGS = exports.DEPENDENCY_NODE_KEYS_MAP = exports.FROM = exports.RULE_SHORT_NAMES = exports.RULE_NAMES = exports.RULE_NAMES_MAP = exports.RULE_SHORT_NAMES_MAP = exports.NO_UNKNOWN = exports.NO_UNKNOWN_FILES = exports.NO_PRIVATE = exports.NO_IGNORED = exports.EXTERNAL = exports.ENTRY_POINT = exports.ELEMENT_TYPES = exports.DEPENDENCY_NODE_EXPORT = exports.DEPENDENCY_NODE_DYNAMIC_IMPORT = exports.DEPENDENCY_NODE_IMPORT = exports.DEPENDENCY_NODE_REQUIRE = exports.PLUGIN_ISSUES_URL = exports.REPO_URL = exports.PLUGIN_ENV_VARS_PREFIX = exports.PLUGIN_NAME = void 0;
 // Plugin constants
 exports.PLUGIN_NAME = "boundaries";
 exports.PLUGIN_ENV_VARS_PREFIX = "ESLINT_PLUGIN_BOUNDARIES";
@@ -94,6 +94,7 @@ exports.SETTINGS = {
     DEPENDENCY_NODES: `${exports.PLUGIN_NAME}/dependency-nodes`,
     ADDITIONAL_DEPENDENCY_NODES: `${exports.PLUGIN_NAME}/additional-dependency-nodes`,
     LEGACY_TEMPLATES: `${exports.PLUGIN_NAME}/legacy-templates`,
+    CACHE: `${exports.PLUGIN_NAME}/cache`,
     // env vars
     DEBUG: `${exports.PLUGIN_ENV_VARS_PREFIX}_DEBUG`,
     ENV_ROOT_PATH: `${exports.PLUGIN_ENV_VARS_PREFIX}_ROOT_PATH`,
@@ -174,11 +175,16 @@ exports.SETTINGS_KEYS_MAP = {
     TYPES: exports.SETTINGS.TYPES,
     /** @deprecated Use import/resolver settings instead */
     ALIAS: exports.SETTINGS.ALIAS,
+    CACHE: exports.SETTINGS.CACHE,
 };
 /**
  * Default value for the legacy templates setting.
  */
 exports.LEGACY_TEMPLATES_DEFAULT = true;
+/**
+ * Default value for the cache setting.
+ */
+exports.CACHE_DEFAULT = true;
 exports.RULE_POLICY_ALLOW = "allow";
 exports.RULE_POLICY_DISALLOW = "disallow";
 /**

package/dist/Settings/Validations.d.ts

@@ -126,6 +126,7 @@ 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;
 /**
  * Returns the normalized settings from the ESLint rule context
@@ -134,4 +135,3 @@ export declare function validateSettings(settings: Rule.RuleContext["settings"])
  */
 export declare function getSettings(context: Rule.RuleContext): SettingsNormalized;
 export declare function validateRules(settings: SettingsNormalized, rules?: RuleOptionsRules[], options?: ValidateRulesOptions): void;
-export declare function isValidElementAssigner(element: unknown): element is ElementDescriptor;

package/dist/Settings/Validations.js

@@ -6,10 +6,10 @@ 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;
-exports.isValidElementAssigner = isValidElementAssigner;
 const elements_1 = require("@boundaries/elements");
 const micromatch_1 = __importDefault(require("micromatch"));
 const Common_1 = require("../Support/Common");
@@ -18,7 +18,6 @@ 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 settingsCache = new elements_1.CacheManager();
 const invalidMatchers = [];
 const DEFAULT_MATCHER_OPTIONS = {
     type: "object",
@@ -113,7 +112,7 @@ function isValidElementTypesMatcher(matcher, settings) {
     const typeMatcherToCheck = (0, Common_1.isString)(matcherToCheck)
         ? matcherToCheck
         : matcherToCheck.type;
-    return (!matcher ||
+    return (!typeMatcherToCheck ||
         (typeMatcherToCheck &&
             micromatch_1.default.some(settings.elementTypeNames, typeMatcherToCheck)));
 }
@@ -128,6 +127,43 @@ function validateElementTypesMatcher(elementsMatcher, settings) {
         (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`);
+        return false;
+    }
+    if ((0, Helpers_1.isLegacyType)(element)) {
+        (0, Debug_1.warnOnce)(`Defining elements as strings in settings is deprecated. Will be automatically converted, but this feature will be removed in next major versions`);
+        return true;
+    }
+    else {
+        const isObjectElement = (0, Common_1.isObject)(element);
+        if (!isObjectElement) {
+            (0, Debug_1.warnOnce)(`Please provide a valid object to define element types in '${ELEMENTS}' setting`);
+            return false;
+        }
+        if (!element.type || !(0, Common_1.isString)(element.type)) {
+            (0, Debug_1.warnOnce)(`Please provide type in '${ELEMENTS}' setting`);
+            return false;
+        }
+        if (element.mode &&
+            (0, Common_1.isString)(element.mode) &&
+            !VALID_MODES.includes(element.mode)) {
+            (0, Debug_1.warnOnce)(`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`);
+            return false;
+        }
+        if (!element.pattern ||
+            !((0, Common_1.isString)(element.pattern) || (0, Common_1.isArray)(element.pattern))) {
+            (0, Debug_1.warnOnce)(`Please provide a valid pattern to type ${element.type} in '${ELEMENTS}' setting`);
+            return false;
+        }
+        if (element.capture && !(0, Common_1.isArray)(element.capture)) {
+            (0, Debug_1.warnOnce)(`Invalid capture property of type ${element.type} in '${ELEMENTS}' setting`);
+            return false;
+        }
+        return true;
+    }
+}
 function validateElements(elements) {
     if (!elements || !(0, Common_1.isArray)(elements) || !elements.length) {
         (0, Debug_1.warnOnce)(`Please provide element types using the '${ELEMENTS}' setting`);
@@ -171,8 +207,6 @@ legacyTemplates) {
         return legacyTemplates;
     }
     (0, Debug_1.warnOnce)(`Please provide a valid value in '${Settings_types_1.SETTINGS_KEYS_MAP.LEGACY_TEMPLATES}' setting. The value should be a boolean.`);
-    // Value is invalid, return undefined
-    return;
 }
 function isValidDependencyNodeSelector(selector) {
     const isValidObject = (0, Common_1.isObject)(selector) &&
@@ -237,6 +271,7 @@ 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.`);
 }
+// TODO: Remove settings validation in next major version. It should be done by schema validation only
 function validateSettings(settings) {
     deprecateTypes(settings[TYPES]);
     deprecateAlias(settings[ALIAS]);
@@ -248,6 +283,7 @@ function validateSettings(settings) {
         [Settings_types_1.SETTINGS_KEYS_MAP.DEPENDENCY_NODES]: validateDependencyNodes(settings[DEPENDENCY_NODES]),
         [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],
     };
 }
 /**
@@ -256,9 +292,6 @@ function validateSettings(settings) {
  * @returns The normalized settings
  */
 function getSettings(context) {
-    if (settingsCache.has(context.settings)) {
-        return settingsCache.get(context.settings);
-    }
     const validatedSettings = validateSettings(context.settings);
     const dependencyNodesSetting = (0, Common_1.getArrayOrNull)(validatedSettings[Settings_types_1.SETTINGS_KEYS_MAP.DEPENDENCY_NODES]);
     const additionalDependencyNodesSetting = (0, Common_1.getArrayOrNull)(validatedSettings[ADDITIONAL_DEPENDENCY_NODES]);
@@ -301,8 +334,8 @@ function getSettings(context) {
         dependencyNodes: [...dependencyNodes, ...additionalDependencyNodes],
         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,
     };
-    settingsCache.set(context.settings, result);
     return result;
 }
 function validateRules(settings, rules = [], options = {}) {
@@ -320,40 +353,3 @@ function validateRules(settings, rules = [], options = {}) {
         }
     }
 }
-function isValidElementAssigner(element) {
-    if (!element) {
-        (0, Debug_1.warnOnce)(`Please provide a valid object to define element types in '${ELEMENTS}' setting`);
-        return false;
-    }
-    if ((0, Helpers_1.isLegacyType)(element)) {
-        (0, Debug_1.warnOnce)(`Defining elements as strings in settings is deprecated. Will be automatically converted, but this feature will be removed in next major versions`);
-        return true;
-    }
-    else {
-        const isObjectElement = (0, Common_1.isObject)(element);
-        if (!isObjectElement) {
-            (0, Debug_1.warnOnce)(`Please provide a valid object to define element types in '${ELEMENTS}' setting`);
-            return false;
-        }
-        if (!element.type || !(0, Common_1.isString)(element.type)) {
-            (0, Debug_1.warnOnce)(`Please provide type in '${ELEMENTS}' setting`);
-            return false;
-        }
-        if (element.mode &&
-            (0, Common_1.isString)(element.mode) &&
-            !VALID_MODES.includes(element.mode)) {
-            (0, Debug_1.warnOnce)(`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`);
-            return false;
-        }
-        if (!element.pattern ||
-            !((0, Common_1.isString)(element.pattern) || (0, Common_1.isArray)(element.pattern))) {
-            (0, Debug_1.warnOnce)(`Please provide a valid pattern to type ${element.type} in '${ELEMENTS}' setting`);
-            return false;
-        }
-        if (element.capture && !(0, Common_1.isArray)(element.capture)) {
-            (0, Debug_1.warnOnce)(`Invalid capture property of type ${element.type} in '${ELEMENTS}' setting`);
-            return false;
-        }
-        return true;
-    }
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@boundaries/eslint-plugin",
-  "version": "5.2.0-beta.1",
+  "version": "5.2.0",
   "description": "Eslint plugin checking architecture boundaries between elements",
   "keywords": [
     "eslint",
@@ -53,7 +53,7 @@
     "eslint-import-resolver-node": "0.3.9",
     "eslint-module-utils": "2.12.1",
     "micromatch": "4.0.8",
-    "@boundaries/elements": "1.0.0"
+    "@boundaries/elements": "1.1.0"
   },
   "engines": {
     "node": ">=18.18"