Add --format github for inline workflow annotations

Ouverte Adaptée aux débutants
#123 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 2 jours

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
85/100
Type d'issue
Fonctionnalité
Clarté
Clairement spécifiée
Activité
Active
Stack technique
typescript
Domaine
ci-cd

Piste de recherche

Commencez dans src/cli.ts, au niveau de FORMATS et render, puis lisez src/sarif.ts pour la gestion des chemins et test/cli.test.ts pour la couverture existante de la CLI. Ajoutez la sortie de commande de workflow GitHub décrite dans l’issue, y compris la correspondance des niveaux de gravité et l’échappement, puis exécutez npm run build \u0026\u0026 npm test. Le travail est terminé lorsque chaque constat s’affiche sous forme d’annotation valide avec un chemin relatif à cwd.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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

Langage dominant
TypeScript
Étoiles
0
Forks
6
Merge moyen
1 j 21 h
PR mergées (30 j)
8

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de TMHSDigital/godot-correctness-mcp

Toutes les issues de TMHSDigital/godot-correctness-mcp

Issues similaires

Plus d'issues TypeScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.