README

Centralized custom coding standards that can be applied across my different projects.

Note

About

This package provides shared code quality rulesets and a sync script that applies them to consumer projects in a predictable and consistent way.

By following the installation steps below, the rulesets are automatically applied after composer install and composer update in your project. This guarantees that all projects use the exact same ruleset versions.

Currently supported:

PHP Mess Detector (PHPMD) - detect design and complexity issues
PHP CodeSniffer (PHPCS) - detect coding standard violations
PHP CS Fixer - automatically enforce modern code style

Requirements

PHP ^8.4
Composer

Installation

1. Package installation

Install the package as a development dependency in your project:

composer require --dev maarsson/coding-standard

2. Project configuration (required)

To ensure the coding standards are applied automatically, you must configure Composer scripts in the target project.

2.1. Add a named sync script

In your project’s composer.json add:

{
  "scripts": {
    "coding-standard:sync": [
      "vendor/bin/sync-coding-standards.php"
    ]
  }
}

2.2. Run the sync script on install and update

Extend your project’s composer.json scripts section to include:

{
  "scripts": {
    "coding-standard:sync": [
      "vendor/bin/sync-coding-standards.php"
    ],
    "post-install-cmd": [
      "@coding-standard:sync"
    ],
    "post-update-cmd": [
      "@coding-standard:sync"
    ]
  }
}

With this setup, the coding standards are applied automatically.

When does it apply?

Once configured, the sync script runs automatically in the following cases:

Automatic execution:

After composer install
After composer update
During CI pipelines that run composer install or composer update

Manual execution:

You can also apply the coding standards manually at any time:

composer coding-standard:sync (preferred)

or:

./vendor/bin/sync-coding-standards.php (direct execution)

What does the sync script do?

The sync script copies shared ruleset files from the package into the project root.

Currently applied files:

phpmd.xml
phpcs.xml
.php-cs-fixer.php

Overwrite behavior

The sync process uses an always overwrite strategy:

If rulesets already exist in the project root, they will be replaced
This guarantees all projects use the exact same ruleset

This behavior is intentional and ensures consistency across projects. If you need to customize rules per project, fork this repository or manage overrides outside of this package.

Usage

After the sync script runs, the ruleset files will exist in your project root, but the corresponding tools must also be installed. However if you installed the package via maarsson/dev-tools you don’t need to install these manually. Otherwise run:

composer require --dev phpmd/phpmd
composer require --dev squizlabs/php_codesniffer
composer require --dev friendsofphp/php-cs-fixer

Note: *.cache should be added to .gitignore.

Using PHPMD with the installed ruleset

Run the PHPMD check for displaying violations like this:

./vendor/bin/phpmd . ansi phpmd.xml --suffixes=php --cache --cache-file=.phpmd.cache

Using PHPCS with the installed ruleset

Then run the PHPCS check for displaying violations like this:

./vendor/bin/phpcs --parallel=4 --standard=phpcs.xml -d memory_limit=1G --cache=.phpcs.cache .

Or run the PHPCBF (comes with the same package) to actually fix violations like this:

./vendor/bin/phpcbf --parallel=4 --standard=phpcs.xml -d memory_limit=1G --cache=.phpcs.cache .

Using PHP-CS-Fixer with the installed ruleset

Then run the PHP-CS-Fixer check for displaying violations like this:

./vendor/bin/php-cs-fixer fix --dry-run --diff --config=.php-cs-fixer.php --cache-file=.php-cs-fixer.cache

Or run the PHP-CS-Fixer to actually fix violations like this:

./vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.php --cache-file=.php-cs-fixer.cache

Troubleshooting

Source file not found

This typically means:

the package is not installed correctly
Composer install/update did not complete successfully

Try:

composer install
composer coding-standard:sync -vvv

Sync script not executable

Ensure your environment supports running scripts from vendor/bin and that file permissions are preserved.

License

MIT

maarsson / coding-standard

Maintainers

Details