kantord/SeaGOAT

Set up automated line length formatting for YAML files

Aperta

#275 aperta il 29 set 2023

Vedi su GitHubGuida contributor
 (2 commenti) (0 reazioni) (1 assegnatario)Python (91 fork)github user discovery
good first issuehacktoberfestup for grabs

Metriche repository

Star
 (1302 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

We have rules that limit line width for YAML files, which is good, but it is annoying because it is not an autofixable error. This can be implemented on an individual basis by configuring code editors to do it, but it's much better if it's done automatically the same way all the other autoformatting/linting is done.

Here is our configuration for pre-commit: https://github.com/kantord/SeaGOAT/blob/main/.pre-commit-config.yaml, which would be the tool we need to use to implement this autoformatting.

Here is the website of pre-commit: https://pre-commit.com/

A hook should already exists for this, but if not, it can probably be manually added as pre-commit should be able to run arbitrary commands.

Guida contributor

Direzione di ricerca
Cerca hook pre commit esistenti per la formattazione della lunghezza delle righe YAML (ad esempio yamllint con autofix o uno script personalizzato) e aggiungi l'hook a .pre commit config.yaml. Se non trovato, crea uno script personalizzato che racchiuda yamllint o simile e registralo come hook.
Tech stack
Nessuno
Dominio
developer experiencebuild system
Tipo issue
Manutenzione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Gitpre commit
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85