# PHPでコード整形を自動化する: PHP-CS-FixerとPrettierの併用

## 1-1. はじめに
PHP開発において、コードの整形やスタイルの統一は非常に重要です。コードを整然と整えることは、読みやすさを向上させ、将来的なメンテナンスを容易にします。本記事では、人気のあるツールであるPHP-CS-FixerとPrettierを併用して、PHPコードの整形を自動化する方法を解説します。

## 1-2. 目次
1. はじめに
2. PHP-CS-Fixerとは
    - 特徴
    - インストール方法
    - 基本的な使い方
3. Prettierとは
    - 特徴
    - インストール方法
    - 基本的な使い方
4. PHP-CS-FixerとPrettierの併用
    - 併用の利点
    - 設定ファイルの作成
5. 自動化の設定
    - CI/CDとの統合
    - Git Hooksによる自動化
6. まとめ

## 2-1. PHP-CS-Fixerとは
### 2-1-1. 特徴
PHP-CS-Fixerは、PHPコードのスタイルを統一するためのツールです。多数のルールを提供しており、プロジェクトのスタイルガイドに従ってコードを整形できます。コードを整形することで、チーム内での一貫性や標準化を保つことが可能になります。

### 2-1-2. インストール方法
PHP-CS-FixerはComposerを使用して簡単にインストールできます。

![img](/mosaic-code.jpg)

### 2-1-3. 基本的な使い方
インストール後、以下のコマンドでPHP-CS-Fixerを実行できます。

![img](/mosaic-code.jpg)

これは、`src`ディレクトリ内のPHPファイルを整形します。

## 3-1. Prettierとは
### 3-1-1. 特徴
Prettierは、複数のプログラミング言語で使用できるコードフォーマッターです。シングルクォートやタブサイズなどの設定を統一し、プロジェクト内のスタイルを一貫させます。Prettierは、最小限の設定で最大の効果を発揮することを目的としています。

### 3-1-2. インストール方法
Prettierのインストールにはnpmを利用します。

![img](/mosaic-code.jpg)

### 3-1-3. 基本的な使い方
Prettierを実行してコードを整形するには、以下のコマンドを使います。

![img](/mosaic-code.jpg)

このコマンドは、`src`ディレクトリ内のすべてのPHPファイルを整形します。

## 4-1. PHP-CS-FixerとPrettierの併用
### 4-1-1. 併用の利点
PHP-CS-FixerとPrettierを併用することにより、コードのスタイルと構文の両方を整形し、一貫性を高めることができます。PHP-CS-FixerはPHP固有のスタイルに特化しており、Prettierは全体のフォーマットを均一に保ちます。

### 4-1-2. 設定ファイルの作成
PHP-CS-FixerおよびPrettierの設定ファイルをプロジェクトルートに追加することで、標準化されたスタイルガイドを適用できます。

**PHP-CS-Fixer設定例 (`.php-cs-fixer.php`)**

![img](/mosaic-code.jpg)

**Prettier設定例 (`.prettierrc`)**

![img](/mosaic-code.jpg)

## 5-1. 自動化の設定
### 5-1-1. CI/CDとの統合
CI/CDのパイプラインにPHP-CS-FixerとPrettierの実行を組み込むことで、プルリクエスト段階でコードスタイルをチェックできます。以下はGitHub Actionsの例です。

**GitHub Actions設定例 (`.github/workflows/lint.yml`)**

![img](/mosaic-code.jpg)

### 5-1-2. Git Hooksによる自動化
Git Hooksを利用して、コミット前に自動でコード整形を行うことも可能です。

**huskyを使ったGit Hooks設定**

![img](/mosaic-code.jpg)

## 6-1. まとめ
PHP-CS-FixerとPrettierを併用することで、PHPプロジェクトにおけるコード整形を自動化し、開発効率を向上させることができます。CI/CDやGit Hooksを活用して、継続的なコードスタイルの統一を実現しましょう。プロジェクトのニーズに応じて使い分けることで、質の高いコードベースを保つことが可能です。

この記事を参考に、PHPプロジェクトにおけるコード整形の自動化を始めてください。他のチームメンバーとも設定を共有し、一貫した開発体験を楽しみましょう。 [cv:issue_marketplace_engineer]

# PHPでコード整形を自動化する: PHP-CS-FixerとPrettierの併用

## 1-1. はじめに
PHP開発において、コードの整形やスタイルの統一は非常に重要です。コードを整然と整えることは、読みやすさを向上させ、将来的なメンテナンスを容易にします。本記事では、人気のあるツールであるPHP-CS-FixerとPrettierを併用して、PHPコードの整形を自動化する方法を解説します。

## 1-2. 目次
1. はじめに
2. PHP-CS-Fixerとは
    - 特徴
    - インストール方法
    - 基本的な使い方
3. Prettierとは
    - 特徴
    - インストール方法
    - 基本的な使い方
4. PHP-CS-FixerとPrettierの併用
    - 併用の利点
    - 設定ファイルの作成
5. 自動化の設定
    - CI/CDとの統合
    - Git Hooksによる自動化
6. まとめ

## 2-1. PHP-CS-Fixerとは
### 2-1-1. 特徴
PHP-CS-Fixerは、PHPコードのスタイルを統一するためのツールです。多数のルールを提供しており、プロジェクトのスタイルガイドに従ってコードを整形できます。コードを整形することで、チーム内での一貫性や標準化を保つことが可能になります。

### 2-1-2. インストール方法
PHP-CS-FixerはComposerを使用して簡単にインストールできます。

```bash
composer require --dev friendsofphp/php-cs-fixer
```

### 2-1-3. 基本的な使い方
インストール後、以下のコマンドでPHP-CS-Fixerを実行できます。

```bash
./vendor/bin/php-cs-fixer fix src
```

これは、`src`ディレクトリ内のPHPファイルを整形します。

## 3-1. Prettierとは
### 3-1-1. 特徴
Prettierは、複数のプログラミング言語で使用できるコードフォーマッターです。シングルクォートやタブサイズなどの設定を統一し、プロジェクト内のスタイルを一貫させます。Prettierは、最小限の設定で最大の効果を発揮することを目的としています。

### 3-1-2. インストール方法
Prettierのインストールにはnpmを利用します。

```bash
npm install --save-dev prettier
```

### 3-1-3. 基本的な使い方
Prettierを実行してコードを整形するには、以下のコマンドを使います。

```bash
npx prettier --write src/**/*.php
```

このコマンドは、`src`ディレクトリ内のすべてのPHPファイルを整形します。

## 4-1. PHP-CS-FixerとPrettierの併用
### 4-1-1. 併用の利点
PHP-CS-FixerとPrettierを併用することにより、コードのスタイルと構文の両方を整形し、一貫性を高めることができます。PHP-CS-FixerはPHP固有のスタイルに特化しており、Prettierは全体のフォーマットを均一に保ちます。

### 4-1-2. 設定ファイルの作成
PHP-CS-FixerおよびPrettierの設定ファイルをプロジェクトルートに追加することで、標準化されたスタイルガイドを適用できます。

**PHP-CS-Fixer設定例 (`.php-cs-fixer.php`)**

```php
<?php

return PhpCsFixer\Config::create()
    ->setRules([
        '@PSR2' => true,
        'array_syntax' => ['syntax' => 'short'],
    ])
    ->setFinder(
        PhpCsFixer\Finder::create()
            ->in(__DIR__ . '/src')
    );
```

**Prettier設定例 (`.prettierrc`)**

```json
{
    "singleQuote": true,
    "trailingComma": "es5"
}
```

## 5-1. 自動化の設定
### 5-1-1. CI/CDとの統合
CI/CDのパイプラインにPHP-CS-FixerとPrettierの実行を組み込むことで、プルリクエスト段階でコードスタイルをチェックできます。以下はGitHub Actionsの例です。

**GitHub Actions設定例 (`.github/workflows/lint.yml`)**

```yaml
name: Code Format Check

on: [push, pull_request]

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Set up PHP
        uses: shivammathur/setup-php@v2
        with:
          php-version: 8.0
      - name: Install Composer dependencies
        run: composer install --prefer-dist --no-progress --no-suggest --dev
      - name: PHP-CS-Fixer Check
        run: ./vendor/bin/php-cs-fixer fix --dry-run --stop-on-violation --using-cache=no
      - name: Set up Node.js
        uses: actions/setup-node@v2
        with:
          node-version: '14'
      - run: npm install
      - name: Prettier Check
        run: npx prettier --check "src/**/*.php"
```

### 5-1-2. Git Hooksによる自動化
Git Hooksを利用して、コミット前に自動でコード整形を行うことも可能です。

**huskyを使ったGit Hooks設定**

```bash
npm install --save-dev husky
npx husky install
npx husky add .husky/pre-commit "npx prettier --write src/**/*.php && ./vendor/bin/php-cs-fixer fix"
```

## 6-1. まとめ
PHP-CS-FixerとPrettierを併用することで、PHPプロジェクトにおけるコード整形を自動化し、開発効率を向上させることができます。CI/CDやGit Hooksを活用して、継続的なコードスタイルの統一を実現しましょう。プロジェクトのニーズに応じて使い分けることで、質の高いコードベースを保つことが可能です。

この記事を参考に、PHPプロジェクトにおけるコード整形の自動化を始めてください。他のチームメンバーとも設定を共有し、一貫した開発体験を楽しみましょう。 

PHPでコード整形を自動化する: PHP-CS-FixerとPrettierの併用

1-1. はじめに

続きを読むには単価診断を受けてください（30秒）