GrepAI 検索ブースティング

このスキルは、関連するコードパスを優先し、テスト、ドキュメント、ベンダーコードを低優先度にするためのスコアブーストの設定を扱います。

このスキルを使用する場合

• ソースコードをテストより優先する
• ベンダー/サードパーティコードを除外する
• 重要なディレクトリをブーストする
• 結果のランキングをカスタマイズする

ブースティングとは

ブースティングはファイルパスに基づいて検索スコアを修正します:

元のスコア: 0.85 (src/auth.go)
ボーナス (+10%):   0.935

元のスコア: 0.85 (tests/auth_test.go)
ペナルティ (-50%): 0.425

これにより、同様のコンテンツを持つテストより本番コードが高くランク付けされます。

設定

基本的な設定

# .grepai/config.yaml
search:
  boost:
    enabled: true
    penalties:
      - pattern: /tests/
        factor: 0.5
    bonuses:
      - pattern: /src/
        factor: 1.1

完全な設定

search:
  boost:
    enabled: true

    # スコアを減らす (factor < 1.0)
    penalties:
      # テストファイル
      - pattern: /tests/
        factor: 0.5
      - pattern: /__tests__/
        factor: 0.5
      - pattern: _test.
        factor: 0.5
      - pattern: .spec.
        factor: 0.5
      - pattern: .test.
        factor: 0.5

      # ドキュメント
      - pattern: /docs/
        factor: 0.6
      - pattern: /documentation/
        factor: 0.6

      # ベンダー/サードパーティ
      - pattern: /vendor/
        factor: 0.3
      - pattern: /node_modules/
        factor: 0.3
      - pattern: /third_party/
        factor: 0.3

      # 生成されたコード
      - pattern: /generated/
        factor: 0.4
      - pattern: .gen.
        factor: 0.4
      - pattern: .pb.go
        factor: 0.4

      # 例とサンプル
      - pattern: /examples/
        factor: 0.7
      - pattern: /samples/
        factor: 0.7

    # スコアを増やす (factor > 1.0)
    bonuses:
      # コアソースコード
      - pattern: /src/
        factor: 1.1
      - pattern: /lib/
        factor: 1.1
      - pattern: /app/
        factor: 1.1
      - pattern: /core/
        factor: 1.2
      - pattern: /internal/
        factor: 1.1

      # 重要なディレクトリ
      - pattern: /services/
        factor: 1.1
      - pattern: /handlers/
        factor: 1.1
      - pattern: /controllers/
        factor: 1.1

ファクターの動作

ファクター	効果	ユースケース
0.3	70% 削減	強いペナルティ (ベンダー)
0.5	50% 削減	中程度のペナルティ (テスト)
0.7	30% 削減	弱いペナルティ (例)
1.0	変更なし	中立
1.1	10% 増加	弱いブースト (src)
1.2	20% 増加	中程度のブースト (core)
1.5	50% 増加	強いブースト

パターンマッチング

パターンはファイルの完全なパスに対してマッチします:

/project/src/auth/middleware.go
         ^^^^
         "/src/" パターンにマッチ

パターンタイプ

パターン	マッチ	マッチしない
/tests/	src/tests/auth.go	tests.go
_test.	auth_test.go	test_auth.go
.spec.	auth.spec.ts	spec/auth.ts
/src/	project/src/main.go	resource/file.go

ランキングへの影響

ブースティングなし

スコア: 0.85 | tests/auth_test.go:10-30
スコア: 0.82 | src/auth/middleware.go:15-45
スコア: 0.80 | src/auth/jwt.go:23-55

ブースティングあり

penalties:
  - pattern: /tests/
    factor: 0.5
bonuses:
  - pattern: /src/
    factor: 1.1

スコア: 0.90 | src/auth/middleware.go:15-45  (0.82 × 1.1)
スコア: 0.88 | src/auth/jwt.go:23-55        (0.80 × 1.1)
スコア: 0.43 | tests/auth_test.go:10-30     (0.85 × 0.5)

一般的な設定

標準 (推奨)

search:
  boost:
    enabled: true
    penalties:
      - pattern: /tests/
        factor: 0.5
      - pattern: _test.
        factor: 0.5
      - pattern: .spec.
        factor: 0.5
      - pattern: /vendor/
        factor: 0.3
      - pattern: /docs/
        factor: 0.6
    bonuses:
      - pattern: /src/
        factor: 1.1
      - pattern: /lib/
        factor: 1.1

フロントエンドプロジェクト

search:
  boost:
    enabled: true
    penalties:
      - pattern: /__tests__/
        factor: 0.5
      - pattern: .test.
        factor: 0.5
      - pattern: .spec.
        factor: 0.5
      - pattern: /node_modules/
        factor: 0.3
      - pattern: .stories.
        factor: 0.6
      - pattern: /storybook/
        factor: 0.6
    bonuses:
      - pattern: /src/
        factor: 1.1
      - pattern: /components/
        factor: 1.1
      - pattern: /hooks/
        factor: 1.1

Go プロジェクト

search:
  boost:
    enabled: true
    penalties:
      - pattern: _test.go
        factor: 0.5
      - pattern: _mock.go
        factor: 0.5
      - pattern: /testdata/
        factor: 0.5
      - pattern: /vendor/
        factor: 0.3
      - pattern: .pb.go
        factor: 0.4
    bonuses:
      - pattern: /internal/
        factor: 1.1
      - pattern: /cmd/
        factor: 1.1
      - pattern: /pkg/
        factor: 1.1

Python プロジェクト

search:
  boost:
    enabled: true
    penalties:
      - pattern: /tests/
        factor: 0.5
      - pattern: test_
        factor: 0.5
      - pattern: _test.py
        factor: 0.5
      - pattern: /conftest
        factor: 0.5
      - pattern: /fixtures/
        factor: 0.6
    bonuses:
      - pattern: /src/
        factor: 1.1
      - pattern: /app/
        factor: 1.1
      - pattern: /core/
        factor: 1.2

モノレポ

search:
  boost:
    enabled: true
    penalties:
      - pattern: /tests/
        factor: 0.5
      - pattern: _test.
        factor: 0.5
      - pattern: /packages/deprecated/
        factor: 0.3
      - pattern: /packages/legacy/
        factor: 0.4
    bonuses:
      - pattern: /packages/core/
        factor: 1.2
      - pattern: /packages/api/
        factor: 1.1
      - pattern: /packages/shared/
        factor: 1.1

ブースティングの無効化

ブースティングを完全に無効化するには:

search:
  boost:
    enabled: false

または、設定ファイルから boost セクションを削除します。

ブースティング vs 除外

アプローチ	効果	ユースケース
除外	完全に除外	依存関係、ビルド出力
ペナルティ	検索可能、低ランク	テスト、ドキュメント、例
中立	デフォルトランキング	通常のソースコード
ボーナス	高ランク	コアビジネスロジック

除外 vs ペナルティの選択

• 除外: 検索したくないファイル (node_modules, .git)
• ペナルティ: たまに検索が必要なファイル (tests, docs)

設定のテスト

ブースティングを設定した後:

# 検索を実行してランキングを確認
grepai search "authentication"

# テストが適切に低優先度になっているか確認
grepai search "test authentication"  # テストが見つかるが、ランクが低い

ベストプラクティス

1. ペナルティから始める: テスト/ベンダーを最初に低優先度にする
2. ボーナスは慎重に: 本当に重要なパスのみ
3. 実際のクエリでテストする: 結果が合理的か確認
4. 過度にペナルティを与えない: テストには 0.5 で十分
5. 選択を文書化する: 設定にコメントを追加

一般的な問題

❌ 問題: テストが常に最初に表示される ✅ 解決策: テスト命名規則のペナルティパターンを追加

❌ 問題: 低優先度パスのコードが見つからない ✅ 解決策: ペナルティはランクを下げるだけで、非表示にしません。完全に除外するには ignore を使用

❌ 問題: 1.0 以上のスコアは間違っていないか ✅ 解決策: ボーナスはスコアを 1.0 以上にすることができます。これは正常です

❌ 問題: パターンがマッチしない ✅ 解決策: パターンが完全なパス内に表示されるか確認 (tests だけでなく /tests/ を使用)

出力フォーマット

ブースティング設定のステータス:

✅ 検索ブースティングが設定されました

   ステータス: 有効

   ペナルティ (5):
   - /tests/      → 0.5 (50% 削減)
   - _test.       → 0.5
   - .spec.       → 0.5
   - /vendor/     → 0.3 (70% 削減)
   - /docs/       → 0.6

   ボーナス (3):
   - /src/        → 1.1 (10% ブースト)
   - /lib/        → 1.1
   - /core/       → 1.2 (20% ブースト)

   効果: ソースコードは同様のコンテンツを持つテストより高くランク付けされます