PhpStorm 2018.3ヘルプ

コマンドラインからのファイルの書式設定

コマンドラインソースコードフォーマッタはPhpStormの特別な機能で、プロジェクトの外にある任意のファイルをフォーマットすることができます。

  • コマンドラインで、次の構文を使用して format コマンドを実行します。
    format [-h] [-r|-R] [-s|-settings settingsPath] [-m|-mask masks] path1 [path2...]

    コマンドはPhpStormを起動し、指定されたファイルをフォーマットして終了します。

コマンドオプションは次のとおりです。

オプション

説明

format

<IDE_HOME>/bin ディレクトリーにある format.bat (macOSおよびLinux上のformat.sh )スクリプトへのフルパス。

-h

(オプション)ヘルプメッセージを表示して終了します。

-r|-R

(オプション) path1,path2... で指定されたディレクトリーを再帰的にスキャンします。

-s|-settings settingsPath

(オプション) settingsPathで提供されているコードスタイル設定ファイルに従ってコードをフォーマットします。次のいずれかを使用できます。
  • エクスポートされたコードスタイル設定のファイル:設定/環境設定ダイアログ(Ctrl+Alt+S)で、エディター | コード・スタイルページを開き、cogwheel black with arrowをクリックし、エクスポートを選択します。

  • プロジェクトディレクトリーに保存されている .idea/codeStyleSettings.xml ファイル(PhpStormバージョン2017.2以前の場合)。

  • プロジェクトディレクトリーに保存されている .idea/codeStyles/codeStyleConfig.xml ファイル(PhpStormバージョン2017.3以降用)。

このパラメータを省略すると、デフォルトのコードスタイル設定が使用されます。

-m|-mask masks

(オプション)処理されるファイルを定義するファイルマスクのコンマ区切りのリスト。 * (任意の文字列)および ? (任意の単一文字)ワイルドカードがサポートされています。

pathN

処理されるファイルまたはディレクトリーへのパス。

サンプル

  1. デフォルトのコードスタイル設定を使用して、すべてのサブディレクトリーを含む C:\Data\src ディレクトリー内のすべてのファイルをフォーマットします。

    <IDE_HOME>\bin\format.bat -r C:\Data\src

  2. C:\Data\settings.xmlのコードスタイル設定を使用して、C:\Data\src ディレクトリー内のすべての .xml および .html ファイルを非再帰的にフォーマットします。

    <IDE_HOME>\bin\format.bat -s C:\Data\settings.xml -m * .xml,*.html C:\Data\src

  1. デフォルトのコードスタイル設定を使用して、すべてのサブディレクトリーを含む ~/MyProject/src ディレクトリー内のすべてのファイルをフォーマットします。

    <IDE_HOME>/bin/format.sh -r ~/MyProject/src

  2. ~/Data/settings.xmlのコードスタイル設定を使用して、~/MyProject/src ディレクトリー内のすべての .xml および .html ファイルを非再帰的にフォーマットします。

    <IDE_HOME>/bin/format.sh -s ~/Data/settings.xml -m * .xml,*.html ~/MyProject/src

最終更新日: 2019年3月18日

関連事項