From 8f79998a9471e31876b87f10ba789d749110f464 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Vladim=C3=ADr=20Sl=C3=A1vik?= Date: Wed, 6 Sep 2023 11:19:03 +0200 Subject: [PATCH] doc: Explain format of path list options --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 21444e45..8f3ccda4 100644 --- a/README.md +++ b/README.md @@ -262,7 +262,7 @@ 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. @@ -270,17 +270,23 @@ This feature is fully compatible with [exclude-path](#exclude-path) and [include * 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}"`