chiron/coding-standard

A common coding standard for Chiron's PHP libraries.

3.0.12.1 2022-05-17 21:26 UTC

Requires

• php: ^8.0 || ^8.1
• dealerdirect/phpcodesniffer-composer-installer: ^0.7
• slevomat/coding-standard: ^7.0
• squizlabs/php_codesniffer: ^3.6

Requires (Dev)

• ergebnis/composer-normalize: ^2.22
• phpunit/phpunit: ^9.5
• sebastian/diff: ^4.0

MIT

• code
• doctrine
• rules
• style
• standard
• phpcs
• Coding Standard
• codesniffer
• slevomat
• PHP_CodeSniffer
• sniffer
• coding
• ruleset
• cs
• sniffs
• checks
• PHPCodeSniffer
• psr-12
• chiron
• psr12
• ruleset.xml

README

Chiron PHP Coding Standard based on PSR-12, Doctrine, and Slevomat Coding Standards

Table of Contents

• Introduction
• Install
• Usage
• Versioning
• Change Log
• Contributing
• Support
• Credits
• License

Introduction

This library provides the Chiron Coding Standard rules for PHP_CodeSniffer (phpcs). It is inspired by and built upon the Doctrine Coding Standard and the Slevomat Coding Standard.

Install

The only thing you need before getting started is Composer.

Install PHP Coding Standard:

To install the latest version of this library, run the command below:

$ composer require chiron/coding-standard

The latest version of PHP Coding Standard requires PHP 7.1 at least.

Usage

Just add the default phpcs.xml.dist file (it can be found in the root directory) to your project and you are ready to use the Chiron Coding Standard when running phpcs.

Advanced

If you need to suppress some errors, use the following tags in your php code.

// phpcs:ignoreFile

// phpcs:ignore

// phpcs:disable
// phpcs:enable

Ignoring parts of a file
Ignoring files and folders

Versioning

This library follows SemVer with following rules.

Coding Standard document should be considered the source of truth and main object of SemVer.

• MAJOR version will be incremented if new rules are added to the document.
• MINOR version will be incremented if new sniffs are implemented to check for existing described rules.
• PATCH version will be incremented for bug fixing - fixing a bug is considered everything which does not conform to the document - this may even lead to (temporarily) disabling an existing sniff - or part of it, until a better check is available or it is properly fixed.

The implementation of the automatic checks (both custom sniffs and the ruleset.xml file) are not subject to the SemVer and may change over time to accommodate changes in PHP_CodeSniffer and provided default sniffs, which are used also by this standard.

Recommended dependency on this package is on MINOR version (e.g. ~1.0.0), which means effectively:

• No new rules will be added.
• New automatic checks may be added.
• You get fixes for existing automatic checks, or some of them may be disabled, if regressions are found.

Change Log

Please see CHANGELOG for more information on recent changes.

Contributing

Please see CONTRIBUTING for details.

Support

Please see SUPPORT for details.

Credits

• All Contributors

License

The MIT License (MIT). Please see the License File for more information.