Skip to content

Commit 00975bb

Browse files
authored
Merge pull request #32 from abrinsibl/master
Removed "binary" executable as this adds maintenance overhead (depend…
2 parents 93f9b75 + 6c14b52 commit 00975bb

File tree

2 files changed

+4
-29
lines changed

2 files changed

+4
-29
lines changed

README.md

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# FLYERALARM PHP Coding Guideline Validator
22

3-
This repository contains the ruleset for the PHP code we develop at [FLYERALARM](https://flyeralarm.com).
3+
This repository contains the ruleset for the PHP code we develop at [FLYERALARM](https://flyeralarm.com).
44
It mostly consists of PSR-12 with some custom additions. The rules are enforced with the help of squizlabs/PHP_CodeSniffer
55

66
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”,
@@ -63,13 +63,6 @@ test:
6363
vendor/bin/phpcs -w -p -s --standard=vendor/flyeralarm/php-code-validator/ruleset.xml src/ tests/
6464
```
6565

66-
or in shorter version by using code validator binary which already use flyeralarm as default standard:
67-
```make
68-
test:
69-
vendor/bin/php-code-validator src/ tests/
70-
```
71-
72-
7366
### Add project specific rules
7467

7568
The recommended way to define custom rules for the own project is to provide a ```phpcs.xml``` in the root of your
@@ -85,9 +78,9 @@ This ```phpcs.xml``` can then reference the FLYERALARM PHP coding standard.
8578
<arg value="sp"/>
8679

8780
<rule ref="vendor/flyeralarm/php-code-validator/ruleset.xml"/>
88-
81+
8982
<!-- custom rules -->
90-
83+
9184
</ruleset>
9285
```
9386

@@ -113,7 +106,7 @@ make test
113106

114107
## Use within PHPStorm
115108

116-
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)
109+
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)
117110
2) Open settings: \
118111
Mac: `PhpStorm` > `Preferences` > `Editor` > `Inspections` > `PHP` \
119112
Windows & Linux: `File` > `Settings` > `Editor` > `Inspections` > `PHP` \

bin/php-code-validator

Lines changed: 0 additions & 18 deletions
This file was deleted.

0 commit comments

Comments
 (0)