merge-help-csv.py: fallback HEADER uses after/before, all module-help.csv files use preceded-by/followed-by

Abierto Apto para principiantes
  • ¿Algo no está bien?
#102 1 comentario 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
76/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Tranquilo
Stack tecnológico
python
Área
tooling

Línea de trabajo

Inspecciona las cinco copias de merge-help-csv.py enumeradas en el issue y compara su fallback HEADER con los encabezados correspondientes de module-help.csv. Ejecuta la reproducción proporcionada de blank-first-line y, después, verifica que el encabezado generado use preceded-by y followed-by en las posiciones 9–10 en todas las copias.

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

Descripción

Describe the bug

merge-help-csv.py declares its fallback HEADER with after / before in positions 9–10, but every module-help.csv in this repo uses preceded-by / followed-by. When the fallback is used, the written CSV has two misnamed columns, and any consumer reading preceded-by / followed-by finds nothing.

It's a clean internal inconsistency — verified against main @ e6935f2, all five copies of the script disagree with all five CSV assets:

merge-help-csv.py (all say after / before) module-help.csv (all say preceded-by / followed-by)
skills/bmad-module-builder/assets/standalone-module-template/ skills/module-help.csv
skills/bmad-module-builder/assets/setup-skill-template/scripts/ skills/bmad-module-builder/assets/setup-skill-template/assets/
skills/bmad-bmb-setup/scripts/ skills/bmad-bmb-setup/assets/
samples/sample-module-setup/scripts/ samples/sample-module-setup/assets/
samples/bmad-agent-dream-weaver/scripts/ samples/bmad-agent-dream-weaver/assets/

Because the two template copies are what scaffolded modules vendor, downstream modules inherit it — that's how it was found.

Steps to reproduce

The fallback is:

header = target_header if target_header else (source_header if source_header else HEADER)

Reaching it is harder than it looks, which is why this is latent rather than user-visible. read_csv_rows returns rows[0] unconditionally, so a falsy source_header normally implies an empty or missing source — which trips the sys.exit(1) just above. The one path through is a source whose first line is blank (csv.reader yields [], falsy) plus a non-existent target:

printf '\nabm,skill-a,A,1,desc,x,y,z,,,,,\n' > /tmp/src.csv
python3 merge-help-csv.py --target /tmp/fresh.csv --source /tmp/src.csv
head -1 /tmp/fresh.csv
# module,skill,display-name,menu-code,description,action,args,phase,after,before,required,output-location,outputs
#                                                                   ^^^^^ ^^^^^^

A normal merge never hits it, since either file supplies a header. So the practical cost isn't a broken install today — it's a wrong schema constant sitting in five files, which the next person to reach for HEADER (to add column validation, say) inherits.

Expected behavior

HEADER matches the schema the rest of the toolchain emits — preceded-by / followed-by in positions 9–10.

Environment

PR

Happy to open a one-line-per-file PR if that's welcome.

Additional context

Credit to @hugheba, who found this while vendoring a scaffolded module downstream and reported it at stefanoginella/auto-bmad#8 — verified by reading installed files, not static analysis. A copy of the same script in bmad-code-org/bmad-loop carries it too.

Lenguaje dominante
Python
Estrellas
220
Forks
54
Sin PR fusionados en 30 d

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 bmad-code-org/bmad-builder

Todos los issues de bmad-code-org/bmad-builder

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.