├── .gitignore
├── LICENSE
├── README.md
├── composer.json
├── composer.lock
├── docs
    └── CONTRIBUTING.md
└── phpcs.xml


/.gitignore:
--------------------------------------------------------------------------------
1 | /vendor/
2 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2023 PatricNox (https://github.com/patricnox)
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # PHP CodeSniffer rules for Laravel coding style (PSR-2 variant)
 2 | 
 3 | [![MIT Licensed](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
 4 | [![PR friendly repository](https://img.shields.io/badge/Pull--Request-are%20welcome!-ff69b4)](/compare)
 5 | ![Follow Fossbarrow on Twitter](https://img.shields.io/twitter/follow/fossbarrow?style=social)
 6 | 
 7 | > Authored by fossbarrow IO
 8 | 
 9 | 
10 | [php codesniffer ruleset](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-Ruleset) for laravel projects.
11 | 
12 | ## Requirements
13 | 
14 | - https://github.com/squizlabs/PHP_CodeSniffer
15 | 
16 | ## Table of contents
17 | 
18 | - [How to install](#install)
19 |     - [Enabling the rules](#enabling-the-rules)
20 |     - [Sniffing code](#sniffing-code)
21 |     - [Sniffing code in PHPStorm](#sniffing-code-in-phpstorm)
22 | - [License](#license)
23 | - [Contributing](#contributing)
24 | - [Credits](#credits)
25 | 
26 | ## Installation
27 | Install the ruleset by
28 | 
29 | 1. Copy the `phpcs.xml` file into your project root with phpcs installed.
30 | 
31 | ## Usage
32 | 
33 | ### Enabling the rules
34 | 
35 | > Only neccesary if you installed as a package using composer!
36 | 
37 | Add it to your project `phpcs.xml` or `phpcs.xml.dist` ruleset:
38 | 
39 | ```xml
40 | <?xml version="1.0"?>
41 | <ruleset>
42 |     <arg name="basepath" value="."/>
43 | 
44 |     <file>./app</file>
45 |     <file>./config</file>
46 |     <file>./resources</file>
47 |     <file>./routes</file>
48 |     <file>./tests</file>
49 | 
50 |     <rule ref="./vendor/fossbarrow/laravel-phpcs/phpcs.xml"/>
51 | </ruleset>
52 | ```
53 | 
54 | ### Sniffing code
55 | Use php CodeSniffer commands, pointed towards your xml file, to sniff the code
56 | using the new ruleset.
57 | 
58 | > vendor/bin/phpcs
59 | > vendor/bin/phpcbf
60 | 
61 | #### Sniffing code in PHPStorm
62 | 
63 | See [PHP Code Sniffer in PhpStorm](https://confluence.jetbrains.com/display/PhpStorm/PHP+Code+Sniffer+in+PhpStorm) on how to set up CodeSniffer in PHPStorm.
64 | 
65 | --------------------------------------------------------------------------------
66 | 
67 | 
68 | ## Contributing
69 | 
70 | All changes that makes the sniffer more accurate towards _Laravel_'s coding standard
71 | is always highly appreciated and welcome. 
72 | 
73 | Please see [CONTRIBUTING](docs/CONTRIBUTING.md) for more details.
74 | 
75 | ## Credits
76 | 
77 | - [PatricNox](https://github.com/PatricNox)
78 | - [All Contributors](../../contributors)
79 | 
80 | ## License
81 | 
82 | The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
83 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "fossbarrow/laravel-phpcs",
 3 |     "description": "phpcs ruleset for laravel projects",
 4 |     "type": "phpcs-ruleset",
 5 |     "require-dev": {
 6 |         "php": "^7.4",
 7 |         "squizlabs/php_codesniffer": "^3.5.5"
 8 |     },
 9 |     "license": "MIT",
10 |     "authors": [
11 |         {
12 |             "name": "patricnox",
13 |             "email": "hello@patricnox.info"
14 |         }
15 |     ],
16 |     "minimum-stability": "stable"
17 | }
18 | 


--------------------------------------------------------------------------------
/composer.lock:
--------------------------------------------------------------------------------
 1 | {
 2 |     "_readme": [
 3 |         "This file locks the dependencies of your project to a known state",
 4 |         "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
 5 |         "This file is @generated automatically"
 6 |     ],
 7 |     "content-hash": "393187ab75a2f2a2c0040505c4f87e26",
 8 |     "packages": [],
 9 |     "packages-dev": [
10 |         {
11 |             "name": "squizlabs/php_codesniffer",
12 |             "version": "3.6.0",
13 |             "source": {
14 |                 "type": "git",
15 |                 "url": "https://github.com/squizlabs/PHP_CodeSniffer.git",
16 |                 "reference": "ffced0d2c8fa8e6cdc4d695a743271fab6c38625"
17 |             },
18 |             "dist": {
19 |                 "type": "zip",
20 |                 "url": "https://api.github.com/repos/squizlabs/PHP_CodeSniffer/zipball/ffced0d2c8fa8e6cdc4d695a743271fab6c38625",
21 |                 "reference": "ffced0d2c8fa8e6cdc4d695a743271fab6c38625",
22 |                 "shasum": ""
23 |             },
24 |             "require": {
25 |                 "ext-simplexml": "*",
26 |                 "ext-tokenizer": "*",
27 |                 "ext-xmlwriter": "*",
28 |                 "php": ">=5.4.0"
29 |             },
30 |             "require-dev": {
31 |                 "phpunit/phpunit": "^4.0 || ^5.0 || ^6.0 || ^7.0"
32 |             },
33 |             "bin": [
34 |                 "bin/phpcs",
35 |                 "bin/phpcbf"
36 |             ],
37 |             "type": "library",
38 |             "extra": {
39 |                 "branch-alias": {
40 |                     "dev-master": "3.x-dev"
41 |                 }
42 |             },
43 |             "notification-url": "https://packagist.org/downloads/",
44 |             "license": [
45 |                 "BSD-3-Clause"
46 |             ],
47 |             "authors": [
48 |                 {
49 |                     "name": "Greg Sherwood",
50 |                     "role": "lead"
51 |                 }
52 |             ],
53 |             "description": "PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.",
54 |             "homepage": "https://github.com/squizlabs/PHP_CodeSniffer",
55 |             "keywords": [
56 |                 "phpcs",
57 |                 "standards"
58 |             ],
59 |             "support": {
60 |                 "issues": "https://github.com/squizlabs/PHP_CodeSniffer/issues",
61 |                 "source": "https://github.com/squizlabs/PHP_CodeSniffer",
62 |                 "wiki": "https://github.com/squizlabs/PHP_CodeSniffer/wiki"
63 |             },
64 |             "time": "2021-04-09T00:54:41+00:00"
65 |         }
66 |     ],
67 |     "aliases": [],
68 |     "minimum-stability": "stable",
69 |     "stability-flags": [],
70 |     "prefer-stable": false,
71 |     "prefer-lowest": false,
72 |     "platform": [],
73 |     "platform-dev": {
74 |         "php": "^7.4"
75 |     },
76 |     "plugin-api-version": "2.0.0"
77 | }
78 | 


--------------------------------------------------------------------------------
/docs/CONTRIBUTING.md:
--------------------------------------------------------------------------------
 1 | # CONTRIBUTING
 2 | 
 3 | All changes that makes the sniffer more accurate towards _Laravel_'s coding standard
 4 | is always highly appreciated and welcome. 
 5 | 
 6 | ## WHAT IS LARAVEL'S CODING STANDARD?
 7 | 
 8 | Laravel is using their own variant of modified PSR-12. To dig deeper, look at Laravel source code and try to make rules that covers their standard.
 9 | 
10 | ## PULL-REQUESTS
11 | 
12 | Merged pull-requests will be squashed, meaning you don't have to bother writing
13 | proper commit messages.
14 | 
15 | ## CRITERIA
16 | 
17 | Please do **always** include some kind of proof that supports your change to the
18 | ruleset.
19 | 


--------------------------------------------------------------------------------
/phpcs.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0"?>
  2 | <ruleset name="Laravel Standards">
  3 |     <description>PSR-2 The Laravel conventions</description>
  4 |     <rule ref="Generic.Classes.DuplicateClassName">
  5 |         <exclude name="Generic.CodeAnalysis.EmptyStatement.DetectedIf"/>
  6 |     </rule>
  7 |     <rule ref="Generic.CodeAnalysis.EmptyStatement"/>
  8 |     <rule ref="Generic.CodeAnalysis.ForLoopShouldBeWhileLoop"/>
  9 |     <rule ref="Generic.CodeAnalysis.ForLoopWithTestFunctionCall"/>
 10 |     <rule ref="Generic.CodeAnalysis.JumbledIncrementer"/>
 11 |     <rule ref="Generic.CodeAnalysis.UnconditionalIfStatement"/>
 12 |     <rule ref="Generic.CodeAnalysis.UnnecessaryFinalModifier"/>
 13 |     <rule ref="Generic.CodeAnalysis.UnusedFunctionParameter">
 14 |         <exclude-pattern>/app/Http/Resources/*\.php</exclude-pattern>
 15 |     </rule>
 16 |     <rule ref="Generic.CodeAnalysis.UselessOverridingMethod"/>
 17 |     <rule ref="Generic.Commenting.DocComment">
 18 |         <exclude name="Generic.Commenting.DocComment.TagValueIndent"/>
 19 |         <exclude name="Generic.Commenting.DocComment.NonParamGroup"/>
 20 |     </rule>
 21 |     <rule ref="Generic.ControlStructures.InlineControlStructure"/>
 22 |     <rule ref="Generic.Files.ByteOrderMark"/>
 23 |     <rule ref="Generic.Files.LineEndings">
 24 |         <exclude name="Generic.Files.LineEndings.InvalidEOLChar"/>
 25 |     </rule>
 26 |     <rule ref="Generic.Formatting.DisallowMultipleStatements"/>
 27 |     <rule ref="Generic.Formatting.SpaceAfterCast"/>
 28 |     <rule ref="Generic.Functions.CallTimePassByReference"/>
 29 |     <rule ref="Generic.Functions.FunctionCallArgumentSpacing"/>
 30 |     <rule ref="Generic.Functions.OpeningFunctionBraceBsdAllman"/>
 31 |     <rule ref="Generic.Metrics.CyclomaticComplexity">
 32 |         <properties>
 33 |             <property name="complexity" value="20"/>
 34 |             <property name="absoluteComplexity" value="50"/>
 35 |         </properties>
 36 |     </rule>
 37 |     <rule ref="Generic.Metrics.NestingLevel">
 38 |         <properties>
 39 |             <property name="nestingLevel" value="5"/>
 40 |             <property name="absoluteNestingLevel" value="15"/>
 41 |         </properties>
 42 |     </rule>
 43 |     <rule ref="Generic.NamingConventions.ConstructorName"/>
 44 |     <rule ref="Generic.PHP.LowerCaseConstant"/>
 45 |     <rule ref="Generic.PHP.DeprecatedFunctions"/>
 46 |     <rule ref="Generic.PHP.DisallowShortOpenTag"/>
 47 |     <rule ref="Generic.PHP.ForbiddenFunctions"/>
 48 |     <rule ref="Generic.PHP.NoSilencedErrors"/>
 49 |     <rule ref="Generic.WhiteSpace.DisallowTabIndent"/>
 50 |     <rule ref="Generic.WhiteSpace.ScopeIndent">
 51 |         <properties>
 52 |             <property name="indent" value="4"/>
 53 |             <property name="tabIndent" value="true"/>
 54 |         </properties>
 55 |     </rule>
 56 |     <rule ref="MySource.PHP.EvalObjectFactory"/>
 57 |     <rule ref="PSR1.Classes.ClassDeclaration"/>
 58 |     <rule ref="PSR1.Files.SideEffects"/>
 59 |     <rule ref="PSR2.Classes.ClassDeclaration"/>
 60 |     <rule ref="PSR2.Classes.PropertyDeclaration"/>
 61 |     <rule ref="PSR2.ControlStructures.ControlStructureSpacing"/>
 62 |     <rule ref="PSR2.ControlStructures.ElseIfDeclaration"/>
 63 |     <rule ref="PSR2.ControlStructures.SwitchDeclaration"/>
 64 |     <rule ref="PSR2.Files.EndFileNewline"/>
 65 |     <rule ref="PSR2.Methods.MethodDeclaration"/>
 66 |     <rule ref="PSR2.Namespaces.NamespaceDeclaration"/>
 67 |     <rule ref="PSR2.Namespaces.UseDeclaration"/>
 68 |     <rule ref="PSR1">
 69 |         <exclude-pattern>*.php</exclude-pattern>
 70 |         <exclude name="PSR1.Methods.CamelCapsMethodName.NotCamelCaps"/>
 71 | 
 72 |         <exclude-pattern>database/*</exclude-pattern>
 73 |     </rule>
 74 |     <rule ref="PSR2">
 75 |         <exclude name="PSR2.ControlStructures.SwitchDeclaration.BodyOnNextLineCASE" />
 76 |     </rule>
 77 |     <rule ref="Squiz.Arrays.ArrayDeclaration">
 78 |         <exclude name="Squiz.Arrays.ArrayDeclaration.ValueNotAligned" />
 79 |         <exclude name="Squiz.Arrays.ArrayDeclaration.KeyNotAligned" />
 80 |         <exclude name="Squiz.Arrays.ArrayDeclaration.DoubleArrowNotAligned" />
 81 |         <exclude name="Squiz.Arrays.ArrayDeclaration.ValueNotAligned" />
 82 |         <exclude name="Squiz.Arrays.ArrayDeclaration.CloseBraceNotAligned" />
 83 |         <exclude name="Squiz.Arrays.ArrayDeclaration.ValueNoNewline" />
 84 |         <exclude name="Squiz.Arrays.ArrayDeclaration.MultiLineNotAllowed" />
 85 |         <exclude name="Squiz.Arrays.ArrayDeclaration.SingleLineNotAllowed" />
 86 |         <exclude name="Squiz.Functions.MultiLineFunctionDeclaration.NewlineBeforeOpenBrace" />
 87 |         <exclude name="Squiz.Arrays.ArrayDeclaration.NoKeySpecified" />
 88 |         <exclude name="Squiz.Arrays.ArrayDeclaration.KeySpecified" />
 89 |     </rule>
 90 |     <rule ref="Squiz.PHP.DisallowSizeFunctionsInLoops"/>
 91 |     <rule ref="Squiz.PHP.DiscouragedFunctions">
 92 |         <properties>
 93 |             <property name="error" value="true"/>
 94 |         </properties>
 95 |     </rule>
 96 |     <rule ref="Squiz.PHP.Eval"/>
 97 |     <rule ref="Squiz.PHP.GlobalKeyword"/>
 98 |     <rule ref="Squiz.PHP.LowercasePHPFunctions"/>
 99 |     <rule ref="Squiz.PHP.NonExecutableCode"/>
100 |     <rule ref="Squiz.Scope.MemberVarScope"/>
101 |     <rule ref="Squiz.Scope.MethodScope"/>
102 |     <rule ref="Squiz.Scope.StaticThisUsage"/>
103 |     <rule ref="Squiz.WhiteSpace.CastSpacing"/>
104 |     <rule ref="Squiz.WhiteSpace.LanguageConstructSpacing"/>
105 |     <rule ref="Squiz.WhiteSpace.LogicalOperatorSpacing"/>
106 |     <rule ref="Squiz.WhiteSpace.ObjectOperatorSpacing">
107 |         <properties>
108 |             <property name="ignoreNewlines" value="true"/>
109 |         </properties>
110 |     </rule>
111 |     <rule ref="Squiz.WhiteSpace.OperatorSpacing">
112 |         <properties>
113 |             <property name="ignoreNewlines" value="true"/>
114 |         </properties>
115 |     </rule>
116 |     <rule ref="Squiz.WhiteSpace.PropertyLabelSpacing"/>
117 |     <rule ref="Squiz.WhiteSpace.ScopeClosingBrace"/>
118 |     <rule ref="Squiz.WhiteSpace.ScopeKeywordSpacing"/>
119 |     <rule ref="Squiz.WhiteSpace.SemicolonSpacing"/>
120 |     <rule ref="Zend.Files.ClosingTag"/>
121 | 
122 |     <file>app</file>
123 |     <file>config</file>
124 |     <file>public</file>
125 |     <file>resources</file>
126 |     <file>routes</file>
127 |     <file->tests</file->
128 | 
129 |     <exclude-pattern>*/.phpstorm.meta.php</exclude-pattern>
130 |     <exclude-pattern>*/_ide_helper.php</exclude-pattern>
131 |     <exclude-pattern>*/database/*</exclude-pattern>
132 |     <exclude-pattern>*/cache/*</exclude-pattern>
133 |     <exclude-pattern>*/*.js</exclude-pattern>
134 |     <exclude-pattern>*/*.css</exclude-pattern>
135 |     <exclude-pattern>*/*.xml</exclude-pattern>
136 |     <exclude-pattern>*/*.blade.php</exclude-pattern>
137 |     <exclude-pattern>*/autoload.php</exclude-pattern>
138 |     <exclude-pattern>*/storage/*</exclude-pattern>
139 |     <exclude-pattern>*/docs/*</exclude-pattern>
140 |     <exclude-pattern>*/vendor/*</exclude-pattern>
141 |     <exclude-pattern>*/migrations/*</exclude-pattern>
142 |     <exclude-pattern>*/config/*</exclude-pattern>
143 |     <exclude-pattern>*/public/index.php</exclude-pattern>
144 |     <exclude-pattern>*/*.blade.php</exclude-pattern>
145 |     <exclude-pattern>*/Console/Kernel.php</exclude-pattern>
146 |     <exclude-pattern>*/Exceptions/Handler.php</exclude-pattern>
147 |     <exclude-pattern>*/Http/Kernel.php</exclude-pattern>
148 |     <exclude-pattern>*/Providers/*</exclude-pattern>
149 |     <exclude-pattern>*/resources/lang/*</exclude-pattern>
150 | 
151 |     <arg name="colors"/>
152 |     <arg value="spv"/>
153 |     <ini name="memory_limit" value="128M"/>
154 | </ruleset>
155 | 


--------------------------------------------------------------------------------