はじめに

Laravel Pintは、ミニマリスト向けの意見を持ったPHPコードスタイルフィクサーです。PintはPHP-CS-Fixerの上に構築されており、コードスタイルをクリーンで一貫性のあるものに保つのが簡単です。

Pintはすべての新しいLaravelアプリケーションに自動的にインストールされるため、すぐに使用を開始できます。デフォルトでは、Pintは設定を必要とせず、Laravelの意見を持ったコーディングスタイルに従ってコードスタイルの問題を修正します。

インストール

Pintは最近のLaravelフレームワークのリリースに含まれているため、通常はインストールは不要です。ただし、古いアプリケーションの場合は、Composerを使用してLaravel Pintをインストールできます: 

  1. composer require laravel/pint --dev

Pintの実行

Pintにコードスタイルの問題を修正するよう指示するには、プロジェクトのvendor/binディレクトリにあるpintバイナリを呼び出します: 

  1. ./vendor/bin/pint

特定のファイルやディレクトリでPintを実行することもできます: 

  1. ./vendor/bin/pint app/Models
  3. ./vendor/bin/pint app/Models/User.php

Pintは更新されたすべてのファイルの詳細なリストを表示します。Pintの変更に関するさらに詳細な情報を表示するには、Pintを呼び出す際に-vオプションを提供します: 

  1. ./vendor/bin/pint -v

ファイルを実際に変更せずにスタイルエラーを検査したい場合は、--testオプションを使用できます。コードスタイルエラーが見つかった場合、Pintはゼロ以外の終了コードを返します: 

  1. ./vendor/bin/pint --test

Gitによる未コミットの変更があるファイルのみを修正したい場合は、--dirtyオプションを使用できます: 

  1. ./vendor/bin/pint --dirty

コードスタイルエラーがあるファイルを修正し、エラーが修正された場合はゼロ以外の終了コードで終了したい場合は、--repairオプションを使用できます: 

  1. ./vendor/bin/pint --repair

Pintの設定

前述のように、Pintは設定を必要としません。ただし、プリセット、ルール、または検査対象のフォルダーをカスタマイズしたい場合は、プロジェクトのルートディレクトリにpint.jsonファイルを作成することで行えます: 

  1. {
  2.    "preset": "laravel"
  3. }

さらに、特定のディレクトリからpint.jsonを使用したい場合は、Pintを呼び出す際に--configオプションを提供できます: 

  1. ./vendor/bin/pint --config vendor/my-company/coding-style/pint.json

プリセット

プリセットは、コードスタイルの問題を修正するために使用できるルールのセットを定義します。デフォルトでは、PintはLaravelの意見を持ったコーディングスタイルに従って問題を修正するlaravelプリセットを使用します。ただし、--presetオプションをPintに提供することで、異なるプリセットを指定できます: 

  1. ./vendor/bin/pint --preset psr12

希望する場合は、プロジェクトのpint.jsonファイルにプリセットを設定することもできます: 

  1. {
  2.    "preset": "psr12"
  3. }

現在Pintがサポートしているプリセットは、laravel、per、psr12、symfony、およびemptyです。

ルール

ルールは、Pintがコードスタイルの問題を修正するために使用するスタイルガイドラインです。前述のように、プリセットはほとんどのPHPプロジェクトに最適な事前定義されたルールのグループであるため、通常はそれらが含む個々のルールについて心配する必要はありません。

ただし、希望する場合は、pint.jsonファイルで特定のルールを有効または無効にしたり、emptyプリセットを使用してルールを最初から定義したりできます: 

  1. {
  2.    "preset": "laravel",
  3.    "rules": {
  4.    "simplified_null_return": true,
  5.    "braces": false,
  6.    "new_with_braces": {
  7.    "anonymous_class": false,
  8.    "named_class": false
  9.    }
  10.    }
  11. }

PintはPHP-CS-Fixerの上に構築されています。したがって、プロジェクト内のコードスタイルの問題を修正するために、そのルールのいずれかを使用できます: PHP-CS-Fixer Configurator。

ファイル/フォルダーの除外

デフォルトでは、Pintはプロジェクト内のすべての.phpファイルを検査しますが、vendorディレクトリ内のファイルは除外されます。さらにフォルダーを除外したい場合は、exclude設定オプションを使用して行えます: 

  1. {
  2.    "exclude": [
  3.    "my-specific/folder"
  4.    ]
  5. }

特定の名前パターンを含むすべてのファイルを除外したい場合は、notName設定オプションを使用して行えます: 

  1. {
  2.    "notName": [
  3.    "*-my-file.php"
  4.    ]
  5. }

ファイルの正確なパスを提供してファイルを除外したい場合は、notPath設定オプションを使用して行えます: 

  1. {
  2.    "notPath": [
  3.    "path/to/excluded-file.php"
  4.    ]
  5. }

継続的インテグレーション

GitHub Actions

Laravel Pintを使用してプロジェクトのリンティングを自動化するには、GitHub Actionsを設定して、新しいコードがGitHubにプッシュされるたびにPintを実行できます。まず、Settings > Actions > General > Workflow permissionsでワークフローに「読み取りおよび書き込み権限」を付与することを確認してください。次に、以下の内容で.github/workflows/lint.ymlファイルを作成します: 

  1. name: Fix Code Style
  3. on: [push]
  5. jobs:
  6.   lint:
  7.    runs-on: ubuntu-latest
  8.    strategy:
  9.    fail-fast: true
  10.    matrix:
  11.    php: [8.3]
  13.    steps:
  14.       - name: Checkout code
  15.    uses: actions/checkout@v4
  17.       - name: Setup PHP
  18.    uses: shivammathur/setup-php@v2
  19.    with:
  20.    php-version: ${{ matrix.php }}
  21.    extensions: json, dom, curl, libxml, mbstring
  22.    coverage: none
  24.       - name: Install Pint
  25.    run: composer global require laravel/pint
  27.       - name: Run Pint
  28.    run: pint
  30.       - name: Commit linted files
  31.    uses: stefanzweifel/git-auto-commit-action@v5
  32.    with:
  33.    commit_message: "Fixes coding style"