php-censor/docs/en/plugins/lint.md
2017-07-18 20:54:24 +07:00

28 lines
713 B
Markdown

Plugin Lint
===========
This plugin runs PHP's built in Lint (syntax / error check) functionality.
Configuration
-------------
### Options
- **directory** [string, optional] - A single path in which you wish to lint files.
- **directories** [array, optional] - An array of paths in which you wish to lint files. This overrides `directory`.
- **recursive** [bool, optional] - Whether or not you want to recursively check sub-directories of the above (defaults
to true).
### Examples
```yml
test:
lint:
directory: "single path to lint files"
directories:
- "directory to lint files"
- "directory to lint files"
- "directory to lint files"
recursive: false
```