Add --format github for inline workflow annotations

Abierto Apto para principiantes
#123 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 2 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
85/100
Tipo de issue
Nueva funcionalidad
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
typescript
Área
ci-cd

Línea de trabajo

Empieza en src/cli.ts, en FORMATS y render; después, lee src/sarif.ts para el manejo de rutas y test/cli.test.ts para la cobertura existente de la CLI. Añade la salida de comandos de workflow de GitHub descrita en el issue, incluido el mapeo de severidades y el escape, y ejecuta npm run build \u0026\u0026 npm test. El trabajo estará terminado cuando cada hallazgo se muestre como una anotación válida con una ruta relativa a cwd.

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

Descripción

enhancement good first issue severity: medium

Summary

Add --format github that prints GitHub Actions workflow-command annotations, so findings show inline on PRs without SARIF upload. Code scanning, which SARIF upload needs, is not available on private repos without GitHub Advanced Security.

Where

  • src/cli.ts:18 (FORMATS = ["json", "pretty", "sarif"])
  • src/cli.ts:218-230 (render)

Proposal

Print one line per finding: ::error file=<path>,line=<l>,col=<c>,title=<ruleId>::<message>, mapping warning to ::warning and info to ::notice. Make the path relative to the cwd, as SARIF does. Escape %, \r, \n (and ,/: in properties) as the workflow-command spec requires.

Who benefits

Every GitHub CI user, with zero extra setup.

Getting started

  • Relevant files: src/cli.ts, src/sarif.ts (for the path handling), test/cli.test.ts
  • How to run tests: npm run build && npm test

Filed by repo-audit/full-audit at e836036. Severity: medium. Effort: S. audit-key: enhancement|src/cli.ts|FORMATS

Lenguaje dominante
TypeScript
Estrellas
0
Forks
6
Merge medio
1 d 21 h
PR fusionados (30 d)
8

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 TMHSDigital/godot-correctness-mcp

Todos los issues de TMHSDigital/godot-correctness-mcp

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.