IntelliJ IDEA 2020.3 ヘルプ

RuboCop

IntelliJ IDEA は RuboCop(英語) との統合をサポートしており、コードエディターなどで IDE 内でその違反を直すことができます。

RuboCop offense

プロジェクト全体をチェックして、すべての RuboCop 警告を単一のレポートに表示することもできます。

RuboCop inspection results

必要に応じて、標準(英語)ラッパーを有効にしてプロジェクトソースの分析に使用することができます。

RuboCop / Standard gems をインストールする

RuboCop インスペクションはデフォルトで IntelliJ IDEA で有効になっており、プロジェクトの SDK に 'rubocop' gem をインストールする必要があります。この gem がインストールされていない場合、IntelliJ IDEA はこれを行うことを提案します。

Install Rubocop

Standard を使用してプロジェクトを分析する場合は、Gemfile に「標準」gem を追加してインストールします。

RuboCop および標準インスペクションの有効化 / 無効化

RuboCop および標準インスペクションを有効または無効にするには、次の手順に従います。

  1. 設定 / 環境設定ダイアログ Ctrl+Alt+S を開きます。

  2. エディター | インスペクションページに移動し、Ruby | Gems および gem 管理RuboCop インスペクションを有効 / 無効にします。

  3. 必要に応じて、「標準」gem を使用オプションを有効にして、標準ラッパーを使用します。

    Enable Standard

エディターで RuboCop 違反を修正

RuboCop インスペクションが有効になっていると、IntelliJ IDEA はコードエディターでその違反をハイライトします。警告の説明を確認して修正するには、次の手順を実行します。

  1. ハイライトされた領域にキャレットを置き、Ctrl+F1 を押します。

    RuboCop warning in the editor
  2. 違反を修正するには、Alt+Enter を押します。ファイル内の提案されたすべての違反を修正することも、クラス違反または cop department による特定の修正のみを適用することもできます。

    Fix RuboCop offense

Rubocop インスペクションを実行する

IntelliJ IDEA を使用すると、対応するインスペクションを実行して、プロジェクト全体に対する RuboCop の違反を見つけることができます。これを行うには、以下の手順に従います。

  1. メインメニューからコード | インスペクション名を指定して実行 Ctrl+Alt+Shift+I に移動します。

  2. ポップアップで、RuboCop を見つけて Enter を押します。

  3. 実行 'RuboCop' ダイアログで、分析したいファイルの範囲を指定します。必要に応じて「標準」gem を使用を有効にしてください。OK をクリックしてください。

  4. IntelliJ IDEA があなたのプロジェクトを分析するまで待ちます。インスペクションツールウィンドウでは、自動修正可能なすべての RuboCop 違反を修正ボタンを使用して RuboCop の違反を調査し、自動修正可能なものを修正できます。

    RuboCop inspection results

    個々のファイルを調べたり、クラス違反または cop department によって特定の修正を適用することもできます。

    RuboCop inspection results

RuboCop と IDE の重大度をマップする

デフォルトでは、IntelliJ IDEA は RuboCop の重大度(英語)インスペクションの重大度を次の方法でマップします。

RuboCop の重大度 インスペクション重大度
リファクタリング、コンベンション 弱い警告
警告 警告
エラー、致命的 エラー

デフォルトのマッピングを変更するには、次の手順に従います。

  1. 設定 / 環境設定ダイアログ Ctrl+Alt+S を開きます。

  2. エディター | インスペクションページに移動し、RuboCop インスペクションを選択します。

  3. RuboCop の重大度を RuboCop の重大度マッピンググループのインスペクションの重大度にマップする方法を構成します。

    Severity mappings

.rubocop.yml

IntelliJ IDEA は .rubocop.yml(英語) ファイルで指定されたすべての設定を考慮に入れます。例: 特定の cop department のチェックを無効にした場合、エディターは対応する違反を表示しません。さらに、これらの違反は RuboCop インスペクションレポートには表示されません。

使い方: カスタムオプションで開いたファイルに対して RuboCop を実行する

現在開いているファイルに対してカスタムオプションで RuboCop を実行する必要がある場合があります。例: これは、RuboCop インスペクションが無効になっているとき、または特定の RuboCop アクションにショートカットを割り当てたいときに便利です。

この例では、現在開いているファイルのレイアウト違反を修正するための外部ツールとして RuboCop を使用する方法を示します。

カスタム RuboCop アクションを作成する

  1. 設定 / 環境設定ダイアログ Ctrl+Alt+S で、ツール | 外部ツールを選択します。

  2. the Add button をクリックして、以下の設定を指定します。

    The Edit Tool dialog
    • 名前 :IntelliJ IDEA インターフェースに表示されるメニューコマンド(ツールメニューおよびコンテキストメニュー)。

    • グループ : コマンドが属するグループの名前。既存のグループを選択するか、新しいグループの名前を入力できます。

    • プログラム :RuboCop 実行可能ファイルの名前。

    • 引数 : コマンドラインで指定するように、実行可能ファイルに渡される引数。ここでは、-x RuboCop オプションを使用して、現在のファイルのレイアウト警官のみを実行します。

    • 作業ディレクトリ : ツールが実行される現在の作業ディレクトリへのパス。

  3. OK をクリックしてツールを追加してから変更を適用します。

  4. (オプション)作成されたアクションのショートカットを割り当てます。設定 / 環境設定ダイアログ Ctrl+Alt+Sキーマップを選択し、RuboCop ノードでレイアウトを修正アクションを見つけ、ショートカットを指定します。

    Configure shortcut

カスタム RuboCop アクションを実行する

  • 作成した RuboCop アクションを実行するには、ツールメインメニューに行くか、ファイルのコンテキストメニューを使用してください。

    Run custom action

    コマンドが実行されると、その出力が実行ツールウィンドウに表示されます。

    Custom action output

関連ページ:

Ruby インタープリターを構成する

IntelliJ IDEA で Ruby プロジェクトを使用するには、必要な Ruby インタープリターを構成する必要があります。現在開いているプロジェクトまたは新しいプロジェクトの作成時にインタープリターを設定できます。Ruby インタープリターの構成は、インストール方法によって異なります。パッケージマネージャー(Ubuntu では apt、macOS では Homebrew など)または Ruby インストーラー(たとえば、Windows では RubyInstaller)を使用して Ruby をイ...

Bundler

IntelliJ IDEA は Bundler との統合をサポートし、IDE 内でアプリケーションの gem 依存関係を処理できるようにします。Bundler をインストールする:原則として、インストールされている Ruby インタープリターには Bundler がインストールされています。そうでない場合は、次のいずれかの方法でプロジェクト ZDK に Bundler をインストールできます。メインメニューからを選択します。を 2 回押し、呼び出されたポップアップでコマンドを実行します。Intell...

コードインスペクション

IntelliJ IDEA には、コンパイル前にプロジェクト内の異常コードを検出して修正する一連のコードインスペクションがあります。IDE はさまざまな問題を見つけてハイライトし、デッドコードを見つけ、可能性のあるバグを見つけ、スペルの問題、コード構造全体を改善することができます。インスペクションは、すべてのプロジェクトファイル内のコード、または特定のスコープ内のみ(たとえば、本番コード内、または変更されたファイル内)のコードをスキャンできます。すべてのインスペクションには、問題がコードに影響を...

インスペクションの重大度の構成

インスペクションの重大度は、検出されたコードの問題がプロジェクトにどれほど深刻な影響を及ぼすかを示します。すべての重要度レベルには、独自のハイライトスタイルがあります。IntelliJ IDEA には、事前定義された重大度レベルのセットがあります。エラー: 構文エラーをマークします。警告: バグを生成したり、機能拡張を必要とする可能性のあるコードフラグメントをマークします。弱い警告: 改善または最適化できるコードフラグメントをマークします(冗長コード、重複したコードフラグメントなど)。サーバーの...

キーボードショートカットを設定する

IntelliJ IDEA 標準のキーボードショートカット PDF は、公式ショートカット一覧 PDF 日本語版から入手できます。ローカルに保存しておいて活用しましょう。IntelliJ IDEA には定義済みのキーマップがいくつか含まれており、頻繁に使用するショートカットをカスタマイズできます。キーマップ構成を表示するには、設定 / 環境設定ダイアログを開き、キーマップを選択します。IntelliJ IDEA は、環境に基づいて事前定義されたキーマップを自動的に提案します。使用している OS...

外部ツール

サードパーティのアプリケーションを外部ツールとして定義し、IntelliJ IDEA から実行できます。IntelliJ IDEA を使用すると、プロジェクトから外部ツールにコンテキスト情報をコマンドライン引数(現在選択されているファイルやプロジェクトのソースパスなど)として渡し、ツールによって生成された出力を表示し、実行前にツールを起動するように構成できます。/ debug 構成など。IntelliJ IDEA に追加できる外部ツールにはいくつかの種類があります。ローカルツールは、コンピューター...