php-censor/docs/en/plugins/lint.md

28 lines
713 B
Markdown
Raw Permalink Normal View History

2016-07-19 11:12:28 +02:00
Plugin Lint
2017-01-04 13:22:20 +01:00
===========
2016-07-19 11:12:28 +02:00
2016-07-17 16:20:35 +02:00
This plugin runs PHP's built in Lint (syntax / error check) functionality.
2016-07-19 11:12:28 +02:00
Configuration
2017-01-04 13:22:20 +01:00
-------------
2016-07-19 11:12:28 +02:00
2016-07-17 16:20:35 +02:00
### Options
2016-07-19 11:12:28 +02:00
2016-07-17 16:20:35 +02:00
- **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`.
2017-07-18 15:54:24 +02:00
- **recursive** [bool, optional] - Whether or not you want to recursively check sub-directories of the above (defaults
to true).
2016-07-17 16:20:35 +02:00
2016-07-19 11:12:28 +02:00
### Examples
2016-07-17 16:20:35 +02:00
```yml
test:
lint:
directory: "single path to lint files"
directories:
- "directory to lint files"
- "directory to lint files"
- "directory to lint files"
recursive: false
```