2017 © Pedro Peláez
 

library poet-coding-standard

POET CodeSniffer Standards

image

poetgroup/poet-coding-standard

POET CodeSniffer Standards

  • Monday, November 7, 2016
  • by poet
  • Repository
  • 2 Watchers
  • 0 Stars
  • 3,257 Installations
  • PHP
  • 3 Dependents
  • 0 Suggesters
  • 9 Forks
  • 2 Open issues
  • 10 Versions
  • 0 % Grown

The README.md

Introduction

This is the POET Group's coding standard. This standard is primarily focused on assisting with code reviews. For example, warning the code reviewer about potential security or performance problems., (*1)

Please visit the coding standard documentation for further details., (*2)

Install

Just add it to your project's composer.json file (--dev is optional based on your needs):, (*3)

composer require --dev poetgroup/poet-coding-standard

Usage

The following paths may change based on how things are installed, but basically you are looking for the path to the CodeSniffer command and the path to the moodle directory of this project:, (*4)

vendor/bin/phpcs --standard=POET /path/to/moodle/plugin

Testing

In order to run the unit tests, you must ensure that you install from source otherwise, testing code from PHP_CodeSniffer would be missing. Here is an example of re-installing dependencies and running tests:, (*5)

rm -rf vendor/
composer install --prefer-source
vendor/bin/phpunit

Please also know that any new tests added need the @group poet annotation added. This ensures that only tests from the POET standard are run., (*6)

Documenting

To update the standard's documentation, use the following command:, (*7)

vendor/bin/phpcs --standard=POET --generator=markdown > POET.md

License

This project is licensed under the GNU GPL v3 or later. See the LICENSE file for details., (*8)

The Versions

07/11 2016

dev-wip-POET-24

dev-wip-POET-24

POET CodeSniffer Standards

  Sources   Download

GPL-3.0

The Requires

 

The Development Requires

codesniffer poet

20/09 2016

dev-wip-POET-25

dev-wip-POET-25

POET CodeSniffer Standards

  Sources   Download

GPL-3.0

The Requires

 

The Development Requires

codesniffer poet

01/09 2016

dev-POET-25

dev-POET-25

POET CodeSniffer Standards

  Sources   Download

GPL-3.0

The Requires

 

The Development Requires

codesniffer poet

14/06 2016

dev-master

9999999-dev

POET CodeSniffer Standards

  Sources   Download

GPL-3.0

The Requires

 

The Development Requires

codesniffer poet

09/06 2016

dev-wip-POET-63

dev-wip-POET-63

POET CodeSniffer Standards

  Sources   Download

GPL-3.0

The Requires

 

The Development Requires

codesniffer poet

19/05 2016

dev-wip-POET-62

dev-wip-POET-62

POET CodeSniffer Standards

  Sources   Download

GPL-3.0

The Requires

 

The Development Requires

codesniffer poet

18/05 2016

dev-wip-POET-13

dev-wip-POET-13

POET CodeSniffer Standards

  Sources   Download

GPL-3.0

The Requires

 

codesniffer poet

13/05 2016

dev-wip-POET-12

dev-wip-POET-12

POET CodeSniffer Standards

  Sources   Download

GPL-3.0

The Requires

 

codesniffer poet

01/12 2015

dev-wip-HOSSUP-6547

dev-wip-HOSSUP-6547

Moodle CodeSniffer Standards

  Sources   Download

GPL-3.0

The Requires

 

codesniffer moodle

08/09 2015

1.0.0

1.0.0.0

Moodle CodeSniffer Standards

  Sources   Download

GPL-3.0

The Requires

 

codesniffer moodle