Laravel 套件 Pint 介紹

簡介

Laravel Pint 是一款專為極簡主義者涉及的主導性 (Opinionated) PHP Code Style Fixer 程式碼風格修正程式。Pint 以 PHP-CS-Fixer 為基礎，並讓其保持簡單，以確保你的 Code Style 保持乾淨與統一。

執行 Pint

整個專案的檔案修正 Coding Style
./vendor/bin/pint

針對特定檔案或目錄來執行 Pint
./vendor/bin/pint app/Models
./vendor/bin/pint app/Models/User.php

設定 Pint

可在專案根目錄建立一個 pint.json 檔，以下是我常用的配置。

pint.json

{
    "preset": "laravel",
    "rules": {
        "phpdoc_align": {
            "align": "left"
        },
        "cast_spaces": {
            "space": "none"
        },
        "concat_space": {
            "spacing": "one"
        },
        "not_operator_with_successor_space": false
    }
}

Visual Studio Code 擴充 Laravel Pint

Visual Studio Code 有提供 Laravel Pint 擴充，你可以使用格式化文件的指令進行 Pint 格式化文件，安裝擴充後進行以下配置，因為我沒有安裝全域套件 Pint，只有在 Laravel 專案底下才會有安裝 Pint，所以我將共用的設定寫在 User Settings，在 Laravel 專案透過 Workspace Settings 進行啟動 Pint 的設定，缺點是需要在每個 Laravel 套件進行設定。

首先是 User Settings

User/setting.json

{
  "editor.formatOnSave": true
}

接下來是 Workspace Settings

.vscode/setting.json

{
  "laravel-pint.enable": true,
  "[php]": {
    "editor.defaultFormatter": "open-southeners.laravel-pint"
  }
}

設定完成之後，你就可以使用 Shift Alt F 或者是在 Windows Ctrl Shift P 或 Mac Cmd Shift P 輸入 Format document using Laravel Pint

參考

• Pint 說明文件
• Rule 查詢
• Visual Studio Code Extension Laravel Pint