コマンドラインからファイルをフォーマットする
IntelliJ IDEA は、構成されたコードスタイル設定に従ってコードをフォーマットできます。コマンドラインから指定したファイルにコードスタイルの書式を適用することもできます。
コマンドラインフォーマッタは、バックグラウンドで IntelliJ IDEA のインスタンスを起動し、フォーマットを適用します。IntelliJ IDEA の別のインスタンスがすでに実行されている場合は機能しません。この場合、実行中のインスタンスからコードスタイルのフォーマットを実行できます。コマンドラインフォーマッタを使用して、多くのコントリビューターがいる大規模なコードベースの自動定期保守を行い、一貫したコーディングスタイルを確保します。
ファイルをフォーマットできるようにするには、IntelliJ IDEA の対応するファイルタイプをサポートするプラグインをインストールして有効にします(たとえば、シェルスクリプトファイルをフォーマットするシェルスクリプトプラグイン)。
IntelliJ IDEA を実行するための実行可能ファイルは、bin のインストールディレクトリにあります。この実行可能ファイルをコマンドラインランチャーとして使用するには、コマンドラインインターフェースの説明に従って、システム PATH
に追加します。
- 構文
- idea64.exe format [<options>] <path ...>
- サンプル
デフォルトのコードスタイル設定を使用して、C:\Data\src ディレクトリから 2 つの特定のファイルをフォーマットします。
idea64.exe format -allowDefaults C:\Data\src\hello.html C:\Data\src\world.htmlデフォルトのコードスタイル設定を使用して、すべてのサブディレクトリを含む C:\Data\src ディレクトリ内のすべてのファイルを再帰的にフォーマットします。
idea64.exe format -allowDefaults -r C:\Data\srcC:\Data\settings.xml のコードスタイル設定を使用して、C:\Data\src ディレクトリ内のすべての .xml および .html ファイルを非再帰的にフォーマットします。
idea64.exe format -s C:\Data\settings.xml -m *.xml,*.html C:\Data\src
IntelliJ IDEA には、コマンドラインコードフォーマッタを実行するためのスクリプトが含まれています。デフォルトでは、アプリケーションパッケージ IntelliJ IDEA.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
IntelliJ IDEA を実行するためのスクリプトは、bin のインストールディレクトリにあります。このスクリプトをコマンドラインランチャーとして使用するには、コマンドラインインターフェースの説明に従って、システム PATH
にスクリプトを追加します。
- 構文
- idea.sh format [<options>] <path ...>
- サンプル
デフォルトのコードスタイル設定を使用して、~/Data/src ディレクトリから 2 つの特定のファイルをフォーマットします。
idea.sh format -allowDefaults ~/Data/src/hello.html ~/Data/src/world.htmlデフォルトのコードスタイル設定を使用して、すべてのサブディレクトリを含む ~/Data/src ディレクトリ内のすべてのファイルを再帰的にフォーマットします。
idea.sh format -allowDefaults -r ~/Data/src~/Data/settings.xml のコードスタイル設定を使用して、~/Data/src ディレクトリ内のすべての .xml および .html ファイルを非再帰的にフォーマットします。
idea.sh format -s ~/Data/settings.xml -m *.xml,*.html ~/Data/src
オプション
オプション | 説明 |
---|---|
| ヘルプメッセージを表示して終了します。 |
| 処理するファイルを定義するファイルマスクのコンマ区切りリストを指定します。 |
| 指定されたディレクトリを再帰的に処理します。 |
| フォーマットに使用するコードスタイル設定ファイルを指定します。これは次のいずれかです。
また、フォーマッタは親ディレクトリで .editorconfig ファイルを検索し、IntelliJ IDEA コードスタイル設定に基づいてフォーマットに適用します。この場合、EditorConfig のフォーマットがコードスタイルスキームの設定と重複する場合、IntelliJ IDEA は EditorConfig の設定を使用します。残りの設定は、コードスタイルスキームから取得されます。詳細については、EditorConfig を参照してください。 このオプションが指定されていない場合、ファイルはスキップされます。親フォルダーの 1 つにプロジェクトがある場合、その設定は EditorConfig と同様に暗黙的に使用されます。 |
| ファイルまたはファイルのグループに対してコードスタイルが定義されていない場合、つまり |
| エンコーディングを保持し、ソースファイルの読み取りと書き込みに文字セットを適用します(例: このオプションは、コマンドラインフォーマッタがソースファイル内の特殊文字を正しく処理できない場合に役立ちます。 |
| フォーマッタを検証モードで実行します。フォーマッタはメモリ内で同じフォーマット操作を実行し、フォーマットされたファイルのいずれかが元のファイルと異なる場合、ゼロ以外のステータスで終了します。 |
関連ページ:
![](https://resources.jetbrains.com/help/img/idea/2024.1/reformat-file-dialog.png)
コードの整形
IntelliJ IDEA を使用すると、現在のコードスタイルスキームまたは .editorconfig ファイルで指定した要件に従ってコードを再フォーマットできます。で定義されていないものがあれば、プロジェクト設定から取得されます。コードの一部、ファイル全体、ファイルのグループ、ディレクトリ、モジュールを再フォーマットできます。コードの一部または一部のファイルを再フォーマットから除外することもできます。コードフラグメントを再フォーマットするエディターで、再フォーマットしたいコードフラグメントを選択...
![](https://resources.jetbrains.com/help/img/idea/2024.1/toolbox_app_menu_win.png)
コマンドラインインターフェース
コマンドラインから IntelliJ IDEA 機能を使用します: ファイルとプロジェクトを開き、差分を表示し、ファイルをマージし、コードスタイルを適用し、フォーマットし、ソースコードをインスペクションします。スタンドアロンインスタンスのランチャー:インストールディレクトリには、IntelliJ IDEA を起動し、ソースコードをフォーマットし、インスペクションを実行するためのバッチスクリプトと実行可能ファイルが含まれています。コマンドプロンプト cmd.exe から使用するには、IntelliJ...
![](https://resources.jetbrains.com/help/img/idea/2024.1/ij_export_editorconfig.png)
EditorConfig
IntelliJ IDEA を使用すると、EditorConfig をサポートする個々のファイルセットのすべてのコードスタイル設定を管理できます。必要なのは定義したいコードスタイルのファイルを含むルートディレクトリに .editorconfig ファイルを置くことです。プロジェクトに複数のコードスタイルがある場合(たとえば、テスト用や本番コード用)、プロジェクトの対応するフォルダーに複数の .editorconfig ファイルを含めることができます。これにより、同時に複数のコードスタイル標準に従うことがで...
![](https://resources.jetbrains.com/help/img/idea/2024.1/first_master_commit_ij_default_merge_tool.png)
チュートリアル: IntellJ IDEA をデフォルトのコマンドラインマージツールとして使用する
IntelliJ IDEA は強力なコマンドラインマージツールとなり、バージョン管理ワークフローを改善します。このチュートリアルでは、IntelliJ IDEA をデフォルトのコマンドラインマージツールとして設定し、開発ワークフローにシームレスに統合する方法について説明します。また、IDE 内で直接競合を解決する方法についても説明します。コマンドラインからファイルをマージする方法の詳細については、コマンドラインからファイルをマージするを参照してください。前提条件:このチュートリアルに従うには、...
![](https://pleiades.io/icons/idea.png)
コマンドラインからコードインスペクションを実行する
IntelliJ IDEA はコードインスペクションを実行して、構文エラー、デッドコード、考えられるバグ、不適切なコーディングスタイル、その他の問題を見つけてハイライトします。コマンドラインから特定のプロジェクト用に構成されたすべてのインスペクションを実行し、結果をレポート付きの XML、JSON、プレーンテキストファイルとして保存することもできます。コマンドラインインスペクターは、インスペクションを実行するバックグラウンドで IntelliJ IDEA のインスタンスを起動します。Intell...