Skip to content

ローカル環境セットアップ

概要

開発環境のセットアップ手順を説明します。

前提条件

  • macOS
  • PHP(必須: PHP 8.3 以上)
  • Composer(PHP 依存パッケージ管理ツール)
  • Node.js(npm を含む、22.22.1 以上の 22 系 LTS。lint-staged 17 の要件)
  • Git(リポジトリのクローン用)
  • 上記コマンド(php / composer / node / npm / git)がターミナルから実行可能な状態であること
    • 各ツールのインストール方法は別途用意しているインストールガイドを参照してください

プロジェクトのセットアップ

1. リポジトリのクローン

bash
# HTTPSでクローン
git clone https://github.com/makinokeiichi/slot-kouryaku.git

# SSHでクローン(推奨)
git clone git@github.com:makinokeiichi/slot-kouryaku.git

cd slot-kouryaku

2. 依存関係のインストール

プロジェクトは2つのComposer環境を持っています。

ルートディレクトリ(開発ツール)

bash
# ルートディレクトリで実行
composer install

これにより以下がインストールされます:

  • PHP CodeSniffer (phpcs/phpcbf)
  • PHPStan
  • PHPUnit
  • WordPress Coding Standards

core_src(アプリケーション依存関係)

bash
# core_srcディレクトリで実行
cd core_src
composer install

PSR-4 のため composer install でオートロードは生成されます。詳細は Composer Autoload 運用ガイド を参照してください。

これにより以下がインストールされます:

  • Twig(テンプレートエンジン)
  • Monolog(ログ管理)
  • その他アプリケーション依存関係

3. インストール確認

bash
# ルートディレクトリに戻る
cd ..

# PHPCSのバージョン確認
vendor/bin/phpcs --version

# 利用可能なコーディング規約の確認(WordPressが含まれていることを確認)
vendor/bin/phpcs -i
# 出力例: The installed coding standards are MySource, PEAR, PSR1, PSR2, PSR12, Squiz, Zend, WordPress, WordPress-Core, WordPress-Docs and WordPress-Extra

# PHPStanのバージョン確認
vendor/bin/phpstan --version

# PHPUnitのバージョン確認
vendor/bin/phpunit --version

VS Code設定

1. 拡張機能のインストール

プロジェクトを開くと、右下に推奨拡張機能のインストール通知が表示されます。

必須拡張機能:

  • bmewburn.vscode-intelephense-client - PHP Language Server
  • valeryanm.vscode-phpsab - PHP Sniffer & Beautifier

推奨拡張機能:

  • esbenp.prettier-vscode - Prettier フォーマッター
  • whatwedo.twig - Twig テンプレート支援
  • mblode.twig-language-2 - Twig 言語支援
  • eamodio.gitlens - Git 支援
  • editorconfig.editorconfig - EditorConfig 支援

2. 自動フォーマット設定

.vscode/settings.json により、以下が自動設定されます:

  • 保存時自動フォーマット: Cmd+S
  • WordPress規約の自動適用
  • リアルタイムエラー表示

3. キーボードショートカット

  • Cmd+S: 保存&自動フォーマット
  • Shift+Option+F: 手動フォーマット
  • Cmd+Shift+F: PHPファイルをフォーマット
  • Cmd+Shift+L: リント実行
  • Cmd+Shift+P: コマンドパレット

コマンド一覧は コマンド一覧 を参照してください。

ローカルWordPress環境(Local)

  1. Local by Flywheel をダウンロード&インストール
  2. 新しいサイトを作成(サイト名: slotkouryaku
  3. テーマディレクトリにプロジェクトをリンク
bash
# プロジェクトのビルド
./bin/build.sh

# または手動でリンク
ln -s /path/to/slot-kouryaku "/path/to/Local Sites/slotkouryaku/app/public/wp-content/themes/cocoon-child-master/myCustom"

WP-CLI

イベントマスタのシードスクリプト(wp eval-file)や本番での操作をローカルで試すために、WP-CLI を入れておくと便利です。

次のステップ

参考資料