shlinkio/php-coding-standard

Coding standard used by shlink PHP projects

Installs: 3 388

Dependents: 10

Suggesters: 0

Security: 0

Stars: 2

Watchers: 1

Forks: 1

Open Issues: 1

Language:Shell

Type:phpcodesniffer-standard

v2.1.0 2020-01-01 19:10 UTC

This package is auto-updated.

Last update: 2020-06-30 20:34:53 UTC


README

This repository provides a PHP_CodeSniffer ruleset with the rules used by shlink PHP projects.

Usage

First, install this package using composer:

composer require shlinkio/php-coding-standard --dev

Then, update your phpcs.xml file, adding a rule with the reference to Shlinkio.

<?xml version="1.0"?>
<ruleset name="Coding standard">
    <description>Coding standard</description>

    <!-- display progress -->
    <arg value="p" />
    <arg name="colors" />

    <!-- inherit rules from: -->
    <rule ref="Shlinkio" />

    <!-- [...] -->
</ruleset>

Rules

This ruleset extends PSR-12 rules, and includes:

  • Do not allow array long syntax [array(...)].
  • Make sure string concatenation operator is surrounded by spaces.
  • Do not allow superfluous whitespaces.
  • Do not allow unused use statements.
  • Require alphabetically ordered use statements.
  • Require strict comparisons (=== and !== instead of == and !=).
  • Require trailing comma on every element of multi-line arrays.
  • Require trailing comma on every element of multi-line function calls.
  • Enforce all global namespace classes, functions and constants to be explicitly imported.
  • Require comments with single line written as one-liners [/* @var SomeType **/].
  • Make all class constants to have a visibility modifier (public, protected or private).
  • Require function arguments with a default null value to be defined as nullable (?string $foo = 'foo').
  • Require function arguments to have a native type hint whenever possible.
  • Require functions to have a native return type hint whenever possible.
  • Require properties to have a native type hint whenever possible.