ethical-jobs/standards

There is no license information available for the latest version (v1.3) of this package.

v1.3 2020-03-18 04:30 UTC

Requires

• php: >=7.2
• phpmd/phpmd: ^2.8
• phpstan/phpstan: ^0.12
• sebastian/phpcpd: ^5.0
• slevomat/coding-standard: ^6.1
• squizlabs/php_codesniffer: ^3.5
• symfony/console: ^5.0
• symfony/process: ^5.0

Unknown License

README

Exists to:

• Provide a source of truth for our code-styling and rules
• Provide an easy interface for developers to locally run the standards suite
• Provide a Drone pipeline template generation

Does not exist to:

• Wrap the execution on the build server

Usage

composer require --dev ethicaljobs/standards
vendor/bin/ej-standards run

The Standards

PHP Mess Detector

Enforces good code design

PHP Code Sniffer

Useful for keeping consistent code style

PHP Stan

Useful for determining edge-cases, un-usable code paths, ...

Configuration

Runners

This standards package comes with two runners for running the standards suite.

Assumptions

• drone-cli is installed
• the project has a pipeline called 'standards'