Skip to content

Default Ignored Values

Breno A edited this page May 16, 2024 · 1 revision

Default Ignored Values

Tip

PRP preprocessor is following the .gitignore spec 2.22.1. syntax

In the PRP-Preprocessor, there are certain default values that are ignored during the preprocessing. These values are set in the ignoredVars and ignoredDirs inputs of the action.

Ignored Variables

The ignoredVars input is used to specify variables that should be ignored during preprocessing. By default, this input is set to an empty string (""), which means no variables are ignored.

If you want to ignore certain variables, you can specify them in the ignoredVars input. For example:

ignoredVars: 'VARIABLE1,VARIABLE2'

In this example, VARIABLE1 and VARIABLE2 will be ignored during preprocessing.

Ignored Directories

The ignoredDirs input is used to specify directories that should be ignored during the file search. By default, this input is set to an empty string (""), which means no directories are ignored.

However, in the getInputParams function in the src/utils/VariableManager.ts file, certain directories are added to the ignoredDirs array:

const ignoredDir: string[] = core.getMultilineInput("ignoredDirs");
ignoredDir.push(...ignoredDefault);

The ignoredDefault array includes the following directories:

  • node_modules
  • .git
  • .github
  • __tests__
  • .vscode
  • .idea

These directories are ignored by default during the file search. If you want to ignore additional directories, you can specify them in the ignoredDirs input. For example:

ignoredDirs: 'dir1,dir2'

In this example, dir1 and dir2 will be ignored during the file search, in addition to the default ignored directories.

Clone this wiki locally