Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Explain format of path list options #310

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -262,25 +262,31 @@ Minimal severity level of detected errors that will be reported. Valid values in

### scan-directory

List of relative paths to directories that will be scanned for shell scripts. Globbing is supported.
List of relative paths to directories that will be scanned for shell scripts. Globbing is supported. The list is a multi-line string, not a YAML list.

By default the whole repository is scanned. This feature is useful when you want to scan only a subset of the repository.

This feature is fully compatible with [exclude-path](#exclude-path) and [include-path](#include-path) options.

* requirements: `optional`
* example: `"build/**"`
* example for multiple values:
```
scan-directory: |
build/**
testing
```

### exclude-path

List of relative paths excluded from ShellCheck scanning. Globbing is supported.
List of relative paths excluded from ShellCheck scanning. Globbing is supported. The list is a multi-line string, not a YAML list.

* requirements: `optional`
* example: `"test/{bats,beakerlib}/**"`

### include-path

List of file paths that will be scanned by ShellCheck. Globbing is supported.
List of file paths that will be scanned by ShellCheck. Globbing is supported. The list is a multi-line string, not a YAML list.

* requirements: `optional`
* example: `"src/**.{shell,custom}"`
Expand Down
Loading