egutierrez
78d955fd72
Adds AuditDodSchema(issuesDir, flowsDir) which scans dev/issues/ and
dev/flows/ frontmatter for the new optional dod_evidence_schema: block.
Validates id uniqueness, kind in {screenshot,log,url,cmd}, expected
non-empty and required bool (default true). Tolerant to malformed YAML
and missing block.
Wires it into fn doctor dod with human-readable caveman output and
--json support.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
67 lines
3.3 KiB
Markdown
67 lines
3.3 KiB
Markdown
---
|
|
name: audit_dod_schema
|
|
kind: function
|
|
lang: go
|
|
domain: infra
|
|
version: "1.0.0"
|
|
purity: impure
|
|
signature: "func AuditDodSchema(issuesDir, flowsDir string) (DodSchemaReport, error)"
|
|
description: "Escanea dev/issues/ y dev/flows/ (incluidos subdirectorios completed/) y para cada .md parsea el bloque dod_evidence_schema del frontmatter YAML. Valida que cada item tenga id unico, kind in {screenshot,log,url,cmd}, expected no vacio y required bool (default true). Read-only: no modifica nada. Devuelve un DodSchemaReport con files (uno por archivo con items o errores), totales y conteo de items invalidos. Tolerante a frontmatter ausente o malformed — registra el error en el archivo afectado y continua."
|
|
tags: [doctor, dod, evidence, frontmatter, taxonomy, validator]
|
|
uses_functions: []
|
|
uses_types: []
|
|
returns: []
|
|
returns_optional: false
|
|
error_type: "error_go_core"
|
|
imports: ["fmt", "os", "path/filepath", "sort", "strings", "gopkg.in/yaml.v3"]
|
|
params:
|
|
- name: issuesDir
|
|
desc: "ruta absoluta al directorio dev/issues/ del registry. Vacio = skip."
|
|
- name: flowsDir
|
|
desc: "ruta absoluta al directorio dev/flows/ del registry. Vacio = skip."
|
|
output: "DodSchemaReport con Files (slice de DodSchemaIssue por archivo escaneado), TotalFiles, FilesWithItems, TotalItems, InvalidItems. Cada DodSchemaIssue contiene Path, Type (issue|flow), Items parseados y Errors validados (item-level y frontmatter-level). Error retornado solo si el WalkDir falla; archivos individuales con errores se incluyen en Files."
|
|
tested: true
|
|
tests:
|
|
- "valid dod_evidence_schema block parsed"
|
|
- "invalid kind detected"
|
|
- "duplicate id detected"
|
|
- "empty expected detected"
|
|
- "malformed yaml frontmatter does not crash"
|
|
- "file without block returns empty Items"
|
|
test_file_path: "functions/infra/audit_dod_schema_test.go"
|
|
file_path: "functions/infra/audit_dod_schema.go"
|
|
---
|
|
|
|
## Ejemplo
|
|
|
|
```go
|
|
report, err := infra.AuditDodSchema(
|
|
"/home/lucas/fn_registry/dev/issues",
|
|
"/home/lucas/fn_registry/dev/flows",
|
|
)
|
|
if err != nil {
|
|
log.Fatal(err)
|
|
}
|
|
fmt.Printf("scanned %d files, %d items, %d invalid\n",
|
|
report.TotalFiles, report.TotalItems, report.InvalidItems)
|
|
for _, f := range report.Files {
|
|
for _, e := range f.Errors {
|
|
fmt.Printf("%s: %s\n", f.Path, e)
|
|
}
|
|
}
|
|
```
|
|
|
|
## Cuando usarla
|
|
|
|
Antes de cerrar un issue o flow para confirmar que el bloque `dod_evidence_schema:` del frontmatter cumple el contrato canonico (issue 0114). La usa `fn doctor dod` para auditar todo el repo de un vistazo. Tambien util desde `/issue done` y `/flow done` para bloquear cierre si la DoD declarada tiene items invalidos.
|
|
|
|
## Gotchas
|
|
|
|
- Lee disco — clasificada `impure` aunque sea read-only. No escribe nada.
|
|
- Archivos sin frontmatter (no empiezan con `---`) se incluyen en Files con Items vacios y Errors vacios. No es error.
|
|
- Frontmatter sin bloque `dod_evidence_schema:` -> Items vacios, sin error. El bloque es opcional.
|
|
- `required:` ausente se trata como `true` (default conservador).
|
|
- README.md, INDEX.md, template.md, AGENT_GUIDE.md, TAXONOMY.md se ignoran (convencion de carpeta, no son issues/flows reales).
|
|
- Subdirectorios `completed/` se escanean igual que la raiz — un issue cerrado con DoD invalida sigue apareciendo en el reporte.
|
|
- YAML malformed no crashea — se registra como `malformed frontmatter yaml: <err>` en `Errors` del archivo y se continua.
|