Feat/config

.editorconfig

@@ -18,6 +18,7 @@ indent_size = 2
 
 [*.md]
 trim_trailing_whitespace = false
+indent_style = space
 
 [{*.txt,wp-config-sample.php}]
 end_of_line = crlf

.github/workflows/format-php.yml

@@ -6,20 +6,33 @@ on:
             - '**.php'
 
 jobs:
-    php-cs-fixer:
-        runs-on: ubuntu-latest
-        steps:
-            - uses: actions/checkout@v4
-              with:
-                  ref: ${{ github.head_ref }}
-                  fetch-depth: 0
+  php-cs-fixer:
+    name: php-cs-fixer
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
 
-            - name: Run php-cs-fixer
-              uses: docker://oskarstark/php-cs-fixer-ga
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.1'
+          tools: composer:v2
+          coverage: none
+        env:
+          COMPOSER_TOKEN: ${{ secrets.YARD_BOT_PAT }}
 
-            - uses: stefanzweifel/git-auto-commit-action@v5
-              with:
-                  commit_message: '(auto): apply php-cs-fixer changes'
-                  push_options: '--force'
-              env:
-                  GITHUB_TOKEN: ${{ secrets.YARD_BOT_PAT }}
+      - name: Install composer dependencies
+        run: composer install --prefer-dist --no-interaction
+
+      - name: Run PHPStan
+        run: ./vendor/bin/php-cs-fixer fix
+
+      - uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: '(auto): apply php-cs-fixer changes'
+          push_options: '--force'
+        env:
+          GITHUB_TOKEN: ${{ secrets.YARD_BOT_PAT }}

.github/workflows/phpstan.yml

@@ -29,8 +29,5 @@ jobs:
             - name: Install composer dependencies
               run: composer install --prefer-dist --no-interaction
 
-            - name: Dirty fix for previously defined function
-              run: sed -i -e 's#function __(#function ____(#' ./vendor/php-stubs/wordpress-stubs/wordpress-stubs.php
-
             - name: Run PHPStan
               run: ./vendor/bin/phpstan --error-format=github

.github/workflows/run-tests.yml

@@ -11,59 +11,22 @@ on:
   workflow_dispatch:
 
 jobs:
-  test:
-    runs-on: ${{ matrix.os }}
-    timeout-minutes: 5
-    strategy:
-      fail-fast: true
-      matrix:
-        os: [ubuntu-latest]
-        php: [8.1, 8.2]
-        laravel: [10.*]
-        include:
-          - laravel: 10.*
-            testbench: 8.*
-
-    name: PHP${{ matrix.php }} - Laravel${{ matrix.laravel }}
-
-    permissions:
-      contents: read
-      pull-requests: write
+  ci:
+    runs-on: ubuntu-latest
 
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
+      - name: Checkout
+        uses: actions/checkout@v3
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: ${{ matrix.php }}
-          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick, fileinfo, xdebug
-          coverage: xdebug
+          php-version: 8.1
           tools: composer:v2
-        env:
-          COMPOSER_TOKEN: ${{ secrets.YARD_BOT_PAT }}
-
-      - name: Setup problem matchers
-        run: |
-          echo "::add-matcher::${{ runner.tool_cache }}/php.json"
-          echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
-
-      - name: Install dependencies
-        run: |
-          composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" --no-interaction --no-update
-          composer update --prefer-dist --no-interaction
-
-      - name: List Installed Dependencies
-        run: composer show -D
+          coverage: xdebug
 
-      - name: Execute tests
-        run: vendor/bin/pest --coverage-clover=coverage.xml
+      - name: Install Dependencies
+        run: composer install --no-interaction --prefer-dist --optimize-autoloader
 
-      - name: Coverage Report as Comment (Clover)
-        if: github.event_name == 'pull_request'
-        uses: lucassabreu/comment-coverage-clover@main
-        with:
-          file: coverage.xml
+      - name: Tests
+        run: ./vendor/bin/pest --ci

.php-cs-fixer.php

@@ -2,7 +2,6 @@
 
 declare(strict_types=1);
 
-use PhpCsFixer\Config;
 use PhpCsFixer\Finder;
 
 # PHP CS Fixer can be run by using the composer script `composer format`
@@ -15,60 +14,6 @@
     ->ignoreVCS(true)
     ->exclude('public')
     ->exclude('node_modules')
-    ->exclude('build')
-;
+    ->exclude('build');
 
-return (new Config)
-    ->setFinder($finder)
-    ->setRules([
-        '@PSR2' => true,
-        'indentation_type' => true,
-        'array_syntax' => ['syntax' => 'short'],
-        'ordered_imports' => ['sort_algorithm' => 'alpha',
-        ],
-        'no_unused_imports' => true,
-        'not_operator_with_successor_space' => true,
-        'logical_operators' => true,
-        'trailing_comma_in_multiline' => true,
-        'phpdoc_scalar' => true,
-        'phpdoc_var_without_name' => true,
-        'phpdoc_single_line_var_spacing' => true,
-        'unary_operator_spaces' => true,
-        'phpdoc_trim' => true,
-        'phpdoc_trim_consecutive_blank_line_separation' => true,
-        'align_multiline_comment' => true,
-        'array_indentation' => true,
-        'no_superfluous_elseif' => true,
-        'single_blank_line_before_namespace' => true,
-        'blank_line_after_opening_tag' => true,
-        'no_blank_lines_after_phpdoc' => true,
-        'phpdoc_separation' => true,
-        'method_chaining_indentation' => true,
-        'binary_operator_spaces' => [
-            'default' => 'single_space',
-            'operators' => [
-                '=>' => null,
-                '|' => 'no_space',
-            ],
-        ],
-        'return_type_declaration' => [
-            'space_before' => 'none',
-        ],
-        'blank_line_before_statement' => [
-            'statements' => ['break', 'continue', 'declare', 'return', 'throw', 'try'],
-        ],
-        'full_opening_tag' => true,
-        'method_argument_space' => [
-            'on_multiline' => 'ensure_fully_multiline',
-            'keep_multiple_spaces_after_comma' => true,
-        ],
-        'yoda_style' => [
-            'always_move_variable' => true,
-            'equal' => true,
-            'identical' => true,
-            'less_and_greater' => true,
-        ],
-        'declare_strict_types' => true,
-    ])
-    ->setLineEnding("\n")
-    ->setRiskyAllowed(true);
+return \Yard\PhpCsFixerRules\Config::create($finder)->setRiskyAllowed(false)->setDefaultRules();

README.md

@@ -1,12 +1,13 @@
-# Yard php-cs-fixer-rules
+# php-cs-fixer-rules
 
 [![Code Style](https://github.com/yardinternet/php-cs-fixer-rules/actions/workflows/format-php.yml/badge.svg?no-cache)](https://github.com/yardinternet/php-cs-fixer-rules/actions/workflows/format-php.yml)
 [![PHPStan](https://github.com/yardinternet/php-cs-fixer-rules/actions/workflows/phpstan.yml/badge.svg?no-cache)](https://github.com/yardinternet/php-cs-fixer-rules/actions/workflows/phpstan.yml)
 [![Tests](https://github.com/yardinternet/php-cs-fixer-rules/actions/workflows/run-tests.yml/badge.svg?no-cache)](https://github.com/yardinternet/php-cs-fixer-rules/actions/workflows/run-tests.yml)
 [![Code Coverage Badge](https://github.com/yardinternet/php-cs-fixer-rules/blob/badges/coverage.svg)](https://github.com/yardinternet/php-cs-fixer-rules/actions/workflows/badges.yml)
 [![Lines of Code Badge](https://github.com/yardinternet/php-cs-fixer-rules/blob/badges/lines-of-code.svg)](https://github.com/yardinternet/php-cs-fixer-rules/actions/workflows/badges.yml)
 
-Enables you to easily import the Yard PHP CS Fixer rules.
+PHP CS Fixer rules used within the WordPress team for sites and packages.
+This package centralizes formatting settings and allows for easy configuration of PHP CS Fixer.
 
 ## Installation
 
@@ -29,6 +30,10 @@ To install this package using Composer, follow these steps:
 
 ## Usage
 
+This package enhances the `PhpCsFixer\Config` class (see the [ConfigInterface](src/Interfaces/ConfigInterface.php)). One
+can create a new configuration object by calling the static
+`create(Finder $finder, string $name = 'default'): self` method.
+
 ```php
 <?php
 
@@ -42,13 +47,154 @@ $finder = Finder::create()
     ->ignoreVCS(true)
     ->exclude('public')
     ->exclude('node_modules')
-    ->exclude('build')
-;
-
-return \Yard\PhpCsFixerRules\Config::setFinder($finder)
-	->mergeRules([ // allows you to add new rules or override rules from default
- 		'declare_strict_types' => false, 
-	])
-	->setRiskyAllowed(false) // override and disable risky setting for old projects
-	->get();
+    ->exclude('build');
+
+return \Yard\PhpCsFixerRules\Config::create($finder);
+```
+
+### Removing rules
+
+`removeRules(array $rulesKeys): self` or `removeRule(string $ruleKey): self` allows you to remove rules.
+
+```php
+
+/**
+ * Default rules:
+ * 
+ * [
+ *     'method_chaining_indentation' => true,
+ *     'yoda_style' => [
+ *         'always_move_variable' => true,
+ *         'equal' => true,
+ *         'identical' => true,
+ *         'less_and_greater' => true,
+ *     ],
+ *     'binary_operator_spaces' => [
+ *         'default' => 'single_space',
+ *         'operators' => [
+ *             '=>' => null,
+ *             '|' => 'no_space',
+ *         ],
+ *     ],
+ * ]
+ */
+
+$config = \Yard\PhpCsFixerRules\Config::create($finder)
+    ->removeRules(['yoda_style', 'binary_operator_spaces']); 
+
+/**
+ * Expected rule set: 
+ * 
+ * [
+ *     'method_chaining_indentation' => true,
+ * ]
+ */
+
+
+return $config->removeRule('method_chaining_indentation');
+
+/**
+ * Expected rule set: []
+ */
 ```
+
+### Add and override rules
+
+`mergeRules(array $rules): self` allows you to add and override rules.
+
+```php
+
+/**
+ * Default rules:
+ * 
+ * [
+ *     'yoda_style' => [
+ *         'always_move_variable' => true,
+ *         'equal' => true,
+ *         'identical' => true,
+ *         'less_and_greater' => true,
+ *     ],
+ *     'binary_operator_spaces' => [
+ *         'default' => 'single_space',
+ *         'operators' => [
+ *             '=>' => null,
+ *             '|' => 'no_space',
+ *         ],
+ *     ],
+ * ]
+ */
+
+return \Yard\PhpCsFixerRules\Config::create($finder)
+    ->mergeRules([
+        'yoda_style' => [
+            'equal' => false,
+        ],
+        'binary_operator_spaces' => [
+            'operators' => [
+                '|' => 'single_space',
+                '<>' => null,
+            ]
+        ]
+    ]); 
+
+/**
+ * Expected rule set: 
+ *  
+ * [
+ *     'yoda_style' => [
+ *         'always_move_variable' => true,
+ *         'equal' => false, // this setting changed!
+ *         'identical' => true,
+ *         'less_and_greater' => true,
+ *     ],
+ *     'binary_operator_spaces' => [
+ *         'default' => 'single_space',
+ *         'operators' => [
+ *             '=>' => null,
+ *             '|' => 'single_space', // this setting changed!
+ *             '<>' => null, // this setting was added!
+ *         ],
+ *     ],
+ * ]
+ */
+
+```
+
+### Calling native PHP CS Fixer config methods
+
+[Yard\PhpCsFixerRules\Config](src/Config.php) extends the PHP CS Fixer config object so all native methods are
+available. Note that the native PHP CS Fixer methods return
+a [PhpCsFixer\ConfigInterface](./vendor/friendsofphp/php-cs-fixer/src/ConfigInterface.php) type (instead
+of [Yard\PhpCsFixerRules\Interfaces\ConfigInterface](src/Interfaces/ConfigInterface.php)).
+Your linter may not like this.
+
+```php
+
+return \Yard\PhpCsFixerRules\Config::create($finder)
+    ->setRiskyAllowed(false) // native PHP CS Fixer method
+    ->mergeRules([ // Yard\PhpCsFixerRules\Config method
+        'yoda_style' => [
+            'equal' => false,
+        ],
+        'binary_operator_spaces' => [
+            'operators' => [
+                '|' => 'single_space',
+                '<>' => null,
+            ]
+        ]
+    ]);
+```
+
+## Older projects and risky fixers
+
+`RiskyAllowed` is set to [true](config/rules.php) by default. In older projects you may need to disable it.
+
+```php
+return \Yard\PhpCsFixerRules\Config::create($finder)
+    ->setRiskyAllowed(false);
+```
+
+### setDefaultRules()
+
+`setDefaultRules(): self` gets called by the static `create(Finder $finder, string $name = 'default'): self` method.
+In normal use cases there is no need to call this method.