Supported Go entry point for building a map
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 35/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
- 技術スタック
- go
- 領域
- api, cli, documentation
調査の方向性
Start by reading the wiring in internal/cli/map.go and the compatibility guidance in docs/COMPATIBILITY.md. Review the map fixtures and existing CLI behavior before deciding the public package types, compatibility promise, and runnable examples. Done means the library and CLI produce equal validated output, with a contract test and updated compatibility documentation.
索引モデルが issue の本文から書いたものです。
説明
Goal
Give Go programs a supported way to build a dircue map in-process, without shelling out to the CLI.
Current state (1.0.0)
- The module
github.com/war-and-code/dircueexposes about 29 packages underpkg/, for examplepkg/scanner.Scan,pkg/mapbuild.Buildandpkg/mapdoc. - Producing a map means wiring the scanner, the deployables and intent collectors, the source digest and document validation together. That wiring lives in
internal/cli/map.go, which outside code cannot import. - There are no library docs or examples.
docs/COMPATIBILITY.mdstates thatpkg/packages are unsupported and may change or move within 1.x.
Proposal
- Add one small public entry point, sketched below.
doc, err := dircuemap.Build(ctx, path, dircuemap.Options{...})- It returns a validated
mapdoc.Documentequal todircue map --jsonoutput for the same inputs and settings. - The same function should back the CLI, so the two can't drift.
- It returns a validated
- Decide which types the entry point exposes (the document model, options and errors), and document them with runnable examples.
- Add a contract test that compares library output with CLI output over the map fixtures.
- Decide the compatibility promise for the new package, and record it in
docs/COMPATIBILITY.md.
Out of scope
Stabilizing every pkg/ package. See the companion issue on which packages stay public.
- 主要言語
- Go
- スター
- 0
- フォーク
- 0
- 平均マージ
- 6時間 18分
- マージ済み PR（30日）
- 16
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
war-and-code/dircue のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 86/100
war-and-code/dircue#200 ·
メンテナーはふだん 1 日以内に返信
-
enhancement follow-up
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
war-and-code/dircue#201 ·
メンテナーはふだん 1 日以内に返信
-
follow-up
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
war-and-code/dircue#179 ·
メンテナーはふだん 1 日以内に返信
-
enhancement follow-up
難易度 4/5 3〜5日 初心者へのやさしさ 45/100
war-and-code/dircue#172 ·
メンテナーはふだん 1 日以内に返信
-
enhancement follow-up
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
war-and-code/dircue#171 ·
メンテナーはふだん 1 日以内に返信
war-and-code/dircue の issue をすべて見る
似ている issue
-
orchestrator: NFS-cache "cache path is not set" WARN logged on every build/launch instead of onceオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 2 日以内に返信
-
難易度 1/5 1〜3時間 初心者へのやさしさ 65/100
influxdata/telegraf#20031 ·
メンテナーはふだん 1 日以内に返信
-
pkg/registry/file no longer builds for GOOS=windows: unguarded syscall.Stat_t in qualified_resource_migration.go対応中かも @AnshulPatil2005 が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
OneBusAway/maglev#1914 ·
メンテナーはふだん 2 日以内に返信
-
[Bug] The Router doesn't log why it refused a request対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープンbug needs-acceptance wg/data-plane-networking
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
vllm-project/semantic-router#5680 ·
メンテナーはふだん 2 日以内に返信