Skip to content

Commit

Permalink
docs: add filteringRule to the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@alirezanet
alirezanet committed Jun 16, 2024
1 parent 8bb0488 commit 919d1d5
Showing 1 changed file with 14 additions and 13 deletions.
27 changes: 14 additions & 13 deletions docs/guide/task-configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,20 @@

Each task in `task-runner.json` is a JSON object with the following properties:

| name | optional | type | default | description |
|----------|----------|--------------------------|------------------------|------------------------------------------------------------------------|
| command | false | string | - | path to the executable file or script or executable name |
| args | true | [string array] | - | command arguments |
| include | true | [array of glob] | `**/*` | glob pattern to select files |
| name | true | string | command | name of the task (recommended) |
| group | true | string | - | group of the task (usually it should be the hook name) |
| branch | true | string (regex) | - | run task on specific branches only |
| pathMode | true | [absolute, relative] | relative | file path style (relative or absolute) |
| cwd | true | string | project root directory | current working directory for the command, can be relative or absolute |
| output | true | [always, verbose, never] | always | output log level |
| exclude | true | [array of glob] | - | glob pattern to exclude files |
| windows | true | object | - | overrides all the above settings for windows |
| name | optional | type | default | description |
|---------------|----------|--------------------------|------------------------|------------------------------------------------------------------------|
| command | false | string | - | path to the executable file or script or executable name |
| args | true | [string array] | - | command arguments |
| include | true | [array of glob] | `**/*` | glob pattern to select files |
| name | true | string | command | name of the task (recommended) |
| group | true | string | - | group of the task (usually it should be the hook name) |
| branch | true | string (regex) | - | run task on specific branches only |
| pathMode | true | [absolute, relative] | relative | file path style (relative or absolute) |
| cwd | true | string | project root directory | current working directory for the command, can be relative or absolute |
| output | true | [always, verbose, never] | always | output log level |
| exclude | true | [array of glob] | - | glob pattern to exclude files |
| filteringRule | true | [variable, staged] | variable | match include/exclude against the used variables or git staged files |
| windows | true | object | - | overrides all the above settings for windows |

## Glob patterns

Expand Down

0 comments on commit 919d1d5

Please sign in to comment.