Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

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

Abierto
  • ¿Algo no está bien?
#76 1 comentario 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
go
Área
cli, devtools

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Go
Estrellas
0
Forks
0
Merge medio
5 h 8 min
PR fusionados (30 d)
54

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de war-and-code/dircue

Todos los issues de war-and-code/dircue

Issues similares

Más issues de Go

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.