endouble/symfony3-custom-coding-standard

Monday, July 30, 2018
by thanosp
Repository
4 Watchers
8 Stars
29,054 Installations

PHP
0 Dependents
0 Suggesters
107 Forks
2 Open issues
26 Versions
14 % Grown

The README.md

Symfony3 Custom PHP CodeSniffer Coding Standard

This is a fork of https://github.com/djoos/Symfony2-coding-standard These are the Symfony2 standards, but tweaked to meet some needs we have in our CSB project, for example to comply with PSR-12 for PHP 7, _(*1)

Installation

Composer

This standard can be installed with the Composer dependency manager., _(*2)

Add the repository to your composer.json:

 "repositories": [
        {
            "type": "vcs",
            "url": "git@github.com:Endouble/Symfony3-custom-coding-standard"
        }

Add the coding standard as a dependency of your project

 "require-dev": {
        "endouble/symfony3-custom-coding-standard": "^2.10"
    },

Add the coding standard to the PHP_CodeSniffer install path

The path is relative to the php_codesniffer install path. This is important to make it work both in your vagrant, local machine and PHPStorm, _(*3)

    bin/phpcs --config-set installed_paths ../../endouble/symfony3-custom-coding-standard

Check the installed coding standards for "Symfony2", _(*4)
```
bin/phpcs -i
```
Done!, _(*5)

bin/phpcs --standard=Symfony3Custom /path/to/code, _(*6)
(optional) Set up PHPStorm, _(*7)

configure code sniffer under Languages & Frameworks -> PHP -> Code Sniffer
Go to Editor -> Inspections -> PHP Code sniffer, refresh the standards and select Symfony3Custom

Customizations

The following adjustments have been made to the original standard:, _(*8)

In Sniff/WhiteSpace/AssignmentSpacingSniff: - Added an exception for declare(strict_types=1); to comply with PSR-12, _(*9)

In Sniff/WhiteSpace/FunctionalClosingBraceSniff: - copied from Squiz and adapted to have no blank line at the end of a function, _(*10)

In Sniff/Commenting/FunctionCommentSniff: - check for 1 blank line above a docblock - don't check docblocks for test and setUp methods (PHPunit, would be blank) - do check protected and private methods for docblocks, _(*11)

In Sniff/NamingConventions/ValidClassNameSniff - remove the abstract class name rule, _(*12)

In ruleset.xml - Disabled the class comment rule - Changed the concatenation spacing rule, for readability, to require 1 space around concatenation dot, instead of no spaces as the Symfony standard requires. - Re-enabled the blank line check from superfluousWhitespace (disabled in PSR-2), _(*13)

The Versions

30/07 2018

1.x-dev

1.9999999.9999999.9999999-dev

coding-standard symfony3-custom-coding-standard

endouble/symfony3-custom-coding-standard

The README.md

Symfony3 Custom PHP CodeSniffer Coding Standard

Installation

Composer

Customizations

The Versions

1.x-dev

1.0.0

2.0.0

2.0.1

dev-master

The Requires

by David Joos

2.17

The Requires

by David Joos

dev-allow_concat_multiline

The Requires

by David Joos

2.16

The Requires

by David Joos

2.15

The Requires

by David Joos

2.14

The Requires

by David Joos

2.11

The Requires

by David Joos

2.10.1

The Requires

by David Joos

2.10

The Requires

by Community contributors

by David Joos

2.9.1

The Requires

by Community contributors

by David Joos

2.9.0

The Requires

by Community contributors

by David Joos

2.8.1

The Requires

by Community contributors

by David Joos

2.8.0

The Requires

by Community contributors

by David Joos

2.7.0

The Requires

by Community contributors

by David Joos

2.6.0

The Requires

by Community contributors

by David Joos

2.5.0

The Requires

by Community contributors

by David Joos

2.4.0

The Requires

by Community contributors

by David Joos

2.3.1

The Requires

by Community contributors

by David Joos

2.3.0

The Development Requires

by Community contributors

by David Joos