Skip to main content

Settings Reference

This section provides a complete reference of all available global settings for the plugin.

boundaries/elements​

Type: <array of element descriptors>

Required: Yes (for rules to work)

Defines element descriptors to recognize each file in the project as one of the defined element types. All rules need this setting to be configured properly.

export default [{
  settings: {
    "boundaries/elements": [
      {
        type: "helpers",
        pattern: "helpers/*/*.js",
        mode: "file",
        capture: ["category", "elementName"]
      }
    ]
  }
}]

boundaries/include​

Type: <array of strings>

Default: All files included

Files or dependencies not matching these micromatch patterns will be ignored by the plugin.

export default [{
  settings: {
    "boundaries/include": ["src/**/*.js"]
  }
}]

boundaries/ignore​

Type: <array of strings>

Default: No files ignored

Files or dependencies matching these micromatch patterns will be ignored by the plugin.

export default [{
  settings: {
    "boundaries/ignore": ["**/*.spec.js", "src/legacy-code/**/*"]
  }
}]
info

The boundaries/ignore option has precedence over boundaries/include. If you define boundaries/include, use boundaries/ignore to ignore subsets of included files.

boundaries/dependency-nodes​

Type: <array of strings>

Default: ["import"]

Modifies which built-in dependency nodes are analyzed. By default, only import statements are analyzed.

Available values:

  • 'import' - Analyze import statements
  • 'require' - Analyze require statements
  • 'export' - Analyze export statements
  • 'dynamic-import' - Analyze dynamic import statements (import())

All plugin rules will be applied to the nodes defined in this setting.

export default [{
  settings: {
    "boundaries/dependency-nodes": ["import", "dynamic-import"]
  }
}]
tip

For custom dependency nodes (like jest.mock(...)), use boundaries/additional-dependency-nodes.

boundaries/additional-dependency-nodes​

Type: <array of objects>

Default: []

Defines custom dependency nodes to analyze beyond the built-in ones. All plugin rules will be applied to nodes defined here in addition to the built-in ones defined in boundaries/dependency-nodes.

Object structure:

  • selector - The esquery selector for the Literal node where the dependency source is defined
  • kind - The dependency kind: "value" or "type" (available only with TypeScript)

Example:

export default [{
  settings: {
    "boundaries/additional-dependency-nodes": [
      // jest.requireActual('source')
      {
        selector: "CallExpression[callee.object.name=jest][callee.property.name=requireActual] > Literal",
        kind: "value",
      },
      // jest.mock('source', ...)
      {
        selector: "CallExpression[callee.object.name=jest][callee.property.name=mock] > Literal:first-child",
        kind: "value",
      },
    ],
  }
}]

boundaries/root-path​

Type: <string>

Default: process.cwd()

Defines the root path of the project. By default, the plugin uses the current working directory.

When to use: This setting is useful when executing the lint command from a different path than the project root, which may produce unexpected results with basePattern or full mode in element descriptors.

Example with ESM:

import { resolve } from "node:path";

export default [{
  settings: {
    "boundaries/root-path": resolve(import.meta.dirname)
  }
}]
warning

The path should be absolute and resolved before passing it to the plugin. Otherwise, it will be resolved using the current working directory.

Using environment variable:

ESLINT_PLUGIN_BOUNDARIES_ROOT_PATH=../../project-root npm run lint

You can provide either an absolute path or a relative path to the project root in the environment variable. Relative paths will be resolved from where the lint command is executed.

boundaries/cache​

Type: <boolean>

Default: true

Enables or disables the cache mechanism used to boost performance.

export default [{
  settings: {
    "boundaries/cache": true // or false to disable
  }
}]
tip

Recommendation: Keep cache enabled unless you experience issues. If you encounter problems, please open a github issue describing them.

import/resolver​

Type: <object>

Configures custom module resolution for the plugin, leveraging the same resolver infrastructure used by eslint-plugin-import (through the eslint-module-utils/resolve module), giving you access to a wide ecosystem of resolvers for different project setups.

info

Read more about configuring custom resolvers in the Custom Resolvers guide.

export default [{
  settings: {
    "import/resolver": {
      webpack: {
        config: "webpack.config.js"
      }
    }
  }
}];