File tree Expand file tree Collapse file tree 2 files changed +29
-2
lines changed Expand file tree Collapse file tree 2 files changed +29
-2
lines changed Original file line number Diff line number Diff line change
1
+ # Proton PHP Coding Standards
2
+
3
+ ## Installation & Usage
4
+
5
+ Install the package with composer
6
+
7
+ ``` sh
8
+ composer req protonlabs/php-coding-standard --dev
9
+ ```
10
+
11
+ To use it in your phpcs xml, add a rule pointing to the ruleset.xml
12
+
13
+ ``` xml
14
+ <?xml version =" 1.0" ?>
15
+ <ruleset name =" ProtonLabs PHP CodeSniffer Standard" >
16
+ <!-- Proton Coding Standard – https://github.com/ProtonMail/php-coding-standard -->
17
+ <rule ref =" vendor/protonlabs/php-coding-standard/Proton/ruleset.xml" >
18
+ <!-- sniffs to exclude -->
19
+ </rule >
20
+
21
+ <exclude-pattern >*/vendor/*</exclude-pattern >
22
+ </ruleset >
23
+ ```
Original file line number Diff line number Diff line change 1
1
{
2
- "name" : " proton /php-coding-standard" ,
2
+ "name" : " protonlabs /php-coding-standard" ,
3
3
"description" : " ProtonMail Coding Standard" ,
4
4
"type" : " phpcodesniffer-standard" ,
5
+ "keywords" : [
6
+ " php-codesniffer" , " coding-standard"
7
+ ],
8
+ "homepage" : " https://github.com/ProtonMail/php-coding-standard" ,
5
9
"minimum-stability" : " dev" ,
6
10
"prefer-stable" : true ,
7
11
"require" : {
8
12
"php" : " ^7.1" ,
9
13
"slevomat/coding-standard" : " ^4.8" ,
10
- "squizlabs/php_codesniffer" : " ^3.3.0 "
14
+ "squizlabs/php_codesniffer" : " ^3.3"
11
15
},
12
16
"license" : " MIT"
13
17
}
You can’t perform that action at this time.
0 commit comments