Download the PHP package flyeralarm/php-code-validator without Composer
On this page you can find all versions of the php package flyeralarm/php-code-validator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download flyeralarm/php-code-validator
More information about flyeralarm/php-code-validator
Files in flyeralarm/php-code-validator
Package php-code-validator
Short Description A custom coding standard for FLYERALARM
License BSD-3-Clause
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package php-code-validator
FLYERALARM PHP Coding Guideline Validator
This repository contains the ruleset for the PHP code we develop at FLYERALARM. It mostly consists of PSR-12 with some custom additions. The rules are enforced with the help of squizlabs/PHP_CodeSniffer
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119.
Custom Rules in addition to PSR-12
- Variable names MUST be in lowerCamelCase
- Yoda conditions MUST NOT be used
- Unit tests with @expectedException MUST contain @expectedExceptionMessage annotation
- Exceptions messages MUST not contain exclamation marks or full stops
- Keywords GOTO and EVAL MUST NOT be used
- Underscores in namespaces MUST NOT be used
- Classtype suffixes like Interface, Abstract or Trait MUST NOT be used (e.g. LoggerInterface)
How-To work within this project
To prepare run command:
To check code style compliance or to fix what can be autofixed run commands:
To test ruleset run command:
As test runner is dockerized we can test with different PHP versions:
or all at once:
Embed into your project
Add as composer dev dependency:
Embed code sniffer in your Makefile. To intend please use tabs instead of spaces.
Example Makefile:
Add project specific rules
The recommended way to define custom rules for the own project is to provide a in the root of your project. PHP_CodeSniffer will automatically detect this standard if no other standard was defined (See PHP_CodeSniffer Advanced Usage).
This can then reference the FLYERALARM PHP coding standard.
Once the file is created the code can be validated using:
Update to latest stable
Run sniffer
Use within PHPStorm
1) Ensure the path to PHP Code Sniffer is configured - open configuration manual
2) Open settings: \
Mac: PhpStorm > Preferences > Editor > Inspections > PHP \
Windows & Linux: File > Settings > Editor > Inspections > PHP \
3) Activate/Tick checkbox for PHP Code Sniffer validation
4) Click on the item PHP Code Sniffer validation to open its settings on the right hand side
5) Choose "Custom" for „Coding standard:“ and click on ... on the right hand side
6) Select Path to ruleset. This would be something like ok
On a side note: We are searching for talented people to join our various teams of developers in multiple locations
