Excluding Where Codux Looks for Components

The ignoredSubPaths key in Codux allows you to define an array of glob patterns representing paths that Codux should overlook during the project scanning process. This can be particularly useful if you wish to enhance the speed of component discovery by excluding certain sections of the project's file system.
Important!
Be careful of the files you choose to exlude, as ignoring files that are essential to Codux, rendered components, or their dependencies could result in unpredictable behavior.
Important!
Patterns should be defined relative to the root path of the project. For example: ./ignored/path/**.
1
2
3
4
5
6
7
8
9
10
{  
    "$schema": "https://wixplosives.github.io/codux-config-schema/codux.config.schema.json",
    "ignoredSubPaths": [
        "**/node_modules/**",
        "**/cjs/**",
        "**/esm/**",
        "**/dist/**",
        ".git/**"
    ]
}
Note:
Codux will ignore all sub-folders named node_modules because of the specified pattern **/node_modules/** in the configuration file above. To ignore only the node_modules folder in the project's root directory, we'd use the node_modules/** pattern instead.
Previous article
Next article