コマンドラインからファイルをフォーマットする
PhpStorm は、設定されたコードスタイル設定に従って コードをフォーマットできます。 コマンドラインから指定したファイルにコードスタイルの書式を適用することもできます。
コマンドラインフォーマッターは、バックグラウンドで PhpStorm のインスタンスを起動し、フォーマットを適用します。 PhpStorm の別のインスタンスがすでに実行されている場合は機能しません。 この場合、実行中のインスタンスからコードスタイルのフォーマットを実行できます。 コマンドラインフォーマッタを使用して、多くのコントリビューターがいる大規模なコードベースの自動定期保守を行い、一貫したコーディングスタイルを確保します。
ファイルをフォーマットできるようにするには、PhpStorm の対応するファイルタイプをサポートするプラグインをインストールして有効化します(たとえば、シェルスクリプトファイルをフォーマットする シェルスクリプトプラグイン)。
PhpStorm を実行するための実行可能ファイルは、 インストールディレクトリの bin にあります。 この実行可能ファイルをコマンドラインランチャーとして使用するには、システムの PATH に、 コマンドラインインターフェース の説明どおりに追加してください。
- 構文
- phpstorm64.exe format [<options>] <path ...>
- サンプル
デフォルトのコードスタイル設定を使用して、 C:\Data\src ディレクトリから 2 つの特定のファイルをフォーマットします。
phpstorm64.exe format -allowDefaults C:\Data\src\hello.html C:\Data\src\world.htmlデフォルトのコードスタイル設定を使用して、すべてのサブディレクトリを含む C:\Data\src ディレクトリ内のすべてのファイルを再帰的にフォーマットします。
phpstorm64.exe format -allowDefaults -r C:\Data\srcC:\Data\settings.xml のコードスタイル設定を使用して、 C:\Data\src ディレクトリ内のすべての .xml および .html ファイルを非再帰的にフォーマットします。
phpstorm64.exe format -s C:\Data\settings.xml -m *.xml,*.html C:\Data\src
PhpStorm には、コマンドラインコードフォーマッターを実行するためのスクリプトが含まれています。 デフォルトでは、アプリケーションパッケージ IntelliJ IDEA Ultimate.app/Contents/bin/format.sh にあります。
- 構文
- ./format.sh [<options>] <path ...>
- サンプル
デフォルトのコードスタイル設定を使用して、 ~/Data/src ディレクトリから 2 つの特定のファイルをフォーマットします。
./format.sh -allowDefaults ~/Data/src/hello.html ~/Data/src/world.htmlデフォルトのコードスタイル設定を使用して、すべてのサブディレクトリを含む ~/Data/src ディレクトリ内のすべてのファイルを再帰的にフォーマットします。
./format.sh -allowDefaults -r ~/Data/src~/Data/settings.xml のコードスタイル設定を使用して、 ~/Data/src ディレクトリ内のすべての .xml および .html ファイルを非再帰的にフォーマットします。
./format.sh -s ~/Data/settings.xml -m *.xml,*.html ~/Data/src
PhpStorm を実行するためのスクリプトは、 インストールディレクトリの bin にあります。 このスクリプトをコマンドラインランチャーとして使用するには、 PATH を コマンドラインインターフェース の説明に従ってシステムに追加してください。
- 構文
- phpstorm.sh format [<options>] <path ...>
- サンプル
デフォルトのコードスタイル設定を使用して、 ~/Data/src ディレクトリから 2 つの特定のファイルをフォーマットします。
phpstorm.sh format -allowDefaults ~/Data/src/hello.html ~/Data/src/world.htmlデフォルトのコードスタイル設定を使用して、すべてのサブディレクトリを含む ~/Data/src ディレクトリ内のすべてのファイルを再帰的にフォーマットします。
phpstorm.sh format -allowDefaults -r ~/Data/src~/Data/settings.xml のコードスタイル設定を使用して、 ~/Data/src ディレクトリ内のすべての .xml および .html ファイルを非再帰的にフォーマットします。
phpstorm.sh format -s ~/Data/settings.xml -m *.xml,*.html ~/Data/src
オプション
オプション | 説明 |
|---|---|
| ヘルプメッセージを表示して終了します。 |
| 処理するファイルを定義するファイルマスクのコンマ区切りリストを指定します。 |
| 指定されたディレクトリを再帰的に処理します。 |
| フォーマットに使用するコードスタイル設定ファイルを指定します。 これは次のいずれかです。
フォーマッターは親ディレクトリ内の .editorconfig ファイルも検索し、PhpStorm コードスタイル設定の上にフォーマットとして適用します。 この場合、EditorConfig のフォーマット設定がコードスタイルスキームの設定と重複する場合、PhpStorm は EditorConfig の設定を使用します。 残りの設定は、コードスタイルスキームから取得されます。 詳細については、 EditorConfig を参照してください。 このオプションが指定されていない場合、ファイルはスキップされます。 親フォルダーの 1 つにプロジェクトがある場合、その設定は EditorConfig と同様に暗黙的に使用されます。 |
| ファイルまたはファイルのグループに対してコードスタイルが定義されていない場合、つまり |
| エンコーディングを保持し、ソースファイルの読み取りと書き込みに文字セットを適用します(例: コマンドラインフォーマッターがソースファイル内の特殊文字を正しく処理できない場合、このオプションが役立ちます。 |
| フォーマッタを検証モードで実行します。 フォーマッタはメモリ内で同じフォーマット操作を実行し、フォーマットされたファイルのいずれかが元のファイルと異なる場合、ゼロ以外のステータスで終了します。 |