3302797ac7
Signed-off-by: John Molakvoæ <skjnldsv@protonmail.com> |
||
---|---|---|
.. | ||
.github/workflows | ||
src | ||
.gitignore | ||
.php-cs-fixer.dist.php | ||
CHANGELOG.md | ||
LICENSE | ||
README.md | ||
composer.json |
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.dist 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.dist
to.php-cs-fixer.dist.php
- Add
.php-cs-fixer.cache
to your ignore files