GrepAI 無視パターン

このスキルでは、GrepAI のインデックスから除外するファイルとディレクトリを構成するための無視パターンの設定方法を説明します。

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

• テストファイルを検索結果から除外する
• 生成されたコードまたはベンダーコードを無視する
• 不要なファイルを除外してインデックスサイズを削減する
• GrepAI がインデックスするファイルをカスタマイズする

無視パターンの仕組み

GrepAI は無視パターン用に 2 つのソースを使用します:

1. .grepai/config.yaml - 定義したカスタムパターン
2. .gitignore - 自動的に尊重されます

設定場所

# .grepai/config.yaml
ignore:
  - pattern1
  - pattern2

パターン構文

ディレクトリパターン

ignore:
  # 正確なディレクトリ名 (どこでもマッチ)
  - node_modules
  - vendor
  - __pycache__

  # 末尾にスラッシュ (明示的なディレクトリ)
  - dist/
  - build/
  - coverage/

ファイルパターン

ignore:
  # 正確なファイル名
  - package-lock.json
  - yarn.lock

  # ワイルドカードパターン
  - "*.min.js"
  - "*.min.css"
  - "*.map"
  - "*.lock"

パスパターン

ignore:
  # 部分文字列を含むパス
  - /tests/
  - /spec/
  - /__tests__/

  # 特定のパス
  - src/generated/
  - api/swagger/

Glob パターン

ignore:
  # ダブルスター (再帰的)
  - "**/test/**"
  - "**/mock/**"

  # シングルスター (単一レベル)
  - "*.test.js"
  - "*.spec.ts"
  - "*_test.go"

デフォルト無視パターン

GrepAI のデフォルト設定には以下が含まれます:

ignore:
  # バージョン管理
  - .git
  - .svn
  - .hg

  # GrepAI 自体
  - .grepai

  # パッケージマネージャー
  - node_modules
  - vendor
  - .npm
  - .yarn

  # ビルド出力
  - target
  - dist
  - build
  - out

  # キャッシュディレクトリ
  - __pycache__
  - .pytest_cache
  - .mypy_cache
  - .cache

  # フレームワーク出力
  - .next
  - .nuxt
  - .output

一般的な無視設定

JavaScript/TypeScript プロジェクト

ignore:
  - node_modules
  - dist
  - build
  - coverage
  - .nyc_output
  - "*.min.js"
  - "*.bundle.js"
  - "*.map"
  - package-lock.json
  - yarn.lock
  - pnpm-lock.yaml

Go プロジェクト

ignore:
  - vendor
  - bin
  - "*.pb.go"       # Protobuf 生成
  - "*_mock.go"     # モック
  - "mocks/"
  - go.sum

Python プロジェクト

ignore:
  - __pycache__
  - .pytest_cache
  - .mypy_cache
  - .venv
  - venv
  - env
  - "*.pyc"
  - "*.pyo"
  - .eggs
  - "*.egg-info"
  - dist
  - build

Rust プロジェクト

ignore:
  - target
  - Cargo.lock
  - "*.rlib"

Java/Kotlin プロジェクト

ignore:
  - target
  - build
  - .gradle
  - "*.class"
  - "*.jar"
  - "*.war"

モノレポ

ignore:
  # 共通
  - node_modules
  - dist
  - build
  - coverage

  # 除外する特定パッケージ
  - packages/legacy/
  - packages/deprecated/

  # 生成されたファイル
  - "**/generated/**"
  - "**/__generated__/**"

テストファイルを除外する

本番コードに検索を集中させるには:

ignore:
  # テストディレクトリ
  - tests/
  - test/
  - __tests__/
  - spec/

  # パターンによるテストファイル
  - "*.test.js"
  - "*.test.ts"
  - "*.spec.js"
  - "*.spec.ts"
  - "*_test.go"
  - "test_*.py"
  - "*_test.py"

代替案: 検索ブースティングを使用して、テストに (除外ではなく) ペナルティを与える:

search:
  boost:
    penalties:
      - pattern: /tests/
        factor: 0.5
      - pattern: _test.
        factor: 0.5

生成されたコードを除外する

ignore:
  # 生成されたマーカー
  - "**/generated/**"
  - "*.generated.*"
  - "*.gen.*"

  # 特定のジェネレータ
  - "*.pb.go"           # Protobuf
  - "*.graphql.ts"      # GraphQL codegen
  - "*.d.ts"            # TypeScript 宣言
  - "swagger_*.go"      # Swagger
  - "openapi_*.ts"      # OpenAPI

ドキュメントを除外する

ignore:
  - docs/
  - documentation/
  - "*.md"
  - "*.mdx"
  - "*.rst"

無視パターンを検証する

インデックスされているものを確認:

# インデックスステータスを確認
grepai status

# ファイル数を表示します
# 高すぎる場合は、より多くの無視パターンを追加してください

一般的な問題

❌ 問題: インデックスが大きすぎる ✅ 解決策: 依存関係と生成されたファイルについて、より多くの無視パターンを追加します

❌ 問題: 検索がベンダー/テストコードを返す ✅ 解決策: 無視するか、ブースティングペナルティを使用します

❌ 問題: パターンが機能しない ✅ 解決策: 構文を確認してください - 特殊文字を含むパターンには引用符を使用します:

ignore:
  - "*.min.js"  # 正しい
  - *.min.js    # YAML 解析の問題を引き起こす可能性があります

❌ 問題: 以前に無視されたファイルを含める必要がある ✅ 解決策: 無視リストから削除して grepai watch を再実行します

ベストプラクティス

1. デフォルトから開始: 必要に応じてパターンを追加します
2. 依存関係を除外: 常に node_modules、vendor などを無視します
3. ビルド出力を除外: dist、build、target
4. ロックファイルを除外: 大きく、検索に役立ちません
5. ブースティングと無視を検討: テストファイルの除外ではなくペナルティを与えます
6. 特殊文字を引用符で囲む: "*.min.js" は *.min.js ではなく

変更後の再インデックス

無視パターンを変更した後:

# 既存のデーモンを停止
grepai watch --stop

# インデックスをクリアして再開
rm .grepai/index.gob
grepai watch

出力形式

無視パターンを設定した後:

✅ Ignore Patterns Configured

   Patterns: 15 configured

   Categories:
   - Directories: node_modules, vendor, dist, build
   - File types: *.min.js, *.map, *.lock
   - Paths: /tests/, /docs/

   Also respecting: .gitignore

   Run 'grepai watch' to re-index with new patterns.