Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Add a one-shot map command with bounded defaults and a one-screen summary

Aperta
  • Qualcosa non va?
#76 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
go
Ambito
cli, devtools

Direzione di ricerca

Start by reading the existing analyze command and the Linguist-compatible dircue --json path, then review the map document and golden-corpus work referenced by #74 and #75. The change is done when dircue map produces deterministic schema-valid JSON, a bounded one-screen summary, and visible partial-coverage reasons with documented budget and exit-status behavior.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement follow-up

Why

The product is "one-shot profiling": a pipeline receiving many heterogeneous repositories runs one command and gets the whole map with predictable cost. Today that takes knowing roughly ten flags (analyze all --discovery --declarations --environments --projects --metrics --formats --availability --registries …). The results come back in separate sections with separate populations, and the human output is a dump:

  • analyze declarations on astral-sh/uv prints 6,210 lines.
  • analyze all on Jellyfin prints ~100 lines, most of them nuget\t<dir>.
  • analyze environments repeats "applicability follows its recorded state and condition" on every line.

Proposal

dircue map [PATH]. The name is a proposal. It should:

  • Run every cheap native observer by default: languages, discovery, components and edges, environments, deployables, declared interfaces, capabilities, formats/non-source identification, availability. Use a documented work budget (files, bytes, wall time). When the budget is hit, return partial with reasons rather than silently truncating. Expensive observers stay opt-in: the structural worker, and full-content metrics until #73 lands.
  • Accept deeper-tool results with --attach syft=sbom.json --attach noir=endpoints.json --attach sarif=analyzer.sarif … (#77), producing one map with the coverage ledger (#78).
  • Write the map document (#74) to stdout as JSON. --summary (the default on a TTY) prints a one-screen summary:
    • what it is: the content mix, with roles;
    • components by ecosystem, and the graph shape;
    • deployables and what they build/run;
    • interfaces;
    • capabilities;
    • suggested deeper analyzers and their prerequisites (#79);
    • coverage and unknowns, with the top reasons.
  • Keep the Linguist-compatible dircue --json path untouched.

Acceptance

  • On every golden-corpus entry (#75), the summary fits in about 40 lines and names the top unknowns.
  • JSON validates against the map schema, and is deterministic and portable.
  • Published time/RSS budgets per corpus entry. The kernel from Git has a stated target.
  • --budget-style overrides are explicit, and a hit budget is visible in the output and the exit status contract. Exit remains 0 for partial coverage; document how to detect it.
  • capabilities --guide leads with this command.

Related: #40 (CLI ergonomics). Epic: #81.

Lingua principale
Go
Stelle
0
Fork
0
Merge medio
4h 47m
PR unite (30g)
52

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di war-and-code/dircue

Tutte le issue di war-and-code/dircue

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.