Skip to content

Commit 33905bf

Browse files
committed
Updated Readme
1 parent 5596e64 commit 33905bf

File tree

1 file changed

+19
-14
lines changed

1 file changed

+19
-14
lines changed

README.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ It mostly consists of PSR-2 with some custom additions. The rules are enforced w
66

77

88
How-To
9-
-----------------
9+
------
1010
To prepare run command:
1111
```
1212
make
@@ -27,15 +27,19 @@ composer config repositories.flyeralarm/coding-guidelines git ssh://[email protected]
2727
composer require --dev flyeralarm/coding-guidelines
2828
```
2929

30-
Use this command to install:
30+
Embed code sniffer in your Makefile. To intend please use tabs instead of spaces. \
31+
_Usage:_ vendor/bin/fa-coding-guideline-validator <folder-to-test-one> <folder-to-test-two> <...>
3132
```
32-
composer update flyeralarm/coding-guidelines
33+
test:
34+
vendor/bin/fa-coding-guideline-validator src/ tests/
3335
```
3436

35-
Embed code sniffer in your Makefile. To intend please use tabs instead of spaces.
37+
38+
Update to latest stable
39+
-----------------------
40+
3641
```
37-
test:
38-
vendor/bin/fa-coding-guideline-validator src/ tests/
42+
composer update flyeralarm/coding-guidelines
3943
```
4044

4145

@@ -48,11 +52,12 @@ make test
4852

4953
Use within PHPStorm
5054
-------------------
51-
- Open settings: \
52-
Mac: `PhpStorm` > `Preferences` > `Editor` > `Inspections` > `PHP` \
53-
Windows: \<unknown>\
54-
Linux: \<unknown>
55-
- Activate Option `PHP Code Sniffer validation`
56-
- Choose "Custom" for „Coding standard:“ and click on `...` on the right hand side
57-
- Select Path to ruleset. This would be something like <YOUR_APP_ROOT>/vendor/flyeralarm/coding-guidelines/ruleset.xml
58-
- Confirm dialogs by pressing `ok`
55+
1) Ensure the path to PHP Code Sniffer is configured - [open configuration manual](https://confluence.jetbrains.com/display/PhpStorm/PHP+Code+Sniffer+in+PhpStorm#PHPCodeSnifferinPhpStorm-1.1.SpecifyingthepathtoPHPCodeSniffer)
56+
2) Open settings: \
57+
Mac: `PhpStorm` > `Preferences` > `Editor` > `Inspections` > `PHP` \
58+
Windows & Linux: `File` > `Settings` > `Editor` > `Inspections` > `PHP` \
59+
3) Activate/Tick checkbox for `PHP Code Sniffer validation`
60+
4) Click on the item `PHP Code Sniffer validation` to open its settings on the right hand side
61+
5) Choose "Custom" for „Coding standard:“ and click on `...` on the right hand side
62+
6) Select Path to ruleset. This would be something like <YOUR_APP_ROOT>/vendor/flyeralarm/coding-guidelines/ruleset.xml
63+
7) Confirm dialogs by pressing `ok`

0 commit comments

Comments
 (0)