Hex ドキュメント検索

Elixir パッケージドキュメントを検索します。ローカルソースを優先し、必要に応じて取得します。

検索場所(優先順)

1. プロジェクト deps: deps/<package>/lib/(ソースコード @moduledoc/@doc付き)、deps/<package>/doc/(生成されたHTML)
2. 取得したドキュメントキャッシュ: .hex-docs/docs/hexpm/<package>/<version>/
3. 取得したソースコードキャッシュ: .hex-packages/<package>-<version>/
4. HexDocs API: プログラム的検索(以下を参照)
5. Web 検索: site:hexdocs.pm を使用した最後の手段

ローカルでの取得

mix.lock、mix.exs からバージョンを決定するか、曖昧な場合はユーザーに確認します。

# ドキュメントを取得(.hex-docs/ に保存)
HEX_HOME=.hex-docs mix hex.docs fetch <package> <version>

# ソースコードを取得(ドキュメントが不十分または利用不可の場合)
mix hex.package fetch <package> <version> --unpack --output .hex-packages/<package>-<version>

取得が発生した場合、セッションごとに 1 回 .hex-docs/ と .hex-packages/ を .gitignore に追加することを記載してください。

HexDocs 検索 API

search.hexdocs.pm の Typesense により提供されています。

# 特定のパッケージ内で検索
curl -s "https://search.hexdocs.pm/?q=<query>&filter_by=package:=[<package>-<version>]" \
  | jq '.hits[].document | {title, doc, url}'

# すべてのパッケージ全体で検索
curl -s "https://search.hexdocs.pm/?q=<query>" \
  | jq '.hits[].document | {package, title, doc}'

レスポンスフィールド:

• package: パッケージ名
• title: モジュール/関数名
• doc: ドキュメントテキスト
• url: https://hexdocs.pm に追加するパス

バージョン解決

# mix.lock から
grep '"<package>"' mix.lock | grep -oE '[0-9]+\.[0-9]+\.[0-9]+'

# hex.pm の最新版
curl -s "https://hex.pm/api/packages/<package>" | jq -r '.releases[0].version'

主な動作

• ローカル/キャッシュされた結果を優先(プロジェクトのバージョンと一致)
• 関連する場合はプロジェクトコードベースの実際の使用例を表示
• ソースコードについて file:line 参照を含める
• 外部パッケージを取得する前にユーザーに確認
• ソースコードの @moduledoc/@doc は HTML ドキュメントより詳細であることが多い