feat: add PHP-CS-Fixer Config and Rules classes for shared configuration

Provides a proper API for sharing php-cs-fixer config across projects,
replacing the hacky vendor path require approach.

Author: alies-dev

IxDFCodingStandard/PhpCsFixer/Config.php

@@ -0,0 +1,58 @@
+<?php declare(strict_types=1);
+
+namespace IxDFCodingStandard\PhpCsFixer;
+
+use PhpCsFixer\Config as BaseConfig;
+use PhpCsFixer\Finder;
+use PhpCsFixer\Runner\Parallel\ParallelConfigFactory;
+
+/**
+ * Pre-configured PHP-CS-Fixer config factory for IxDF projects.
+ *
+ * @see README.md for usage examples
+ */
+final class Config
+{
+    /**
+     * @param array<string, mixed> $ruleOverrides Rules to merge on top of the shared ruleset
+     */
+    public static function create(
+        string $projectDir,
+        array $ruleOverrides = [],
+        ?Finder $finder = null,
+    ): BaseConfig {
+        $finder ??= self::defaultFinder($projectDir);
+
+        return (new BaseConfig())
+            ->setParallelConfig(ParallelConfigFactory::detect())
+            ->setUsingCache(true)
+            ->setCacheFile($projectDir.'/.cache/.php-cs-fixer.cache')
+            ->setRiskyAllowed(true)
+            ->setIndent('    ')
+            ->setLineEnding("\n")
+            ->setRules(array_merge(Rules::get(), $ruleOverrides))
+            ->setFinder($finder);
+    }
+
+    private static function defaultFinder(string $projectDir): Finder
+    {
+        return Finder::create()
+            ->in($projectDir)
+            ->exclude([
+                '.cache',
+                '.docker',
+                'bootstrap/cache',
+                'node_modules',
+                'public',
+                'storage',
+                'vendor',
+            ])
+            ->name('*.php')
+            ->notName('*.blade.php')
+            ->notName('_ide_helper.php')
+            ->notName('.phpstorm.meta.php')
+            ->ignoreDotFiles(false)
+            ->ignoreVCS(true)
+            ->ignoreVCSIgnored(true);
+    }
+}

IxDFCodingStandard/PhpCsFixer/Rules.php

@@ -0,0 +1,20 @@
+<?php declare(strict_types=1);
+
+namespace IxDFCodingStandard\PhpCsFixer;
+
+/**
+ * Shared PHP-CS-Fixer rules for IxDF projects.
+ *
+ * @see https://mlocati.github.io/php-cs-fixer-configurator/
+ */
+final class Rules
+{
+    /** @var array<string, mixed>|null */
+    private static ?array $rules = null;
+
+    /** @return array<string, mixed> */
+    public static function get(): array
+    {
+        return self::$rules ??= require dirname(__DIR__, 2).'/.php-cs-fixer-rules.php';
+    }
+}

README.md

@@ -3,107 +3,70 @@
 [![PHP Psalm Level](https://shepherd.dev/github/InteractionDesignFoundation/coding-standard/level.svg)](https://shepherd.dev/github/InteractionDesignFoundation/coding-standard)
 [![PHP Psalm Type Coverage](https://shepherd.dev/github/InteractionDesignFoundation/coding-standard/coverage.svg)](https://shepherd.dev/github/InteractionDesignFoundation/coding-standard)
 
-# IxDF Coding Standard for Laravel
+# IxDF Coding Standard
 
-An opinionated ruleset focused on strict types.
-Suitable for both applications and packages.
+An opinionated coding standard for PHP/Laravel projects. Provides **PHP_CodeSniffer** rules and a shared **PHP-CS-Fixer** configuration.
 
 ## Installation
 
-1. Install the package via composer by running:
 ```shell
 composer require --dev interaction-design-foundation/coding-standard
 ```
 
-2. Add composer scripts into your `composer.json`:
-```json
-"scripts": {
-  "cs:check": "phpcs -p -s --colors --report-full --report-summary",
-  "cs:fix": "phpcbf -p --colors"
-}
-```
+## PHP_CodeSniffer
 
-3. Create file `phpcs.xml` on the base path of your repository with content
+Create `phpcs.xml` in your project root:
 ```xml
 <?xml version="1.0"?>
 <ruleset name="My Coding Standard">
-    <!-- Include all rules from the IxDF Coding Standard -->
     <rule ref="IxDFCodingStandard"/>
-
-    <!-- Paths to check -->
     <file>app</file>
     <file>config</file>
     <file>database</file>
-    <file>lang</file>
     <file>routes</file>
     <file>tests</file>
 </ruleset>
 ```
 
-## Usage
+## PHP-CS-Fixer
 
-- To run checks only:
+Create `.php-cs-fixer.php` in your project root:
 
-```shell
-composer cs:check
-```
+```php
+<?php declare(strict_types=1);
 
-- To automatically fix many CS issues:
+use IxDFCodingStandard\PhpCsFixer\Config;
 
-```shell
-composer cs:fix
+return Config::create(__DIR__);
 ```
 
-## Ignoring parts of a File
-
-Disable parts of a file:
+With rule overrides:
 
 ```php
-$xmlPackage = new XMLPackage;
-// phpcs:disable
-$xmlPackage['error_code'] = get_default_error_code_value();
-$xmlPackage->send();
-// phpcs:enable
+return Config::create(__DIR__, ruleOverrides: [
+    'final_public_method_for_abstract_class' => false,
+]);
 ```
 
-Disable a specific rule:
+With a custom Finder:
 
 ```php
-// phpcs:disable Generic.Commenting.Todo.Found
-$xmlPackage = new XMLPackage;
-$xmlPackage['error_code'] = get_default_error_code_value();
-// TODO: Add an error message here.
-$xmlPackage->send();
-// phpcs:enable
-```
+use IxDFCodingStandard\PhpCsFixer\Config;
+use PhpCsFixer\Finder;
 
-Ignore a specific violation:
+$finder = Finder::create()->in(__DIR__)->name('*.php');
 
-```php
-$xmlPackage = new XMLPackage;
-$xmlPackage['error_code'] = get_default_error_code_value();
-// phpcs:ignore Generic.Commenting.Todo.Found
-// TODO: Add an error message here.
-$xmlPackage->send();
+return Config::create(__DIR__, finder: $finder);
 ```
 
-## Development
-
-### Versioning
-> **New rules or Sniffs may not be introduced in minor or bugfix releases and should always be based on the develop
-branch and queued for the next major release, unless considered a bugfix for existing rules.**
-
-
-## Reference
+If you only need the rules array:
+```php
+$rules = \IxDFCodingStandard\PhpCsFixer\Rules::get();
+```
 
-Rules can be added, excluded or tweaked locally, depending on your preferences.
-More information on how to do this can be found here:
+## Usage
 
-- [Coding Standard Tutorial](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Coding-Standard-Tutorial)
-- [Configuration Options](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Configuration-Options)
-- [Selectively Applying Rules](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Annotated-Ruleset#selectively-applying-rules)
-- [Customisable Sniff Properties](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Customisable-Sniff-Properties)
-- Other coding standards (inspiring us):
-  - [Slevomat coding standard](https://github.com/slevomat/coding-standard)
-  - [Doctrine coding standard](https://github.com/doctrine/coding-standard)
-  - [Laminas coding standard](https://github.com/laminas/laminas-coding-standard)
+```shell
+composer cs:check   # check only
+composer cs:fix     # auto-fix
+```

composer.json

@@ -1,16 +1,16 @@
 {
     "name": "interaction-design-foundation/coding-standard",
-    "description": "IxDF Standard for PHP_CodeSniffer complements Consistence Coding Standard by providing sniffs with additional checks.",
+    "description": "IxDF coding standard: PHP_CodeSniffer rules and shared PHP-CS-Fixer configuration.",
     "license": "MIT",
     "type": "phpcodesniffer-standard",
     "require": {
         "php": "^8.3",
         "dealerdirect/phpcodesniffer-composer-installer": "^1.0",
+        "friendsofphp/php-cs-fixer": "^3.89",
         "slevomat/coding-standard": "^8.25",
         "squizlabs/php_codesniffer": "^4.0"
     },
     "require-dev": {
-        "friendsofphp/php-cs-fixer": "^3.89",
         "phpunit/phpunit": "^12.4",
         "vimeo/psalm": "^6.13"
     },