marioblazek / coding-standard
My personal coding standard
Installs: 1 537
Dependents: 3
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Requires
- php: ^7.4 || ^8.0
- friendsofphp/php-cs-fixer: ^3.0
Requires (Dev)
- phpstan/phpstan: ^1.1
- phpstan/phpstan-strict-rules: ^1.0
README
This repository provides a default coding standard configuration. The config is based on PHP CS Fixer and inspired by the Netgen Layouts Coding Standards.
Installation
$ composer require --dev marioblazek/coding-standard
The list of available rules can be found here.
Usage
Create a .php-cs-fixer.php
file in the root of your project with the following:
return (new Marek\CodingStandard\PhpCsFixer\Config()) ->setFinder( PhpCsFixer\Finder::create() ->exclude(['vendor']) ->in(__DIR__) ) ;
Run the fixer with:
$ vendor/bin/php-cs-fixer fix
Overriding existing rules
You can override rules included in this config per project:
return (new Marek\CodingStandard\PhpCsFixer\Config()) ->addRules([ 'list_syntax' => ['syntax' => 'long'], ]) ->setFinder( PhpCsFixer\Finder::create() ->exclude(['vendor']) ->in(__DIR__) ) ;
Supporting PHAR distribution of PHP CS Fixer
You can also support running PHAR version of PHP CS Fixer by adding the
following at the top of your .php-cs-fixer.php
file:
// To support running PHP CS Fixer via PHAR file (e.g. in GitHub Actions) require_once __DIR__ . '/vendor/marioblazek/coding-standard/src/PhpCsFixer/Config.php';
This is e.g. useful if you wish to run PHP CS Fixer via GitHub action, which
does not need running composer install
:
# .github/workflows/ci.yml name: PHP CS Fixer on: [push, pull_request] jobs: php-cs-fixer: name: PHP CS Fixer runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - uses: actions/checkout@v2 with: repository: marioblazek/coding-standard path: vendor/marioblazek/coding-standard - name: PHP CS Fixer uses: OskarStark/php-cs-fixer-ga@master with: args: --diff --dry-run
Check https://github.com/OskarStark/php-cs-fixer-ga for more details.
Changelog
Changelog is available here.