mirror of
https://github.com/nextcloud/coding-standard.git
synced 2025-10-26 15:06:10 +01:00
No description
|
|
||
|---|---|---|
| .github/workflows | ||
| src | ||
| .gitignore | ||
| .php-cs-fixer.dist.php | ||
| CHANGELOG.md | ||
| composer.json | ||
| LICENSE | ||
| README.md | ||
Nextcloud Coding Standard
Nextcloud coding standards for the php cs fixer.
Installation
Add the package to your dev dependencies
composer require --dev nextcloud/coding-standard
and create a .php-cs-fixer.dist.php like
<?php
declare(strict_types=1);
require_once './vendor/autoload.php';
use Nextcloud\CodingStandard\Config;
$config = new Config();
$config
->getFinder()
->ignoreVCSIgnored(true)
->notPath('build')
->notPath('l10n')
->notPath('src')
->notPath('vendor')
->in(__DIR__);
return $config;
To run the fixer you first have to install it. Then you can run php-cs-fixer fix to apply all automated fixes.
For convenience you may add it to the scripts section of your composer.json:
{
"scripts": {
"cs:check": "php-cs-fixer fix --dry-run --diff",
"cs:fix": "php-cs-fixer fix"
}
}
Note: Don't forget to exclude .php-cs-fixer.dist.php and .php-cs-fixer.cache in your build scripts.
Upgrade from v0.x to v1.0
With v1.0 php-cs-fixer was updated from v2 to v3. You'll have to adjust your app slightly:
- Rename
.php_cs.distto.php-cs-fixer.dist.php - Add
.php-cs-fixer.cacheto your ignore files