無料GitHub で公開日本語紹介

ssr

IntelliJのStructural Search and Replaceパターンや検査設定を作成・変更し、検索式、置換式、対象スコープをXMLで整えます。

原文原文の説明を見る

Create or modify IntelliJ Structural Search and Replace patterns.

JetBrains/intellij-communityスター 20,664(GitHub 20,664 + cccskills 0)

実行スコア未検証

インストール方法を見る

こんなときに便利

コード構造の検査を追加したいとき
検索・置換パターンを作りたいとき
検査の対象スコープを調整したいとき

日本語での紹介

できること

IntelliJのStructural Search and Replace（コード構造に基づく検索・置換）パターンを作成・変更します。検索式や置換式、型などの制約を含むXML設定例をもとに、検査プロファイル内での配置を整えます。検査の有効状態や対象スコープを設定する方法も扱い、XML変更後に InspectionProfileConsistencyTest を実行する手順を示します。.idea 内の既存設定を確認しながら、パターンと検査設定を関連づけて更新する作業に使えます。

こんなときに便利

特定のコード構造をプロジェクト内で検出する検査を追加したいときや、見つかったコードを別の表現に置き換えるルールを作りたいときに向いています。検査を有効にする範囲をスコープごとに調整する場合にも利用できます。

使い方の例

「このコードパターンを検出するStructural Search検査を追加してください」
「検索結果を指定の式に置き換える設定を作ってください」
「検査対象のスコープを追加して整合性テストを実行してください」

注意点

.idea ディレクトリはターミナル検索で読み取る指定があります。XMLを変更した後は InspectionProfileConsistencyTest の実行が必要です。

この紹介文は、公開されている SKILL.md をもとに AI（OpenAI Codex）が作成しました。正確な仕様は下の原文を確認してください。

含まれるファイル（1）

SKILL.md3.9 KB

SKILL.md（原文）

インストールする前に、エージェントに与えられる指示の中身を確認できます。

Structural Search and Replace

You must use terminal search (ls, cat and grep) to read directory .idea. Do not use IDE search.
The contents of structural search inspections is located in .idea/inspectionProfiles/idea_default.xml
Here is an example of a Structural Search and Replace inspection:


<replaceConfiguration name="Use Strings.areSameInstance instead of =="
                      description="Comparing Strings by references usually indicate a mistake, if you really need to do this (for performance reeasons or to implement &quot;Sentinel&quot; pattern), use Strings.areSameInstance method to make the intention explicit and get rid of warning."
                      suppressId="StringEqualitySSR"
                      problemDescriptor="Use !Strings.areSameInstance instead of '!=' if you really need to compare strings by reference"
                      text="$s1$ == $s2$" recursive="false" caseInsensitive="false" type="JAVA" pattern_context="default"
                      search_injected="false" reformatAccordingToStyle="false" shortenFQN="true"
                      replacement="com.intellij.openapi.util.text.Strings.areSameInstance($s1$, $s2$)">
  <constraint name="__context__" within="" contains=""/>
  <constraint name="s1" nameOfExprType="java\.lang\.String" within="" contains=""/>
  <constraint name="s2" nameOfExprType="java\.lang\.String" within="" contains=""/>
</replaceConfiguration>

This node should be located under <inspection_tool class="SSBasedInspection" tag.

Here is an example of a Structural Search inspection:


<searchConfiguration name="Raw coroutine scope creation" uuid="e11e9d2f-7cc2-3359-a78a-24f67cbe0850"
                     description="Coroutine scope should be created:&#10;&lt;ul&gt;&#10;&lt;li&gt;by a coroutine builder (&lt;code&gt;launch&lt;/code&gt;, &lt;code&gt;async&lt;/code&gt;, &lt;code&gt;runBlockingCancellable&lt;/code&gt;);&lt;/li&gt;&#10;&lt;li&gt;by a scoping function (&lt;code&gt;withContext&lt;/code&gt;, &lt;code&gt;coroutineScope&lt;/code&gt;, &lt;code&gt;supervisorScope&lt;/code&gt;);&lt;/li&gt;&#10;&lt;li&gt;by injecting it into a service constructor;&lt;/li&gt;&#10;&lt;li&gt;by explicitly creating a child scope (&lt;code&gt;childScope&lt;/code&gt;, &lt;code&gt;namedChildScope&lt;/code&gt;)&lt;/li&gt;&#10;&lt;/ul&gt; "
                     suppressId="RAW_SCOPE_CREATION"
                     problemDescriptor="Raw scope might not be linked to any parent unintentionally (if passed context does not have any &lt;code&gt;Job&lt;/code&gt;, or if passed &lt;code&gt;Job&lt;/code&gt; does not have any parent). Use &lt;code&gt;namedChildScope()&lt;/code&gt; on some existing scope instead. If no parent is actually intended, use &lt;code&gt;GlobalScope.namedScope()&lt;/code&gt;."
                     text="CoroutineScope($args$)" recursive="true" caseInsensitive="true" type="Kotlin" pattern_context="default"
                     search_injected="false">
  <constraint name="__context__" within="" contains=""/>
  <constraint name="args" within="" contains=""/>
</searchConfiguration>

This node should be located under <inspection_tool class="SSBasedInspection" tag.

To configure the scope of inspection, you need to make changes similar to this pattern, where class is UUID of the created replace configuration.


<inspection_tool class="e5d3c6f8-12ab-4cc9-8e51-8a8f1bd1c3e2" enabled="true" level="WARNING" enabled_by_default="false">
  <scope name="IDE Testing Framework" level="WARNING" enabled="true"/>
  <scope name="Tests" level="WARNING" enabled="true"/>
  <scope name="test-framework" level="WARNING" enabled="true"/>
</inspection_tool>

You must run InspectionProfileConsistencyTest after changing xml files

レビュー

まだレビューはありません。使ってみた感想をお寄せください。

ログインなしで書き込めます。使ってみた感想、質問、動かなかった環境などを気軽にどうぞ。

まだコメントはありません。最初のコメントを書いてみませんか。

同じリポジトリのスキル