npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

@boundaries/elements

v2.0.0

Published

Element descriptors and matchers for @boundaries tools

Downloads

1,006,315

Readme

Build status Coverage Status Quality Gate

Renovate Last commit Last release

NPM downloads License

Mutation testing badge

@boundaries/elements

Element descriptors and matchers for @boundaries tools, such as @boundaries/eslint-plugin.

Table of Contents

Introduction

@boundaries/elements provides a powerful and flexible system for defining and enforcing architectural boundaries in your JavaScript and TypeScript projects. It allows you to:

  • Define element types based on file path patterns (e.g., components, services, helpers)
  • Match elements against specific criteria
  • Validate dependencies between different parts of your codebase
  • Enforce architectural rules by checking if dependencies between elements are allowed

This package is part of the @boundaries ecosystem and uses Micromatch patterns for flexible and powerful pattern matching.

[!NOTE] This package does not read or analyze your codebase directly. It provides the core logic for defining and matching elements and dependencies, which can be integrated into other tools such as linters or build systems.

Features

  • Flexible pattern matching using Micromatch syntax
  • 🎯 Element type and category identification based on file paths
  • 📝 Template variables for dynamic selector matching
  • Built-in caching for optimal performance
  • 🔄 Support for multiple file matching modes (file, folder, full path)
  • 🎨 Capture path fragments for advanced matching scenarios

Installation

Install the package via npm:

npm install @boundaries/elements

Quick Start

Here's a quick example to get you started:

import { Elements } from '@boundaries/elements';

// Create an Elements instance
const elements = new Elements();

// Define element descriptors
const matcher = elements.getMatcher([
  {
    type: "component",
    category: "react",
    pattern: "src/components/*.tsx",
    mode: "file",
    capture: ["fileName"],
  },
  {
    type: "service",
    category: "data",
    pattern: "src/services/*.ts",
    mode: "file",
    capture: ["fileName"],
  },
]);

// Match an element
const isComponent = matcher.isElementMatch("src/components/Button.tsx", { 
  type: "component" 
}); // true

// Match a dependency
const isValidDependency = matcher.isDependencyMatch(
  {
    from: "src/components/Button.tsx",
    to: "src/services/Api.ts",
    source: "../services/Api",
    kind: "value",
    nodeKind: "ImportDeclaration",
  },
  {
    from: { category: "react" },
    to: { type: "service" },
    dependency: { nodeKind: "ImportDeclaration" },
  }
); // true

Usage

Configuration Options

When creating an Elements instance, you can provide configuration options that will be used as defaults for all matchers:

const elements = new Elements({
  ignorePaths: ["**/dist/**", "**/build/**", "**/node_modules/**"],
  includePaths: ["src/**/*"],
  rootPath: "/absolute/path/to/project",
  flagAsExternal: {
    unresolvableAlias: true,
    inNodeModules: true,
    outsideRootPath: true,
    customSourcePatterns: ["@myorg/*"],
  },
});

Available options:

  • ignorePaths: Micromatch pattern(s) to exclude certain paths from element matching (default: none)
  • includePaths: Micromatch pattern(s) to include only specific paths (default: all paths)
  • legacyTemplates: Whether to enable legacy template syntax support (default: true, but it will be false in future releases). This allows using ${variable} syntax in templates for backward compatibility.
  • cache: Whether to enable internal caching to improve performance (default: true)
  • rootPath: Absolute path to the project root. When configured, file paths should be provided as absolute paths to allow the package to determine which files are outside the project root (default: undefined)
  • flagAsExternal: Configuration for categorizing dependencies as external or local. Multiple conditions can be specified, and dependencies will be categorized as external if ANY condition is met (OR logic). See Flagging Dependencies as External for details.

[!NOTE] Pattern Matching with rootPath: When rootPath is configured:

  • Matching patterns in element descriptors are relative to the rootPath. The package automatically converts absolute paths to relative paths internally for pattern matching.
  • In file and folder modes, patterns are evaluated right-to-left (from the end of the path), so the relativity to rootPath is typically less important. For example, a pattern like *.model.ts will match any file ending with .model.ts regardless of its location within rootPath.
  • In full mode, patterns must match the complete relative path from rootPath. Files outside rootPath maintain their absolute paths and require absolute patterns to match.

Creating a Matcher

Use the getMatcher method to create a matcher with element descriptors:

const matcher = elements.getMatcher([
  {
    type: "component",
    pattern: "src/components/*",
    mode: "folder",
  },
  {
    type: "helper",
    pattern: "src/helpers/*.js",
    mode: "file",
  }
]);

💡 Tip: Matchers with identical descriptors and options share the same cache instance for improved performance.

You can override the default options when creating a matcher:

const matcher = elements.getMatcher(
  [/* descriptors */],
  {
    ignorePaths: ["**/*.test.ts"],
  }
);

Element Descriptors

Element descriptors define how files are identified and categorized. Each descriptor is an object with the following properties:

  • pattern (string | string[]): Micromatch pattern(s) to match file paths
  • type (string): The element type to assign to matching files
  • category (string): Additional categorization for the element, providing another layer of classification
  • mode ("file" | "folder" | "full"): Matching mode (default: "folder")
    • "folder": Matches the first folder matching the pattern. The library will add **/* to the given pattern for matching files, because it needs to know exactly which folder has to be considered the element. So, you have to provide patterns matching the folder being the element, not the files directly.
    • "file": Matches files directly, but still matches progressively from the right. The provided pattern will not be modified.
    • "full": Matches the complete path.
  • basePattern (string): Additional pattern that must match from the project root. Use it when using file or folder modes and you want to capture fragments from the rest of the path.
  • capture (string[]): Array of keys to capture path fragments
  • baseCapture (string[]): Array of keys to capture fragments from basePattern. If the same key is defined in both capture and baseCapture, the value from capture takes precedence.

Descriptions API

The matcher can also return normalized runtime descriptions. These descriptions are the canonical API used by @boundaries/eslint-plugin and are useful for debugging, reporting, and custom tooling.

[!IMPORTANT] This section describes the output API of describeElement / describeDependency, which is different from the input API used by isDependencyMatch.

Element Description

matcher.describeElement(filePath) returns an object with normalized element metadata.

Common fields:

  • path: Absolute or relative file path used in the matcher call
  • type: Matched element type, or null if unknown
  • category: Matched element category, or null
  • captured: Captured values map from descriptor patterns, or null
  • elementPath: Path representing the detected element boundary, or null
  • internalPath: Path of the file relative to elementPath, or null
  • origin: One of "local" | "external" | "core"
  • isIgnored: Whether the file was excluded by ignorePaths / includePaths
  • isUnknown: Whether no descriptor matched

Additional fields for local known elements:

  • parents: Parent element chain, or null

Dependency Description

matcher.describeDependency(options) returns:

{
  from: ElementDescription,
  to: ElementDescription,
  dependency: {
    source: string,
    module: string | null,
    kind: "value" | "type" | "typeof",
    nodeKind: string | null,
    specifiers: string[] | null,
    relationship: {
      from: "internal" | "child" | "descendant" | "sibling" | "parent" | "uncle" | "nephew" | "ancestor" | null,
      to: "internal" | "child" | "descendant" | "sibling" | "parent" | "uncle" | "nephew" | "ancestor" | null,
    }
  }
}

Notes:

  • dependency.source is the raw import/export source string from code.
  • dependency.module is the normalized module base for external/core dependencies.
  • dependency.relationship.to describes how to relates to from.
  • dependency.relationship.from is the inverse perspective.
  • For unknown/ignored scenarios, some values can be null.

Example:

const description = matcher.describeDependency({
  from: "src/components/Button.tsx",
  to: "src/services/Api.ts",
  source: "../services/Api",
  kind: "value",
  nodeKind: "ImportDeclaration",
  specifiers: ["ApiClient"],
});

console.log(description.dependency.source); // "../services/Api"
console.log(description.dependency.kind); // "value"
console.log(description.dependency.relationship); // { from: ..., to: ... }

Selectors

Selectors are used to match elements and dependencies against specific criteria. They are objects where each property represents a matching condition.

Element Selectors

When matching elements, you can use element selectors that specify conditions on the element's properties.

Element selectors support the following properties:

  • type (string | string[]): Micromatch pattern(s) for the element type/s
  • category (string | string[]): Micromatch pattern(s) for the element category/categories
  • captured (object | object[]): Captured values selector. When provided as an object, all keys must match (AND logic). When provided as an array of objects, the element matches if any of the objects matches all keys (OR logic). Each key in the objects can be a string or an array of strings representing micromatch patterns.
  • parent (object | null): Selector for the first parent in the element description (parents[0]). Supported properties are:
    • type (string | string[]): Micromatch pattern(s) for parent type
    • category (string | string[]): Micromatch pattern(s) for parent category
    • elementPath (string | string[]): Micromatch pattern(s) for parent element path
    • captured (object | object[]): Parent captured values selector. Uses the same semantics as captured in the root selector (object = AND, array = OR)
  • origin ("local" | "external" | "core"): Element origin
    • local: Files within the project
    • external: External dependencies (e.g., node_modules)
    • core: Core modules (e.g., Node.js built-ins)
  • path (string | string[]): Micromatch pattern(s) for the file path
  • elementPath (string | string[]): Pattern(s) for the element path
  • internalPath (string | string[]): Pattern(s) for the path within the element. For file elements, it's the same as elementPath; for folder elements, it's relative to the folder.
  • isIgnored (boolean): Whether the element is ignored
  • isUnknown (boolean): Whether the element type is unknown (i.e., doesn't match any descriptor)

[!NOTE] All properties in the selector are optional. You can also use null values in selector to match only elements with null values in the corresponding properties. In the case of parent, setting it to null will match elements that have no parents (i.e., top-level elements). If parent is an object, it will only match elements that have at least one parent, and the first parent (parents[0]) matches the specified conditions.

Dependency Selectors

When matching dependencies, you can use dependency selectors that specify conditions on the source and target elements, as well as the dependency metadata.

  • from (element selector | element selector[]): Selector(s) for the source element
  • to (element selector | element selector[]): Selector(s) for the target element
  • dependency (object | object[]): Selector(s) for dependency metadata. When an array is provided, the dependency metadata matches if any selector in the array matches (OR logic). Supported selector properties:
    • kind (string | string[]): Micromatch pattern(s) for the dependency kind
    • relationship (object): Relationship selectors from both perspectives:
      • from (string | string[]): Relationship from the perspective of from
      • to (string | string[]): Relationship from the perspective of to
        • internal: Both files belong to the same element
        • child: Target is a child of source
        • parent: Target is a parent of source
        • sibling: Elements share the same parent
        • uncle: Target is a sibling of a source ancestor
        • nephew: Target is a child of a source sibling
        • descendant: Target is a descendant of source
        • ancestor: Target is an ancestor of source
    • specifiers (string | string[]): Pattern(s) for import/export specifiers (e.g., named imports)
    • nodeKind (string | string[]): Pattern(s) for the AST node type causing the dependency (e.g., "ImportDeclaration")
    • source (string | string[]): Pattern(s) to match the source of the dependency (e.g., the import path)
    • module (string | string[]): Pattern(s) for the base module name for external or core dependencies.

⚠️ Important: All properties in a selector must match for the selector to be considered a match (AND logic). Use multiple selectors for OR logic.

Note: You can also use the legacy selector syntax, but it’s deprecated and will be removed in a future release. See the Legacy Selectors section for more details.

Template Variables

Selectors support template variables using Handlebars syntax ({{ variableName }}). Templates are resolved at match time using:

  • Element properties (type, category, captured, etc.)
  • Dependency properties (from, to, dependency)

Available Template Data

When matching, the following data is automatically available:

For element matching:

  • Properties of the element under match are available in the element object (type, category, captured, origin, path, etc.)

For dependency matching:

  • from: Properties of the dependency source element
  • to: Properties of the dependency target element
  • dependency: Dependency metadata (kind, nodeKind, specifiers, source, module, relationship, etc.)

Template Examples

// Using captured values in templates
const matcher = elements.getMatcher([
  {
    type: "component",
    pattern: "src/modules/(*)/**/*.component.tsx",
    capture: ["module", "elementName", "fileName"],
    mode: "file"
  }
]);

// Match components from specific module using template
const isAuthComponent = matcher.isElementMatch(
  "src/modules/auth/LoginForm.component.tsx",
  { 
    type: "component",
    captured: { module: "{{ element.captured.module }}" } // This will always match
  },
);

// Using captured array for OR logic
const isAuthOrUserComponent = matcher.isElementMatch(
  "src/modules/auth/LoginForm.component.tsx",
  { 
    type: "component",
    captured: [
      { module: "auth" },      // Matches if module is "auth"
      { module: "user", fileName: "UserProfile" }       // OR if module is "user" and fileName is "UserProfile"
    ]
  },
);

// Using templates in dependency selectors
const isDependencyMatch = matcher.isDependencyMatch(
  {
    from: "src/components/Button.tsx",
    to: "src/services/Api.ts",
    source: "../services/Api",
    kind: "type",
    nodeKind: "ImportDeclaration",
    specifiers: ["calculateSum", "calculateAvg"],
  },
  {
    from: { type: "{{ from.type }}", captured: { fileName: "{{ from.captured.fileName }}" } },
    to: { path: "{{ to.path }}" },
    dependency: {
      specifiers: "{{ lookup dependency.specifiers 0 }}",
      kind: "{{ dependency.kind }}",
    },
  }
);

Using Extra Template Data

You can provide additional template data using the extraTemplateData option in MatcherOptions:

// Using templates in selectors
const isMatch = matcher.isElementMatch(
  "src/components/UserProfile.tsx",
  { type: "{{ componentType }}" },
  {
    extraTemplateData: { componentType: "component" }
  }
);

Using Matchers

You can use element selectors with a created matcher to check if a given path corresponds to an element with specific properties, or if a dependency between two paths matches certain criteria.

Element Matching

To match an element, use the isElementMatch method of the matcher, providing the file path and an element selector.

const isElementMatch = matcher.isElementMatch("src/components/Button.tsx", { type: "component" });

[!TIP] You can also provide an array of selectors to the isElementMatch method. In this case, the method will return true if the element matches any of the provided selectors (OR logic).

Dependency Matching

To match a dependency, use the isDependencyMatch method of the matcher, providing the properties of the dependency and a dependency selector.

Dependency object properties:

  • from (string): Source file path
  • to (string): Target file path
  • source (string): Import/export source as written in code
  • kind (string): Import kind ("type", "value", "typeof")
  • nodeKind (string): AST node kind
  • specifiers (string[]): Imported/exported names

Dependency selector:

  • from: Element selector(s) for the source file
  • to: Element selector(s) for the target file
  • dependency: Dependency metadata selector(s)
const isDependencyMatch = matcher.isDependencyMatch(
  { // Dependency properties
    from: "src/components/Button.tsx",
    to: "src/services/Api.ts",
    source: "../services/Api",
    kind: "type",
    nodeKind: "ImportDeclaration",
  },
  {
    from: { category: "react" }, // Dependency source selector/s
    to: { type: "service" }, // Dependency target selector/s
    dependency: [
      { nodeKind: "Import*" },
      { source: "@services/*" },
    ], // Dependency metadata selector/s (OR logic)
  }
);

[!TIP] You can also provide an array of selectors to from, to and dependency. The matcher will return true when all provided selector groups match.

Flagging Dependencies as External

The flagAsExternal configuration allows you to control how dependencies are categorized as external or local. This is especially useful in monorepo setups where you may want to treat inter-package dependencies as external even though they're within the same repository.

Multiple conditions can be specified, and dependencies will be flagged as external if ANY condition is met (OR logic).

Available Options

  • unresolvableAlias (boolean, default: true): Non-relative imports whose path cannot be resolved are categorized as external

    const elements = new Elements({
      flagAsExternal: { unresolvableAlias: true },
    });
    const matcher = elements.getMatcher([/* descriptors */]);
      
    // describeDependency({ from, to, source, kind }):
    // to: null, source: 'unresolved-module' -> origin: 'external'
    // to: '/project/src/Button.ts', source: './Button' -> origin: 'local'
  • inNodeModules (boolean, default: true): Non-relative paths that include node_modules in the resolved path are categorized as external

    const elements = new Elements({
      flagAsExternal: { inNodeModules: true },
    });
    const matcher = elements.getMatcher([/* descriptors */]);
      
    // describeDependency({ from, to, source, kind }):
    // to: '/project/node_modules/react/index.js', source: 'react' -> origin: 'external'
    // to: '/project/src/utils.ts', source: './utils' -> origin: 'local'
  • outsideRootPath (boolean, default: false): Dependencies whose resolved path is outside the configured rootPath are categorized as external. This is particularly useful in monorepo setups.

    ⚠️ Important: This option requires rootPath to be configured. When using this option, all file paths must be absolute and include the rootPath prefix for files within the project.

    const elements = new Elements({
      rootPath: '/monorepo/packages/app',
      flagAsExternal: { outsideRootPath: true },
    });
    const matcher = elements.getMatcher([/* descriptors */]);
      
    // describeDependency({ from, to, source, kind }):
    // to: '/monorepo/packages/shared/index.ts', source: '@myorg/shared' -> origin: 'external'
    // to: '/monorepo/packages/app/src/utils/helper.ts', source: './utils/helper' -> origin: 'local'
  • customSourcePatterns (string[], default: []): Array of micromatch patterns that, when matching the import/export source string, categorize the dependency as external

    const elements = new Elements({
      flagAsExternal: { customSourcePatterns: ['@myorg/*', '~/**'] },
    });
    const matcher = elements.getMatcher([/* descriptors */]);
      
    // describeDependency({ from, to, source, kind }):
    // source: '@myorg/shared' -> origin: 'external' (matches '@myorg/*')
    // source: '~/utils/helper' -> origin: 'external' (matches '~/**')
    // source: '@other/package' -> origin: 'local' (no match, unless inNodeModules is true or other conditions met)

Path Requirements with rootPath

When rootPath is configured, the package needs absolute paths to correctly determine which files are outside the project root, but matching patterns must remain relative to rootPath, especially in full mode (because file and folder modes match progressively from the right, so they may be less affected by relativity).

const elements = new Elements({
  rootPath: '/project/packages/app',
  flagAsExternal: {
    outsideRootPath: true,
  },
});

// Matching patterns are relative to rootPath
const matcher = elements.getMatcher([
  { type: 'component', pattern: 'src/**/*.ts', mode: 'full' }, // Relative to /project/packages/app
]);

// ✅ Correct: Using absolute file paths with relative patterns
const dep = matcher.describeDependency({
  from: '/project/packages/app/src/index.ts',      // absolute file path
  to: '/project/packages/shared/index.ts',         // absolute file path
  source: '@myorg/shared',
  kind: 'value',
});
// Result: dep.to.origin === 'external' (outside rootPath)
// Note: Pattern 'src/**/*.ts' matches because the package converts
// absolute paths to relative internally for pattern matching

// ❌ Incorrect: Using relative file paths (won't detect outsideRootPath correctly)
const dep2 = matcher.describeDependency({
  from: 'src/index.ts',                            // relative file path
  to: '../shared/index.ts',                        // relative file path
  source: '@myorg/shared',
  kind: 'value',
});
// Result: Won't correctly detect if outside rootPath

💡 Key Points:

  • File paths in API calls (from, to, filePath) must be absolute when using rootPath
  • Matching patterns in element descriptors stay relative to rootPath
  • The package handles the conversion internally
  • When not using rootPath, the package continues to work with relative paths as before, maintaining backward compatibility.

API Reference

Class: Elements

Constructor

Creates a new Elements instance with optional default configuration.

new Elements(options?: ConfigurationOptions);

Methods

getMatcher

Creates a new matcher instance.

  • Parameters:
    • descriptors: array<ElementDescriptor> Array of element descriptors to be used by the matcher.
    • options: ElementsOptions Optional. Configuration options for the matcher. These options will override the default options set in the Elements instance.
  • Returns: Matcher A new matcher instance.
const matcher = elements.getMatcher([
  {
    type: "component",
    pattern: "src/components/*",
    mode: "folder",
  },
  {
    type: "helper",
    pattern: "src/helpers/*.js",
    mode: "file",
  }
]);
clearCache

Clears all cached matcher instances and shared caches.

elements.clearCache();
serializeCache

Serializes all cached matcher instances and shared caches to a plain object.

const cache = elements.serializeCache();
setCacheFromSerialized

Sets the cached matcher instances and shared caches from a serialized object.

const cache = elements.serializeCache();
elements.setCacheFromSerialized(cache);

Matcher Instance Methods

isElementMatch

Checks if a given path matches an element selector.

const isElementMatch = matcher.isElementMatch("src/components/Button.tsx", [{ type: "component" }]);

isDependencyMatch

Checks if dependency properties match a dependency selector.

const isDependencyMatch = matcher.isDependencyMatch(
  {
    from: "src/components/Button.tsx",
    to: "src/services/Api.ts",
    source: "../services/Api",
    kind: "type",
    nodeKind: "ImportDeclaration",
  },
  {
    from: [{ category: "react" }],
    to: { type: "service" },
    dependency: { nodeKind: "Import*" },
  }
);

getElementSelectorMatching

Returns the first matching element selector or null.

const matchingSelector = matcher.getElementSelectorMatching("src/components/Button.tsx", [{ type: "component" }]);

getDependencySelectorMatching

Returns the dependency selector matching result (from, to, dependency, isMatch).

[!NOTE] This method provides detailed information about which part of the selector matched or didn't match. When arrays of selectors are provided in the from, to or dependency properties, the method will return the first selector that matches on each side, so the returned from, to and dependency will be the matching selector from each group.

const matchingSelector = matcher.getDependencySelectorMatching(
  {
    from: "src/components/Button.tsx",
    to: "src/services/Api.ts",
    source: "../services/Api",
    kind: "type",
  },
  {
    to: { type: "service" },
    dependency: { kind: "type" },
  }
);

describeElement

Returns a detailed description of an element.

const elementDescription = matcher.describeElement("src/components/Button.tsx");

describeDependency

Returns a detailed description of a dependency.

const dependencyDescription = matcher.describeDependency({
  from: "src/components/Button.tsx",
  to: "src/services/Api.ts",
  source: "../services/Api",
  kind: "type",
  nodeKind: "ImportDeclaration",
});

getElementSelectorMatchingDescription

Matches an element description against element selectors. As first argument, it should receive the result of describeElement.

As second argument, it should receive an array of element selectors. The method will return the first selector that matches the description or null if no selector matches.

const elementDescription = matcher.describeElement("src/components/Button.tsx");
const matchingSelector = matcher.getElementSelectorMatchingDescription(elementDescription, [{ type: "component" }]);

getDependencySelectorMatchingDescription

Matches a dependency description against dependency selectors. As first argument, it should receive the result of describeDependency.

As second argument, it should receive an array of dependency selectors. The method will return the first selector that matches the description or null if no selector matches.

[!NOTE] This method provides detailed information about which part of the selector matched or didn't match. When arrays of selectors are provided in the from, to or dependency properties in a dependency selector, the method will return the first selector that matches on each side, so the returned from, to and dependency will be the matching selector from each group.

const dependencyDescription = matcher.describeDependency({
  from: "src/components/Button.tsx",
  to: "src/services/Api.ts",
  source: "../services/Api",
  kind: "type",
  nodeKind: "ImportDeclaration",
});
const matchingSelector = matcher.getDependencySelectorMatchingDescription(dependencyDescription, [{ to: { type: "service" }, dependency: { kind: "type" } }]);

clearCache

Clears the matcher's internal cache.

matcher.clearCache();

[!WARNING] This only clears the internal cache for this matcher instance. Shared cache for micromatch results, regex and captures is not affected. You can clear all caches using Elements.clearCache().

serializeCache

Serializes the matcher's cache.

const cache = matcher.serializeCache();

setCacheFromSerialized

Restores the matcher's cache from a serialized object.

// Serialize cache to a serializable object
const cache = matcher.serializeCache();

// Clear current cache
matcher.clearCache();

// Restore cache from serialized object
matcher.setCacheFromSerialized(cache);

Legacy Selectors

Legacy selectors are defined using a different syntax and are provided for backward compatibility. However, this syntax is deprecated and will be removed in a future release. It is recommended to migrate to the new selector syntax.

Selectors can be defined as either a string or an array of strings representing the element type(s):

// Legacy selector using a string
const isElementMatch = matcher.isElementMatch("src/components/Button.tsx", "component");
// Legacy selector using an array of strings
const isElementMatch = matcher.isElementMatch("src/components/Button.tsx", ["component", "service"]);

They can also be defined as an array where the first element is the type and the second element is an object containing captured values:

// Legacy selector with captured values
const isElementMatch = matcher.isElementMatch(
  "src/modules/auth/LoginForm.component.tsx",
  ["component", { foo: "auth" }]
);

⚠️ Warning: Avoid mixing legacy selectors with the new selector syntax in the same project, as this can lead to ambiguity. In particular, if you define a top-level array selector with two elements and the second one is an object containing a type or category key, it will be interpreted as legacy options rather than two separate selectors.

Contributing

Contributors are welcome. Please read the contributing guidelines and code of conduct.

License

MIT, see LICENSE for details.