Skip to content

Commit beab873

Browse files
committed
Add configuration example (#7)
1 parent b6dca48 commit beab873

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

README.md

+36
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,39 @@
33
This plugin provides [phpcs](https://github.com/squizlabs/PHP_CodeSniffer) integration for phpcq.
44

55
It also provides a "fix" option, which runs [phpcbf](https://github.com/squizlabs/PHP_CodeSniffer) on the code base.
6+
7+
## Configuration
8+
9+
10+
Extend your `.phpcq.yaml.dist` configuration by adding the plugin and configuring the task:
11+
12+
```yaml
13+
phpcq:
14+
plugins:
15+
phpcs:
16+
version: ^1.0
17+
signed: false
18+
19+
tasks:
20+
phpcs:
21+
config: &phpcs-config
22+
# By default, PSR12 is used
23+
standard: ~
24+
standard_paths:
25+
- 'vendor/path/to/coding-standard'
26+
excluded:
27+
- 'some/excluded_path'
28+
excluded_sniffs:
29+
- 'Excludedniff'
30+
# Define paths which should be loaded when PHPCS is bootstrapping.
31+
# Useful for enhancement plugins which provides a coding standard
32+
autoload_paths:
33+
- 'vendor/autoload.php'
34+
35+
# The phpcbf tool is activated when activating the fix flag
36+
phpcbf:
37+
plugin: phpcs
38+
config:
39+
<<: *phpcs-config
40+
fix: true
41+
```

0 commit comments

Comments
 (0)