php-cs-fixer，自動修正程式碼風格

小李世界發表於2021-11-26
PHP

開始

最近在看 PHP 之道，看到 程式碼風格指南 章節的 php-cs-fixer。

php-cs-fixer，它是能夠自動幫你更改程式碼的風格。比如，寫法改為 PHP 7 以上：

  • array() 更改為 []
  • isset($var) ? $var : null 更改為 $var ?? null;
  • 等等

如果只需要自動格式化程式碼的，PhpStorm 可以開啟這個：

233

接下來講：如何開啟「儲存時，php-cs-fixer 自動更改程式碼風格」。

環境

  • PhpStorm
  • PHP 8

安裝 php-cs-fixer

這邊使用全域性安裝

composer global require friendsofphp/php-cs-fixer

參見 cs.symfony.com/doc/installation.ht...

在專案根路徑下，新建檔案：.php-cs-fixer.php，內容如下：

<?php

use PhpCsFixer\Config;
use PhpCsFixer\Finder;

$rules = [
    '@PHP80Migration' => true,

    'ordered_imports' => [
        'sort_algorithm' => 'alpha',
    ],
    'class_attributes_separation' => [
        'elements' => [
            'const' => 'one',
            'method' => 'one',
            'property' => 'one',
        ],
    ],
];

$finder = Finder::create()
    ->in([
        __DIR__.'/app',
        __DIR__.'/config',
        __DIR__.'/database',
        __DIR__.'/resources',
        __DIR__.'/routes',
        __DIR__.'/tests',
    ])
    ->name('*.php')
    ->notName('*.blade.php')
    ->ignoreDotFiles(true)
    ->ignoreVCS(true);

return (new Config())
    ->setFinder($finder)
    ->setRules($rules)
    ->setRiskyAllowed(true)
    ->setUsingCache(true);

然後在 PhpStorm 設定

233

233

  • 名稱：php-cs-fixer（自己喜歡的即可）
  • 檔案型別：PHP
  • 程式：php-cs-fixer
  • 引數：fix $FileDir$/$FileName$ -vvv –diff –config=.php-cs-fixer.php
  • 要重新整理的輸出路徑：$FileDir$/$FileName$
  • 工作目錄：$ProjectFileDir$
  • 自動儲存編輯的檔案以觸發觀察程式：去掉預設的勾選
  • 顯示控制檯：改為始終

講下可能需要講的

  • 引數：
    • 這邊使用了除錯模式 -vvv，顯示的東西比較多，後面覺得煩可以去掉
    • –diff 能夠顯示修改了什麼，見文章下的《開啟控制檯顯示後》
  • 要重新整理的輸出路徑：這個抄來的，目前效果還要驗證
  • 自動儲存編輯的檔案以觸發觀察程式：就是說，只要我們輸入什麼，它自動儲存，不需要 command + s 進行儲存就可以觸發 php-cs-fixer。個人比較習慣手動儲存，請根據喜好進行設定。
  • 顯示控制檯：配合 –diff，顯示修改了什麼東西

效果舉例

233

當我們進行儲存時，它就會自動修正程式碼，在這裡是原本就是 PHP 7 風格的程式碼：Null coalescing operator（空合併運算子），但是更進一步了，圖二為 null 合併等於運算子（null_coalesce_equal_operator）：??=。

233

在控制檯就顯示以下：

開啟控制檯顯示後

/Users/dogeow/.composer/vendor/bin/php-cs-fixer fix /Users/dogeow/PhpstormProjects/antic-api/routes/console.php -vvv --diff
Cannot load Xdebug - it was already loaded
PHP CS Fixer 3.3.2 Trinacria by Fabien Potencier and Dariusz Ruminski
Runtime: PHP 8.0.8
Loaded config default from "/Users/dogeow/PhpstormProjects/antic-api/.php-cs-fixer.php".
Using cache file ".php-cs-fixer.cache".
Paths from configuration file have been overridden by paths provided as command arguments.
F                                                                   1 / 1 (100%)
Legend: ?-unknown, I-invalid file syntax (file ignored), S-skipped (cached or empty file), .-no changes, F-fixed, E-error
   1) routes/console.php (assign_null_coalescing_to_coalesce_equal)
      ---------- begin diff ----------
--- /Users/dogeow/PhpstormProjects/antic-api/routes/console.php
+++ /Users/dogeow/PhpstormProjects/antic-api/routes/console.php
@@ -90,5 +90,5 @@
 });

 Artisan::command('test', function () {
-    $taskTag['name'] = $taskTag['name'] ?? 'url';
+    $taskTag['name'] ??= 'url';
 });

      ----------- end diff -----------


Fixed all files in 0.024 seconds, 14.000 MB memory used

程式已結束，退出程式碼為 0

當然也可以手動在命令列執行來批量修正整個app 目錄。或者使用 git 的?，提交前自動修正等。

本作品採用《CC 協議》，轉載必須註明作者和本文連結
無論在現實或是網路中，我都是孤獨的。

相關文章