Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(actions): aggiunta action Run LaTex Checks on PR #49

Merged
merged 2 commits into from
Jul 30, 2023
Merged

feat(actions): aggiunta action Run LaTex Checks on PR #49

merged 2 commits into from
Jul 30, 2023

Conversation

ncvescera
Copy link
Member

@ncvescera ncvescera commented Jul 15, 2023 •
edited
Loading

Aggiunta una nuova action che effettuerà dei controlli sul codice LaTex (se presente) automatici per dare immediatamente un feedback su come è stato scritto (meno errori rilevati probabilmente indicano una buona impaginazione e scrittura del documento).

L'action inizialmente controlla se file LaTex sono stati aggiunti o modificati, se così non fosse non viene eseguito nulla.
Nel caso di modifiche o aggiunte vengono fatti partire i seguenti controlli:

  • Linter Checker(chktex): controlla la correttezza sintattica di LaTex. Rileva incorrettezze come 'usare \log invece che log', 'usare \max invece che max', 'il file LaTex che stai cercando di includere non esiste', ecc.
  • Style Checker (textidote): analizza lo stile di come è stato impaginato e scritto il documento, individua problemi del tipo: 'hai scritto il nome di una section tutto in capslock', 'questa section è troppo corta, pensa di farla diventare parte della section precedente', ecc.
  • Typo Chekcer (ltex-cli): controlla la presenza di eventuali errori grammaticali (italiani) presenti all'interno del documento.

Ho aggiunto anche titoli descrittivi per ognuna delle operazioni che questa action compie con anche emoji 🚀 .
Il risultato può essere consultato nella tab Checks di ogni pull requesrt.

Di seguito alcuni esmepi:

image
Esecuzione dove non sono stati modificati o aggiunti file LaTex

image
Esecuzione in cui sono stati trovati errori in ognuno dei SubChecks

image
Errori rilevati da chktex

image
Errori trovati da textidote

image
Errori rilevati da ltex-cli

@ncvescera
action: aggiunta action Run LaTex Linter on PR
53bb432 
Aggiunta una nuova action che è in grado di far eseguire
Chktex (linter di LaTex) sulle PR (anche provenienti da Fork).

Questa action controlla prima se sono stati aggiunti o modificati file
LaTex, nel caso esegue il linter sono su questi file.
@ncvescera ncvescera added proposta Nuova proposta per migliorare qualcosa actions Aggiornamenti e modifiche alle Actions di GitHub labels Jul 15, 2023
@ncvescera
feat(actions): aggiunti LaTex Checks SubCheks
f535e04 
Migliorata l'action che controlla i file LaTex:

- Migliorati nomi e titoli degli step con l'aggiunta di emoji 🦍🚀🎸
- Aggiunti SubCheks: ora viene fatto eseguire il linter Chktex, un
  software che controlla lo stile di come è scritto LaTex (tipo 'questa
  frase non inizia con la maiuscola' oppure 'non si mette la
  punteggiatura prima di una parentesi chiusa', ecc.) ed un software per
  l'analisi grammaticale (questo ha bisogno di un file di
  configurazione).

Questi miglioramenti sono stati effettuati per rendere più semplice
capire com'è stata scritta una certa parte in LaTex (e capire subito
quando bisognerà bestemmiare 🙃)
@ncvescera ncvescera changed the title feat(actions): aggiunta action Run LaTex Linter on PR feat(actions): aggiunta action Run LaTex Checks on PR Jul 19, 2023
@ncvescera ncvescera merged commit 905a68a into master Jul 30, 2023
@ncvescera ncvescera deleted the action/chktex branch July 30, 2023 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@CristianCosci CristianCosci CristianCosci approved these changes

@F-a-b-r-i-z-i-o F-a-b-r-i-z-i-o F-a-b-r-i-z-i-o approved these changes

@TommasoRomani TommasoRomani Awaiting requested review from TommasoRomani

@NicoloPosta NicoloPosta Awaiting requested review from NicoloPosta

Assignees

@CristianCosci CristianCosci

@TommasoRomani TommasoRomani

@NicoloPosta NicoloPosta

@F-a-b-r-i-z-i-o F-a-b-r-i-z-i-o

Labels
actions Aggiornamenti e modifiche alle Actions di GitHub proposta Nuova proposta per migliorare qualcosa
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@ncvescera @CristianCosci @F-a-b-r-i-z-i-o @TommasoRomani @NicoloPosta