shopsys/coding-standards

Coding standards definition compatible with PSR-2

Monday, July 16, 2018
by sustmi
Repository
8 Watchers
17 Stars
6,042 Installations

PHP
13 Dependents
0 Suggesters
1 Forks
0 Open issues
29 Versions
22 % Grown

The README.md

Shopsys Coding Standards

, _(*1)

Shopsys Coding Standards are based on PSR-2., _(*2)

This project bundles tools along with predefined rulesets for automated checks of Shopsys Coding Standards that we use in many Shopsys projects. The repository also contains few custom rules., _(*3)

This repository is maintained by shopsys/shopsys monorepo, information about changes is in monorepo CHANGELOG.md., _(*4)

Provided tools:, _(*5)

PHP-Parallel-Lint
EasyCodingStandard that combines PHP-CS-Fixer and PHP_CodeSniffer

For further information see official documentation of those tools., _(*6)

Installation

php composer require shopsys/coding-standards

Usage

Create easy-coding-standard.yml config file in your project which includes predefined ruleset. You can also customize the rules and even add your own sniffs and fixers in the config., _(*7)

#easy-coding-standard.yml
imports:
   - { resource: '%vendor_dir%/shopsys/coding-standards/easy-coding-standard.yml' }

In terminal, run following commands:, _(*8)

php vendor/bin/parallel-lint /path/to/project
php vendor/bin/ecs check /path/to/project --config=/path/to/project/custom-coding-standard.yml

Custom rules

Rules for PHP-CS-Fixer

`Shopsys/missing_button_type`

All <button> HTML tags in .html and .html.twig files must have explicit type attribute., _(*9)

If the type is not specified it will be fixed to type="button"" because the implicit value is submit which makes it behave differently based on the context (<button> inside <form> element submits the form)., _(*10)

`Shopsys/orm_join_column_require_nullable`

Doctrine annotations @ORM\ManyToOne and @ORM\OneToOne must have nullable option defined explicitly in @ORM\JoinColumn., _(*11)

If the nullable option is not specified it will be fixed to nullable=false because the implicit value is true but this is the opposite to the implicit value of nullable for @Column annotation. This makes it consistent., _(*12)

Rules for PHP_CodeSniffer

`ForbiddenExitSniff`

Function exit() is not allowed., _(*13)

`ForbiddenSuperGlobalSniff`

Usage of superglobals ($_COOKIE, $_GET, $_FILES, $_POST, $_REQUEST, $_SERVER) is not allowed., _(*14)

`ObjectIsCreatedByFactorySniff`

Instantiation of objects that can be created by their factories is not allowed outside of the factory., _(*15)

`ValidVariableNameSniff`

Default \PHP_CodeSniffer\Standards\Squiz\Sniffs\NamingConventions\ValidVariableNameSniff does not report method parameters in $_var format as an violation but it should. It also skips checking of private members when PrivateNoUnderscore property is disabled., _(*16)

This sniff provides the missing functionality and is intended to be used as an addition to the default ValidVariableNameSniff., _(*17)

Contributing

Thank you for your contributions to Shopsys Coding Standards package. Together we are making Shopsys Framework better., _(*18)

This repository is READ-ONLY. If you want to report issues and/or send pull requests, please use the main Shopsys repository., _(*19)

Please, check our Contribution Guide before contributing., _(*20)

Support

What to do when you are in troubles or need some help? The best way is to join our Slack., _(*21)

If you want to report issues, please use the main Shopsys repository., _(*22)

The Versions

16/07 2018

dev-master

9999999-dev

Coding standards definition compatible with PSR-2

library coding-standards

Coding standards definition compatible with PSR-2