Filters

The Architect configuration file allows you to define filters in multiple ways to control whether certain files get actually added to the target.

The filters are:

• exclude (Exclusion of files, strongest)
• includeHidden (Inclusion of certain hidden files)
• conditionalFiles (Inclusion of files if a certain condition is true)
• templates (Which files to treat as templates and render, overrides nonTemplates)
• nonTemplates (Which files not to render as templates)

These filters have a precedence assigned to them, exclusions are the strongest. Files that match an exclusion rule are never added to the target. Hidden files can only be added through a condition if they have also been matched by an explicit includeHidden expression. If you include a hidden file, but a condition that matches it is false, it's not added to the target.

Keep in mind that the top-level .git directory cannot be matched by any of those filters and is always excluded from explicit processing. Architect handles that .git directory separately.

All filters use glob expressions that match the entire relative path to the root directory of the template.

Please see this for more information on the supported syntax for glob expressions (Architect enables the literal_separator option and case-insensitive matching).

Exclusions

Define glob expressions to match files you don't want to have in the target.

Include Hidden

Architect by default excludes all hidden files or directories. This only applies to files or directories starting with a dot (.) character, files marked as hidden in Windows will still be included.

Define glob expressions to match hidden files you want to include anyway.

Please keep in mind that you cannot include the top-level .git directory or any of its descendants using this.

Conditional Files

Architect will only include matched files if the specified condition returns a "truthy" result. Architect will evaluate all matching conditions in sequence until one returns a "truthy" value.

Here you define glob expressions to match files, and Handlebars expressions to determine whether these files should be included. These Handlebars expression don't need to be delimited by {{ and }}, and have full access to the context.

The glob expression will be applied to the file in the source repository, so before any possible Handlebars templates in file or directory names are evaluated.

Please keep in mind that when working with hidden files conditions can only be applied to files included using includeHidden.

Format in the configuration file:

// Config
    /**
     * Contains multiple filters to control which files are actually considered and rendered
     */
    filters?: Filters;

// Filters
    /**
     * Specifies conditions for certain files to be created.
     *
     * These conditions have full access to the context that is created by the questions.
     *
     * Note that conditions specified here don't apply to hidden files that weren't explicitly
     * included using `includeHidden` or files excluded using `exclude`
     */
    conditionalFiles?: ConditionalFiles[];

// ConditionalFiles
    /**
     * The condition that decides whether the matched files are created.
     *
     * This is an expression that is handled by handlebars.
     *
     * The expression is automatically wrapped in curly braces (`{{` `}}`) so you
     * only need to specify the actual content of the expression here
     */
    condition: string;
    /**
     * A Glob string specifying the files affected by the condition
     */
    matcher: string;

Templates

Define glob expressions to match files you want to have rendered as templates, this can be seen as an allow-list or whitelist that defines rendered files.

This leads to all other files not being rendered as Handlebars templates, instead they are copied as-is.

templates overrides nonTemplates, so even if you specify the latter it won't have any effect.

Non-Templates

Define glob expressions to match files you don't want to have rendered as templates, this can be seen as a deny-list or blacklist that defines non-rendered files.

Files that are matched by this are copied as-is instead of being rendered using Handlebars.

This property is ignored if templates is configured.