sparhandy/codingstandard

This is the Sparhandy coding standard.

Monday, July 30, 2018
by Sparhandy
Repository
11 Watchers
3 Stars
1,092 Installations

PHP
1 Dependents
0 Suggesters
1 Forks
0 Open issues
15 Versions
31 % Grown

The README.md

, _(*1)

Sparhandy Coding Standard

This repository contains all necessary files to configure PHP Code Sniffer and PHP Mess Detector according to our coding standard., _(*2)

Installation with composer

For now you have to use the dev-master version., _(*3)

composer require "sparhandy/codingstandard" "dev-master"

Usage

From Terminal (Cli)

PHP Code Sniffer

To execute PHP Code Sniffer configured for sparhandy coding standards do the following., _(*4)

./vendor/bin/phpcs --extensions=php --standard=./vendor/sparhandy/codingstandard/src/phpcs/Production/ruleset.xml ./path/to ./your/sources

PHP Mess Detector

To execute PHP Mess Detector configured for sparhandy coding standards do the following., _(*5)

./vendor/bin/phpmd ./path/to ./your/sources text ./vendor/sparhandy/codingstandard/src/phpmd/phpmd.xml --suffixes php

Travis-CI configuration

For use in your Travis-Ci configuration file just adapt the following example and save it to .travis.yml in your root directory., _(*6)

language: php

php:
  - 5.4
  - 5.5
  - 5.6
  - 7.0

matrix:
  allow_failures:
    - php: 7.0

before_script:
  - composer self-update

install: travis_retry composer update

script:
  - ./vendor/bin/phpmd ./path/to ./your/sources text ./configuration/phpmd/phpmd.xml --suffixes php
  - ./vendor/bin/phpcs --extensions=php --standard=./configuration/phpcs/Production/ruleset.xml ./path/to ./your/sources

How to contribute

If you want to contribute to the standard here is how it works., _(*7)

Create a fork of Sparhandy/CodingStandard.
Create your branch from master and commit your changes.
Push your branch to your fork.
Create a pull request on GitHub.
Discuss your pull request with us.
Our devs will then merge or close the pull request.

Acknowledgements

This would not be possible without the tremendous work of the good people at PHP Code Sniffer and PHP Mess Detector and of course the authors annotated in the source files., _(*8)

The Versions

30/07 2018

dev-master

9999999-dev https://github.com/Sparhandy/CodingStandard

This is the Sparhandy coding standard.

Sources Download

BSD-3-Clause

The Requires

The Development Requires

phpunit/phpunit ^4.8

by Sebastian Knott

phpcs standards sparhandy

30/07 2018

1.2.5

1.2.5.0 https://github.com/Sparhandy/CodingStandard

This is the Sparhandy coding standard.

Sources Download

BSD-3-Clause

The Requires

by Sebastian Knott

phpcs standards sparhandy

30/07 2018

dev-fix-short-parameter-types

dev-fix-short-parameter-types https://github.com/Sparhandy/CodingStandard

This is the Sparhandy coding standard.

Sources Download

BSD-3-Clause

The Requires

by Sebastian Knott

phpcs standards sparhandy

23/07 2018

1.2.4

1.2.4.0 https://github.com/Sparhandy/CodingStandard

This is the Sparhandy coding standard.

Sources Download

BSD-3-Clause

The Requires

by Sebastian Knott

phpcs standards sparhandy

19/06 2018

1.2.3

1.2.3.0 https://github.com/Sparhandy/CodingStandard

This is the Sparhandy coding standard.

Sources Download

BSD-3-Clause

The Requires

by Sebastian Knott

phpcs standards sparhandy

18/06 2018

1.2.2

1.2.2.0 https://github.com/Sparhandy/CodingStandard

This is the Sparhandy coding standard.

Sources Download

BSD-3-Clause

The Requires

by Sebastian Knott

phpcs standards sparhandy

18/06 2018

1.2

1.2.0.0 https://github.com/Sparhandy/CodingStandard

This is the Sparhandy coding standard.

Sources Download

BSD-3-Clause

The Requires

by Sebastian Knott

phpcs standards sparhandy

18/06 2018

1.2.1

1.2.1.0 https://github.com/Sparhandy/CodingStandard

This is the Sparhandy coding standard.

Sources Download

BSD-3-Clause

The Requires

by Sebastian Knott

phpcs standards sparhandy

27/04 2018

1.1

1.1.0.0 https://github.com/Sparhandy/CodingStandard

This is the Sparhandy coding standard.

Sources Download

BSD-3-Clause

The Requires

by Sebastian Knott

phpcs standards sparhandy

27/04 2018

dev-update-codesniffer

dev-update-codesniffer https://github.com/Sparhandy/CodingStandard

This is the Sparhandy coding standard.

Sources Download

BSD-3-Clause

The Requires

The Development Requires

phpunit/phpunit ^4.8

by Sebastian Knott

phpcs standards sparhandy

27/04 2018

dev-remove-composer-directory-inst

dev-remove-composer-directory-inst https://github.com/Sparhandy/CodingStandard

This is the Sparhandy coding standard.

Sources Download

BSD-3-Clause

The Requires

by Sebastian Knott

phpcs standards sparhandy

20/04 2018

2.0.0

2.0.0.0 https://github.com/Sparhandy/CodingStandard

This is the Sparhandy coding standard.

Sources Download

BSD-3-Clause

The Requires

by Sebastian Knott

phpcs standards sparhandy

12/12 2017

dev-update-travis-config-to-php-7.2

dev-update-travis-config-to-php-7.2 https://github.com/Sparhandy/CodingStandard

This is the Sparhandy coding standard.

Sources Download

BSD-3-Clause

The Requires

The Development Requires

phpunit/phpunit ^4.8

by Sebastian Knott

phpcs standards sparhandy

30/11 2017

1.0.0.1

1.0.0.1 https://github.com/Sparhandy/CodingStandard

This is the Sparhandy coding standard.

Sources Download

BSD-3-Clause

The Requires

The Development Requires

phpunit/phpunit ^4.8

by Sebastian Knott

phpcs standards sparhandy

30/11 2017

1.0.0

1.0.0.0 https://github.com/Sparhandy/CodingStandard

This is the Sparhandy coding standard.

Sources Download

BSD-3-Clause

The Requires

The Development Requires

phpunit/phpunit ^4.8

by Sebastian Knott

phpcs standards sparhandy

phpcodesniffer-standard codingstandard

This is the Sparhandy coding standard.