Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Re-implement and enhance `check-formatting.yml` Github Actions workflow as a Node script

Aperta
#226 0 commenti 0 reazioni 1 assegnatario Vedi su GitHub

@miorel ci sta già lavorando.

Dal 17/8/2024.

Valutazione

Questa issue non è ancora stata valutata.

Descrizione

enhancement

The workflow introduced in #225 is currently powered by a shell command, namely yarn format && git status --porcelain piped through some not very easy to maintain inline Perl.

Let's rewrite this as a Node script that's more maintainable. This is also an opportunity to address the other TODO in the workflow file, and have it output a summary as described at https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary

The general behavior of the workflow should be:

  1. Run yarn format to rewrite any files that are not correctly formatted. This part can still happen outside Node, so for example the command we run becomes something like yarn format && node some-script.js.
  2. The script basically replaces the git status --porcelain part and the subsequent Perl expression it's piped into. The script should therefore still run git status --porcelain from within Node and capture the output.
  3. For each line in the output of git status --porcelain, the script should remove the first 3 characters (see explanation of the format at https://git-scm.com/docs/git-status#_porcelain_format_version_1 to understand why) to get only the filename. It should then output an error message (using the format described at https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-an-error-message) to indicate that the file in question doesn't respect the repository's formatting rules.
  4. For bonus points (this part can be done as a separate PR) output a markdown summary at the end.
  5. If there were any files that were improperly formatted, the script should exit with a non-zero exit code so that the check fails and draws the attention of the author and reviewers.
Lingua principale
TypeScript
Stelle
20
Fork
12
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di code-chronicles-code/leetcode-curriculum

Tutte le issue di code-chronicles-code/leetcode-curriculum

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.