IntelliJ IDEA 2024.1 ヘルプ

EditorConfig

IntelliJ IDEA を使用すると、EditorConfig(英語) をサポートする個々のファイルセットのすべてのコードスタイル設定を管理できます。

必要なのは定義したいコードスタイルのファイルを含むルートディレクトリに .editorconfig ファイルを置くことです。プロジェクトに複数のコードスタイルがある場合(たとえば、テスト用や本番コード用)、プロジェクトの対応するフォルダーに複数の .editorconfig ファイルを含めることができます。これにより、同時に複数のコードスタイル標準に従うことができます。

.editorconfig ファイルのすべてのオプションは、現在のプロジェクトコードスタイルの上にあるすべてのサブディレクトリと同様に、それが存在するディレクトリに適用されます。親ディレクトリにある .editorconfig または他の .editorconfig ファイルで何も定義されていない場合は、現在のコードスタイルスキームから取得されます。未定義(unset)プロパティの詳細については、EditorConfig(英語) のドキュメントを参照してください。

.editorconfig ファイルのすべてのオプションは、以下のカテゴリに分類されます。

  • indent_sizeindent_style などの標準オプション(英語)。これらのオプションにはドメイン固有のプレフィックスがありません。

  • ij_ という接頭辞を持ち、すべての言語に適用可能な一般的な IntelliJ オプション

    • ij_visual_guides

    • ij_formatter_off_tag

    • ij_formatter_on_tag

    • ij_formatter_tags_enabled

    • ij_wrap_on_typing

    • ij_continuation_indent_size

    • ij_smart_tabs

  • 多くの(全部ではない)言語でサポートされている共通の IntelliJ オプション。それらは ij_any_brace_style のように、ij_any プレフィックスで始まります。

  • <lang> は言語ドメイン ID(通常は小文字の言語名)である ij_<lang>_ 接頭部で始まる IntelliJ 言語固有のオプション、たとえば ij_java_blank_lines_after_imports

すべての IntelliJ .editorconfig プロパティには、コードスタイルスキームに対応するオプションがあり、同様の名前が付いています。

.editorconfig ファイルを追加する

  1. プロジェクトツールウィンドウ(Alt+1)で、コードスタイルを定義するファイルを含むソースディレクトリを右クリックし、コンテキストメニューから新規 | EditorConfig を選択します。

  2. IntelliJ IDEA がスタブを作成するように定義するプロパティを選択するか、必要なプロパティを手動で追加するにはすべてのチェックボックスを空白のままにします。

  3. コードスタイル設定の変更が実際のソースファイルにどのように影響するかをプレビューするには、.editorconfig ファイルのガターにある the eye icon をクリックし、変更をプレビューするソースファイルを選択します。プレビューが右側に開きます。

    選択しているファイルが、the eye icon をクリックした横のマスクに対応していることを確認してください。例: [*.java] ファイルをプレビューするには、プレビューファイルの拡張子が .java である必要があります。

    プレビューペインを変更して、ソースコードに不要な変更を加えることを気にせずに構成の変更がどのように反映されるかを試すことができます。これらの変更はすべて .editorconfig ファイルを閉じると破棄されます。

エディターで現在開いているファイルに、.editorconfig ファイルのプロパティによってオーバーライドされるコードスタイルオプションがあるかどうかをすばやく確認するには、ステータスバーのインデントウィジェットを使用します。

ウィジェットの アイコンは、現在のコードスタイルスキームの一部の設定を上書きする .editorconfig ファイルがあることを示します。

Indentation widget with EditorConfig icon

ウィジェットをクリックします。

  • .editorconfig を開くをクリックして、現在作業しているファイルに影響を与える最も近い .editorconfig ファイルを開きます。

  • プロジェクト関連のファイルを表示を選択して、プロジェクト内のすべての .editorconfig ファイルのリストを開きます。

  • プロジェクトで無効にするをクリックして、プロジェクトで EditorConfig サポートを無効にし、現在のコードスタイルスキームの設定を使用します。設定で EditorConfig サポートを無効にすることもできます。

EditorConfig menu opened from the Indentation widget

コードスタイルを .editorconfig ファイルにエクスポートする

  1. Ctrl+Alt+S を押して設定を開き、エディター | コードスタイルを選択します。

  2. エクスポートするコードスタイルスキームを選択します: プロジェクトスキームまたは IDE レベルのスキームの 1 つ。

  3. the Show Scheme Actions button をクリックし、エクスポートを選択してから Editorconfig ファイルを選択します。

    Exporting code style settings as .editorconfig file
  4. ファイルを保存するフォルダーを指定します。

.editorconfig ファイルにコードスタイル設定をインポートするには、ファイルをプロジェクトツールウィンドウ (Alt+1 または表示 | ツールウィンドウ | プロジェクト ) の必要なフォルダーにドラッグします。

EditorConfig サポートを無効にする

.editorconfig 設定ファイルの作成後に IDE 設定を使用する場合は、作成した .editorconfig ファイルをプロジェクトから削除せずに EditorConfig サポートを無効にすることができます。

  1. Ctrl+Alt+S を押して設定を開き、エディター | コードスタイルを選択します。

  2. EditorConfig のサポートを有効にするチェックボックスをクリアします。

  3. 変更を適用し、ダイアログを閉じます。

関連ページ:

プラグインのインストール

プラグインは IntelliJ IDEA のコア機能を拡張します。例: プラグインをインストールして、次の機能を取得します。バージョン管理システム、課題追跡システム、ビルド管理サーバー、その他のツールとの統合。さまざまな言語とフレームワークのコーディング支援サポート。ショートカットのヒント、ライブプレビュー、ファイルウォッチャーなど。新しいプログラミング言語を学ぶのに役立つコーディング演習。プラグイン設定を開くを押して設定を開き、を選択します。マーケットプレースタブを使用して、JetBrains...

コードスタイルスキーム

IDE には、プロジェクトスキームとデフォルトスキームの 2 つの定義済みスキームが付属しています。プロジェクトスキームでは、構成する設定は現在のプロジェクトにのみ適用されます。これらの設定は、.idea の codeStyles フォルダーに保存され、VCS を介してプロジェクトと共有されます。プロジェクトのコードスタイル設定を変更すると、IDE によってフォルダーが作成されます。デフォルトスキーム(IDE レベルのスキーム)では、構成する設定は、デフォルトコードスタイルスキームが選択されている既存...

コードの整形

IntelliJ IDEA を使用すると、現在のコードスタイルスキームまたは .editorconfig ファイルで指定した要件に従ってコードを再フォーマットできます。で定義されていないものがあれば、プロジェクト設定から取得されます。コードの一部、ファイル全体、ファイルのグループ、ディレクトリ、モジュールを再フォーマットできます。コードの一部または一部のファイルを再フォーマットから除外することもできます。コードフラグメントを再フォーマットするエディターで、再フォーマットしたいコードフラグメントを選択...