Commit1059093

Christin Gruber

and

committed

Add docs for --config and --exclude options

Co-authored-by: Oskar Stark <oskarstark@googlemail.com>

1 parentcbffbe9 commit1059093Copy full SHA for 1059093

File tree

+24

-0

lines changed

+24

-0

lines changed

Lines changed: 24 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -430,6 +430,9 @@ Then, execute the script for validating contents:`
`430`	`430`	`# or all the files in multiple directories`
`431`	`431`	`$ php lint.php path/to/directory1 path/to/directory2`
`432`	`432`
	`433`	`+ # exclude specific files from directory`
	`434`	`+ $ php lint.php path/to/directory --exclude="path/to/directory/exclude.yml"`
	`435`	`+`
`433`	`436`	`# or contents passed to STDIN`
`434`	`437`	`$ cat path/to/file.yaml \| php lint.php`
`435`	`438`
@@ -440,6 +443,27 @@ Add the ``--format`` option to get the output in JSON format:
`440`	`443`
`441`	`444`	`$ php lint.php path/to/file.yaml --format json`
`442`	`445`
	`446`	`+The yaml linter can also be configured through the yaml config file. To do so, add`
	`447`	+the ``--config=CONFIG`` option to read the linter configuration from
	`448`	`+the given yaml linter config file:`
	`449`	`+`
	`450`	`+..code-block::terminal`
	`451`	`+`
	`452`	`+ $ php lint.php --config=.yamllint.yml`
	`453`	`+`
	`454`	`+Example contents of the .yamllint.yml config:`
	`455`	`+`
	`456`	`+..code-block::yaml`
	`457`	`+`
	`458`	`+parse-tags:false`
	`459`	`+format:txt`
	`460`	`+includes:`
	`461`	`+ -path/to/directory/foo.yml`
	`462`	`+ -path/to/directory/bar.yml`
	`463`	`+ -path/to/directory/foo/path`
	`464`	`+excludes:`
	`465`	`+ -path/to/directory/foo/path/exclude.yml`
	`466`	`+`
`443`	`467`	`..tip::`
`444`	`468`
`445`	`469`	`The linting command will also report any deprecations in the checked`

Comments

(0)