christophwurst/nextcloud-coding-standard

Nextcloud coding standards for the php cs fixer

v1.3.2 2024-10-14 16:49 UTC

Requires

• php: ^7.3|^8.0
• kubawerlos/php-cs-fixer-custom-fixers: ^3.22
• php-cs-fixer/shim: ^3.17

MIT

• Christoph Wurst

README

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.dist to .php-cs-fixer.dist.php
• Add .php-cs-fixer.cache to your ignore files