datana-gmbh / php-cs-fixer-config
Provides a configuration factory and multiple rule sets for friendsofphp/php-cs-fixer.
Installs: 110 807
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 3
Forks: 0
Open Issues: 0
Requires
- php: ^7.2 || ^8.0
- friendsofphp/php-cs-fixer: ~2.19.3
Requires (Dev)
- composer/package-versions-deprecated: 1.11.99.5
- ergebnis/composer-normalize: ^2.19.0
- ergebnis/license: ^1.1.0
- ergebnis/phpstan-rules: ~0.15.3
- ergebnis/test-util: ^1.5.0
- infection/infection: ~0.15.3
- phpstan/extension-installer: ^1.1.0
- phpstan/phpstan: ~0.12.99
- phpstan/phpstan-deprecation-rules: ~0.12.6
- phpstan/phpstan-phpunit: ~0.12.22
- phpstan/phpstan-strict-rules: ~0.12.11
- phpunit/phpunit: ^8.5.27
This package is auto-updated.
Last update: 2022-12-21 08:03:12 UTC
README
Provides a configuration factory and multiple rule sets for friendsofphp/php-cs-fixer
.
Installation
Run
$ composer require --dev datana-gmbh/php-cs-fixer-config
Usage
Configuration
Pick one of the rule sets:
Create a configuration file .php_cs
in the root of your project:
<?php use Datana\PhpCsFixer\Config; $config = Config\Factory::fromRuleSet(new Config\RuleSet\Php74()); $config->getFinder()->in(__DIR__); $config->setCacheFile(__DIR__ . '/.build/php-cs-fixer/php_cs.cache'); return $config;
Git
All configuration examples use the caching feature, and if you want to use it as well, you should add the cache directory to .gitignore
:
+ /.build/
/vendor/
💡 Personally, I prefer to use a .build
directory for storing build artifacts.
Configuration with header
💡 Optionally specify a header:
<?php use Datana\PhpCsFixer\Config; +$header = <<<EOF +Copyright (c) 2021 Datana GmbH + +For the full copyright and license information, please view +the LICENSE file that was distributed with this source code. + +@see https://github.com/datana-gmbh/php-cs-fixer-config +EOF; -$config = Config\Factory::fromRuleSet(new Config\RuleSet\Php74()); +$config = Config\Factory::fromRuleSet(new Config\RuleSet\Php74($header)); $config->getFinder()->in(__DIR__); $config->setCacheFile(__DIR__ . '/.build/php-cs-fixer/php_cs.cache'); return $config;
This will enable and configure the HeaderCommentFixer
, so that
file headers will be added to PHP files, for example:
<?php /** * Copyright (c) 2021 Datana GmbH * * For the full copyright and license information, please view * the LICENSE file that was distributed with this source code. * * @see https://github.com/datana-gmbh/php-cs-fixer-config */
Configuration with override rules
💡 Optionally override rules from a rule set by passing in an array of rules to be merged in:
<?php use Datana\PhpCsFixer\Config; -$config = Config\Factory::fromRuleSet(new Config\RuleSet\Php74()); +$config = Config\Factory::fromRuleSet(new Config\RuleSet\Php74(), [ + 'mb_str_functions' => false, + 'strict_comparison' => false, +]); $config->getFinder()->in(__DIR__); $config->setCacheFile(__DIR__ . '/.build/php-cs-fixer/php_cs.cache'); return $config;
Makefile
If you like Makefile
s, create a Makefile
with a coding-standards
target:
+.PHONY: coding-standards +coding-standards: vendor + mkdir -p .build/php-cs-fixer + vendor/bin/php-cs-fixer fix --config=.php_cs --diff --verbose vendor: composer.json composer.lock composer validate composer install
Run
$ make coding-standards
to automatically fix coding standard violations.
Composer script
If you like composer
scripts, add a coding-standards
script to composer.json
:
{ "name": "foo/bar", "require": { "php": "^7.4", }, "require-dev": { "datana-gmbh/php-cs-fixer-config": "~1.0.0" + }, + "scripts": { + "coding-standards": [ + "mkdir -p .build/php-cs-fixer", + "php-cs-fixer fix --diff --diff-format=udiff --verbose" + ] } }
Run
$ composer coding-standards
to automatically fix coding standard violations.
GitHub Actions
If you like GitHub Actions, add a coding-standards
job to your workflow:
on: pull_request: null push: branches: - main name: "Integrate" jobs: + coding-standards: + name: "Coding Standards" + + runs-on: ubuntu-latest + + strategy: + matrix: + php-version: + - "7.4" + + steps: + - name: "Checkout" + uses: "actions/checkout@v2" + + - name: "Install PHP with extensions" + uses: "shivammathur/setup-php@v2" + with: + coverage: "none" + php-version: "${{ matrix.php-version }}" + + - name: "Cache dependencies installed with composer" + uses: "actions/cache@v2" + with: + path: "~/.composer/cache" + key: "php-${{ matrix.php-version }}-composer-${{ hashFiles('composer.lock') }}" + restore-keys: "php-${{ matrix.php-version }}-composer-" + + - name: "Install locked dependencies with composer" + run: "composer install --no-interaction --no-progress --no-suggest" + + - name: "Create cache directory for friendsofphp/php-cs-fixer" + run: mkdir -p .build/php-cs-fixer + + - name: "Cache cache directory for friendsofphp/php-cs-fixer" + uses: "actions/cache@v2" + with: + path: "~/.build/php-cs-fixer" + key: "php-${{ matrix.php-version }}-php-cs-fixer-${{ github.sha }}" + restore-keys: "php-${{ matrix.php-version }}-php-cs-fixer-" + + - name: "Run friendsofphp/php-cs-fixer" + run: "vendor/bin/php-cs-fixer fix --config=.php_cs --diff --diff-format=udiff --dry-run --verbose"
Changelog
Please have a look at CHANGELOG.md
.
Contributing
Please have a look at CONTRIBUTING.md
.
Code of Conduct
Please have a look at CODE_OF_CONDUCT.md
.
License
This package is licensed using the MIT License.
Please have a look at LICENSE.md
.
Credits
This project is inspired by ergebnis/php-cs-fixer-config
.