2017 © Pedro Peláez
 

library phpcs

Official Geolid coding standard.

image

geolid/phpcs

Official Geolid coding standard.

  • Wednesday, July 25, 2018
  • by geolid
  • Repository
  • 12 Watchers
  • 4 Stars
  • 3,637 Installations
  • PHP
  • 1 Dependents
  • 0 Suggesters
  • 0 Forks
  • 5 Open issues
  • 20 Versions
  • 9 % Grown

The README.md

Geolid PHP Coding Style Build Status

PHPCS ruleset used at Geolid., (*1)

Installation

composer require --dev geolid/phpcs

You only need this package, no need to require manually squizlabs/php_codesniffer or friendsofphp/php-cs-fixer., (*2)

After require, copy in your path : phpcs.xml.dist and rename to phpcs.xml̀ or add the rule below in your existing phpcs.xml., (*3)

<rule ref="./vendor/geolid/phpcs/src/Geolid/ruleset.xml" />

Copy in your path the .php_cs.dist file., (*4)

Usage

Use php_codesniffer normally., (*5)

vendor/bin/phpcs

Use php-cs-fixer normally., (*6)

vendor/bin/php-cs-fixer fix

Description

We follow the PSR-2 coding style with additional rules., (*7)

Additional rules :

code quality

  • Add leading \ before function invocation to speed up resolving.
  • Parameters with a default null value needs ? before type declarations.
  • No unused imports (use statements).
  • Php must contains declare(strict_types=1); with one blank line between declaration and php open tag.
  • No more 3 nesting identation levels.

readability

  • Array must be in short syntax.
  • One space around concatenation operator.
  • One space after casting operator.
  • Object instantiation must always be with parentheses.
  • Must have blank line before return statement.
  • Must have one space before return typehint. php public function foo(): self {}
  • Only one use per line for traits.
  • No empty phpdoc

PR readability

  • Trailing comma : multiline arrays must have comma in all line.
  • Trailing comma : multiline call must have comma in all line.

naming

  • Prefix all abstract classes with Abstract except PHPUnit *TestCase. (name of empty abstract not detected for moment).
  • Suffix interfaces with Interface.
  • Suffix traits with Trait.
  • Suffix exceptions with Exception.

PSR-12

  • Visibility MUST be declared on all constants.
  • Private methods and properties MUST not be prefixed with an underscore.

Testing

composer test

The Versions

25/07 2018

dev-master

9999999-dev https://github.com/Geolid/phpcs

Official Geolid coding standard.

  Sources   Download

MIT

The Requires

 

phpcs standards coding style

25/07 2018

6.1.0

6.1.0.0 https://github.com/Geolid/phpcs

Official Geolid coding standard.

  Sources   Download

MIT

The Requires

 

phpcs standards coding style

25/07 2018

dev-more-short-names

dev-more-short-names https://github.com/Geolid/phpcs

Official Geolid coding standard.

  Sources   Download

MIT

The Requires

 

phpcs standards coding style

17/07 2018

6.0.0

6.0.0.0 https://github.com/Geolid/phpcs

Official Geolid coding standard.

  Sources   Download

MIT

The Requires

 

phpcs standards coding style

17/05 2018

5.0.0

5.0.0.0 https://github.com/Geolid/phpcs

Official Geolid coding standard.

  Sources   Download

MIT

The Requires

 

phpcs standards coding style

17/05 2018

dev-add-const-visibility

dev-add-const-visibility https://github.com/Geolid/phpcs

Official Geolid coding standard.

  Sources   Download

MIT

The Requires

 

phpcs standards coding style

13/04 2018

dev-composer_validate

dev-composer_validate https://github.com/Geolid/phpcs

Official Geolid coding standard.

  Sources   Download

MIT

The Requires

 

phpcs standards coding style

05/04 2018

dev-add-rules

dev-add-rules https://github.com/Geolid/phpcs

Official Geolid coding standard.

  Sources   Download

MIT

The Requires

 

phpcs standards coding style

19/03 2018

4.0.0

4.0.0.0 https://github.com/Geolid/phpcs

Official Geolid coding standard.

  Sources   Download

MIT

The Requires

 

phpcs standards coding style

19/03 2018

3.1.0

3.1.0.0 https://github.com/Geolid/phpcs

Official Geolid coding standard.

  Sources   Download

MIT

The Requires

 

phpcs standards coding style

19/03 2018

dev-devster-patch-1

dev-devster-patch-1 https://github.com/Geolid/phpcs

Official Geolid coding standard.

  Sources   Download

MIT

The Requires

 

phpcs standards coding style

06/02 2018

3.0.0

3.0.0.0 https://github.com/Geolid/phpcs

Official Geolid coding standard.

  Sources   Download

MIT

The Requires

 

phpcs standards coding style

06/02 2018

dev-prefix-suffix

dev-prefix-suffix https://github.com/Geolid/phpcs

Official Geolid coding standard.

  Sources   Download

MIT

The Requires

 

phpcs standards coding style

14/12 2017

2.1.0

2.1.0.0 https://github.com/Geolid/phpcs

Official Geolid coding standard.

  Sources   Download

MIT

The Requires

 

phpcs standards coding style

01/12 2017

2.0.3

2.0.3.0 https://github.com/Geolid/phpcs

Official Geolid coding standard.

  Sources   Download

MIT

The Requires

 

phpcs standards coding style

01/12 2017

2.0.2

2.0.2.0 https://github.com/Geolid/phpcs

Official Geolid coding standard.

  Sources   Download

MIT

The Requires

 

phpcs standards coding style

28/11 2017

2.0.1

2.0.1.0 https://github.com/Geolid/phpcs

Official Geolid coding standard.

  Sources   Download

MIT

The Requires

 

phpcs standards coding style

14/11 2017

2.0.0

2.0.0.0 https://github.com/Geolid/phpcs

Official Geolid coding standard.

  Sources   Download

MIT

The Requires

 

phpcs standards coding style

27/10 2017

1.0.1

1.0.1.0 https://github.com/Geolid/phpcs

Official Geolid coding standard.

  Sources   Download

MIT

The Requires

 

phpcs standards coding style

27/10 2017

1.0.0

1.0.0.0 https://github.com/Geolid/phpcs

Official Geolid coding standard.

  Sources   Download

The Requires

 

phpcs