InspectCode コマンドラインツール

--project — ソリューション全体ではなく、特定のプロジェクトを分析できます。 このパラメーターの後に、ソリューション内の複数のプロジェクトに一致するプロジェクト名またはワイルドカードを入力できます。 例: --project=*Billing。

--include/--exclude — インスペクションレポートに含める / 除外するファイルを定義するファイルマスク。 --include と --exclude の両方が定義され、同じファイルセットをカバーする場合、 --exclude が優先されます。

ファイルマスクで Ant スタイルのワイルドカード(英語)を使用できます。

• ディレクトリ区切り文字を除く単一文字に一致する ?

• ディレクトリ区切り文字を除く 0 文字以上に一致する *

• ディレクトリ区切り文字を含む任意の数の文字に一致する **

• OS パス形式に関係なくディレクトリ区切り文字と一致する / または \

たとえば、パターン **Test?\**.* は次のファイルと一致します。

• C:\Projects\MyTestX\data\file_one.txt

• /home/projects/TestY/file_two.xml

だがしかし:

• C:\Projects\Test\data\file_one.txt

• /home/projects/TestY/file_two

複数のパスまたはワイルドカードを指定するには、セミコロン ; で区切るか、 --include/--exclude パラメーターを複数回使用します。

--swea と --no-swea - これらのパラメーターは ソリューション全体の分析 を明示的に有効または無効にします。 それ以外の場合、ソリューション全体の分析は既存の設定に基づいて有効または無効になります。

--severity (-e) — デフォルトでは、InspectCode は重要度レベル Suggestion以上の問題のみを報告します。 このパラメーターを使用すると、報告される最小の重大度レベルを [INFO, HINT, SUGGESTION, WARNING, ERROR] に変更できます。 例： -e=WARNING。

--dumpIssuesTypes-it — このオプションを使用すると、すべての既存 コードインスペクションを 出力にダンプできます。 このオプションは、実際の解析とは別に、つまりソリューション引数なしで利用する必要があります。

--build/--no-build — 分析を開始する前にターゲットソリューションを構築するかどうかを指定できます。 デフォルトでは、InspectCode は常にソリューションを構築します。

--target — 分析を開始する前に実行する MSBuild ターゲットを指定できます。 ターゲットソリューションのすべての .csproj ファイルで定義する必要がある任意のターゲットを指定できます。 デフォルトでは、 Build ターゲットが実行されます。

ソリューションがビルドされていない場合、つまり --no-build パラメーターが指定されている場合、 --target パラメーターは適用されません。

--properties — MSBuild のプロパティを上書きできます。 各プロパティを個別に設定するか（--properties:prop1=val1--properties:prop2=val2 ）、セミコロンを使用して複数のプロパティ --properties:prop1=val1;prop2=val2 を区切ることができます。

セミコロンは値の中で使用できないことに注意してください。例: --properties:ReferencePath="r:\reference1\;r:\reference2\"。 このような場合は、それぞれの値を別々に別の --properties パラメーターで指定してください。値は結合されます。

指定されたプロパティは、分析されたすべてのプロジェクトに適用されます。 現在、特定のプロジェクトのみにプロパティを設定する直接的な方法はありません。 回避策は、このプロジェクトでカスタムプロパティを作成し、それを目的のプロパティに割り当ててから、InspectCode パラメーターでカスタムプロパティを使用することです。

--toolset — このオプションを使うと、MSBuild バージョンを正確に指定できます。 例えば 12.0: --toolset=12.0 デフォルトでは利用可能な中で最も高い MSBuild バージョンが使用されます。 同じバージョンのインストールが複数ある場合（例えば Visual Studio 2019 の 16.0 と .NET Core 3.x の 16.0 など）、このオプションが正しく動作しない可能性があります。

--toolset-path — このオプションを使用して、MSBuild への正確なパスを指定します。 これは、カスタム MSBuild インストールがあり、それを InspectCode で使用する場合に役立ちます (例: --toolset-path="c:\tools\msbuild\bin\MsBuild.exe")。

--dotnetcore — デフォルトでは、.NET インストールは自動検出されます。 自動検出で競合が発生した場合は、このオプションを使用して特定の .NET インストールを指定できます。 .NET Core を無視するには、引数なしで使用します。 例: --dotnetcore=/usr/local/share/dotnet/dotnet

--dotnetcoresdk — このオプションを使用して、MSBuild を提供する .NET SDK バージョンを指定します。 例: .NET を SDK 5.0.100 および 6.0.302 とともにインストールした場合、InspectCode は 6.0.302 (プレビューバージョンを含む最新版) を優先します。 InspectCode を .NET SDK 5.0.100 とともに実行する場合は、コマンドラインに --dotnetcoresdk=5.0.100 を追加します。

--mono — デフォルトでは、Mono のインストールは自動検出されます。 自動検出によって競合が発生した場合は、このオプションを使用して、特定の Mono インストールを指すことができます。 Mono を無視するには、引数なしで使用してください。 例: --mono=/Library/Frameworks/Mono.framework/Versions/Current/bin/mono

--targets-for-references — プロジェクトの参照アセンブリを取得するために実行されるカスタム MSBuild ターゲットの名前。 ターゲットは、プロジェクトファイルまたは .targets ファイルのいずれかで定義されます。 複数の値はセミコロンで区切られます。 例: --targets-for-references="GetReferences"。

--targets-for-items — プロジェクトの他の項目 (たとえば、コンパイル項目) を取得するために実行されるカスタム MSBuild ターゲットの名前。 ターゲットは、プロジェクトファイルまたは .targets ファイルのいずれかで定義されます。 複数の値はセミコロンで区切られます。 例: --targets-for-items="GetCompileItems"。

--output-o — 出力ファイルを設定できます。

--format (-f) — デフォルトでは、InspectCode は出力を SARIF 形式で書き込みます。 必要に応じて、このパラメーターを使用して他の出力形式 [Html, Text, Xml] を指定できます。 例: -f=Text。

一度の実行で複数の出力成果物を生成するには、希望するフォーマットをセミコロンで区切って指定してください（例： --format=Html;Xml ）、またはこのパラメーターを複数回追加します（例： --format=Html --format=Xml）。 複数の成果物を生成する場合、 --output パラメーターでディレクトリを指定するとファイル名が自動生成されます。または、ファイル名を指定すると異なる成果物ごとに異なるファイル拡張機能が使用されます。

--jobs (-j) — デフォルトでは、InspectCode はヒューリスティックを使用してジョブを分割し、使用可能な数のスレッド / コアを使用してジョブを並列に実行します。 必要に応じて、 -j=4 などのスレッド数を制限できます。

--absolute-paths (-a) — デフォルトでは、InspectCode のレポート内のファイルは、ソリューションファイルに相対的なパスで書き込まれます。 このスイッチを使用して、レポートに絶対パスを含めることができます。

--debug (-d) — このオプションを使用して、InspectCode の実行の詳細を出力に追加します。 InspectCode に問題がある場合は、 サポートチーム(英語)に連絡するときにこれらの詳細が役立ちます。

--verbosity — デフォルトでは、InspectCode は出力にエラーメッセージのみを表示します。 このパラメーターを使用して、出力に書き込まれる情報の量を次のレベルで変更します (順序は少ないものから詳細なものへ): [OFF, FATAL, ERROR, WARN, INFO, VERBOSE, TRACE]

--LogLevel — このパラメーターを使用して、 --LogFile または --LogFolder で指定された、ログファイルに書き込まれる情報の量を制御します。 次のレベルがあります (順序は少ないものから詳細なものへ): [OFF, FATAL, ERROR, WARN, INFO, VERBOSE, TRACE].

例えば、InspectCode で問題が発生した場合は、JetBrains Rider サポートに連絡して、すべての TRACE メッセージを含むログファイルを共有できます: --LogLevel=TRACE。

--LogFile — このパラメーターを使用して、InspectCode からのメッセージのログファイルへの絶対パスを指定します。 MSBuild および Roslyn からのログも必要な場合は、代わりに --LogFolder パラメーターを使用します。

--LogFolder — このパラメーターを使用して、InspectCode からのログと MSBuild および Roslyn からのログを書き込むディレクトリへの絶対パスを指定します。 InspectCode からのログのみが必要な場合は、代わりに --LogFile パラメーターを使用します。

--caches-home — InspectCode がキャッシングするデータのカスタム保存場所を指定できます。 デフォルトでは %LOCALAPPDATA% ディレクトリが使われますが、設定ファイルがある場合はそちらの指定が優先されます。 このパラメーターは、高速 SSD をキャッシング用に使いたい場合や、ビルド処理データを一箇所に保存したい場合などに便利です。

--config-create と --config — これらのオプションで、上記のパラメーターを構成ファイル経由で渡すことができます。 最初のオプションは現在のパラメーターに基づいて構成ファイルを作成し、2 つ目のオプションはそのファイルからパラメーターを読み込みます。

--eXtensions (-x) — 指定されたプラグインをインストールして有効にします。

プラグインはその ID で指定します。ID は JetBrains Marketplace のプラグインページで、目的のプラグインを探して 概要 タブの一番下までスクロールすることで確認できます。

例: JetBrains による StyleCop(英語) プラグインのプラグイン ID は StyleCop.StyleCop であり、このプラグインで InspectCode を実行するには、コマンドラインに -x=StyleCop.StyleCop を追加する必要があります。

複数のプラグインを指定するには、それらの ID をセミコロンで区切ります。

--source — プラグインをインストールするためのカスタムパッケージソース、つまり .nupkg ファイルがあるディレクトリ（例： --source="C:\plugins" ）を指定できます。 何も指定しない場合、InspectCode は JetBrains Marketplace でプラグインを探します。

--measure — 特定のハードウェアやターゲットソリューションでツールを実行した際にパフォーマンスが充分でない場合に役立つ診断オプションです。 このオプションは次のいずれかの引数 [sampling | timeline (Windows-only) | memory] と組み合わせて使い、プロファイリングの種類を定義します。例：

実行が完了すると、問題レポートファイルに加えて、InspectCode によって実行スナップショットが作成され、スナップショットファイルへのパスが表示されます。 JetBrains ツールを使用してスナップショットを調べることができます。

• サンプリングまたは タイムラインプロファイリング: 結果の .zip ファイルを分析するには、それを解凍し、サンプリングスナップショットファイル ( .dtp ) またはタイムラインスナップショットファイル ( .dtt ) を JetBrains dotTrace で開きます。

• メモリプロファイリング: 結果の dotMemory ワークスペースファイル ( .dmw ) を分析するには、 JetBrains dotMemory で開きます。

--version (-v) — このオプションを使用して、ツールの現在のバージョンを表示して終了します。

--no-updates — デフォルトでは、InspectCode は実行ごとに更新をチェックします。 更新のチェックを無効にするには、このオプションを使用します。

--settings — デフォルトでは、存在する場合は InspectCode が 『ソリューション チーム共有』レイヤー SolutionName.DotSettings の ReSharper 設定でデフォルト設定をオーバーライドします。 必要に応じて、このパラメーターを使用して、他のすべての設定をオーバーライドする別の .DotSettings ファイルを指定できます。 たとえば、

。

--disable-settings-layers (-dsl) — 指定された 設定レイヤーを無効にします。 許容値: GlobalAll、 GlobalPerProduct、 SolutionShared、 SolutionPersonal

--no-buildin-settings — グローバル、ソリューション、プロジェクト設定レイヤーからの設定を抑制します。 --disable-settings-layers: GlobalAll; GlobalPerProduct; SolutionShared; SolutionPersonal; ProjectShared; ProjectPersonal と同等