Aggiunge automazione per formattare il codice prima di ogni commit

[guizzo]

👋 Hello world! 🌏

Ho avuto questa pensata: perché non impostiamo un automatismo tale che ANCHE chi non ha VSCode configurato per eseguire il "format on save" comunque pusherà codice formattato?

Magari potrà tornare utile, magari non servirà affatto: nel dubbio io PR la faccio 😄

[Cadienvan]

@Balastrong ho voluto taggarti perché eri stato il primo a buttare giù un'idea di automatismo, che ne pensi?

[nicolaerario]

L'unico dettaglio che mi sento di aggiungere sull'argomento è che normalmente evito git hooks: mi rallentano nei processi di riscrittura della storia (ops... git hook... disabilita... come si fa...) piuttosto che darmi dei vantaggi reali. Potrebbe essere un mio limite, lo ammetto 😎

[Cadienvan]

E se mettessimo in piedi una Github action?
Un po' di Google e SO mi hanno portato qui, è un esempio, che ne dite?

name: Format
on:
  pull_request:
    branches: [main]
jobs:
  format:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
        with:
          ref: ${{ github.head_ref }}
      - uses: actions/setup-node@v2
        with:
          node-version: "14.x"
      - run: npm ci
      - run: npm run format
      - name: Commit changes
        uses: stefanzweifel/git-auto-commit-action@v4
        with:
          commit_message: Apply formatting changes
          branch: ${{ github.head_ref }}

[Balastrong]

Il problema della github action è che ti fa un altro commit dopo che hai pushato, quindi se dimentichi di fare pull e rifai modifiche sulle stesse parti potresti avere conflitti.

L'hook con --write non è male, capisco il discorso di @nicolaerario se l'hook ti bloccasse il commit, ma così semplicemente applica la formattazione al file in locale prima di fare il commit, quindi non dovrebbe causare nessuna interferenza.

[Balastrong]

Altra questione, se procediamo con questa PR sarebbe anche da aggiornare qua:

book/.github/workflows/formatting-validation.yml

Line 13 in bb6b6f1

run: npx prettier --check "**/*.md"

Magari con un nuovo comando su package.json chiamato format:check o qualcosa di simile che rifà prettier --check "**/*.md" usando però stessa versione di prettier del lockfile

--

Ah poi da capire se ci serve formattare tutto a prescindere . o solamente i markdown **/*.md

[mateonunez]

Credo che la soluzione ideale possa essere quella di:

• Mettere Husky sulla repository, utilizzare Prettier con il parametro --write utilizzando l'hook precommit, in questa maniera si potrà formattare il codice automaticamente prima di fare una commit oppure potrà essere lanciato manualmente (credo che debba essere definita anche la formattazione "standard" della repository).
  • format:write (o nome analogo)
• Scrivere una action di GitHub che effettui dei controlli sulla corretta formattazione del codice.
  • format:check (o nome analogo)
• Inoltre, per evitare dei push senza pull request, aggiungerei la policy direttamente sul branch principale in maniera tale che non sfugga a nessuno di fare PR.

💪

[davideimola]

Concordo con @mateonunez husky forse è la soluzione migliore così formattiamo prima di committare!

[nohant]

Non centro niente, ma la soluzione esposta da @mateonunez mi sembra quella piu corretta nella gestione di ambiente locale e integrazione con Git.

Usare l'hook del precommit evita un sacco di rotture di scatole e di rallentamenti e fa esattamente quello che volete voi.

La action è comunque comoda ma porta ogni tanto alla noia del push/pull con la pipeline

[guizzo]

Come vogliamo procedere quindi con questa PR?

Direi di definire l'approccio da seguire, per poi sistemare di conseguenza e renderlo definitivo, che dite?

[Cadienvan]

Io sono d'accordo con @mateonunez e @nohant , andrei in quella direzione e poi si può fare merge.

[guizzo]

@Cadienvan @nohant @mateonunez

Quindi, se ho capito bene:

• Installare la dipendenza husky nel progetto
• Scrivere un comando npm che vada ad eseguire la formattazione della codebase
• Impostare il comando sopracitato sull'hook pre-commit
• Scrivere una Github Action che vada ad effettuare il check sulla formattazione
• Impostare le policy sul branch main che inibiscano la possibilità di portare codice dentro senza PR

Ho capito bene? È tutto?

[Cadienvan]

Sì, direi che hai capito bene!
Come nomenclatura sono d'accordo sul chiamare i due comandi format:check e format:write, danno l'idea dell'operazione da svolgere.

La Github action già la abbiamo ma chiaramente andrà modificata perché cambia il nome del comando.

[guizzo]

@Cadienvan Ok, quindi direi che:

• Installare la dipendenza husky nel progetto
• Scrivere un comando npm che vada ad eseguire la formattazione della codebase - Lo rinomino
• Impostare il comando sopracitato sull'hook pre-commit
• Scrivere una Github Action che vada ad effettuare il check sulla formattazione - Qui ci può pensarci?
• Impostare le policy sul branch main che inibiscano la possibilità di portare codice dentro senza PR - Qui credo serva qualcuno con i permessi per operare sulle options

[guizzo]

E quindi ora:

• Installare la dipendenza husky nel progetto
• Scrivere un comando npm che vada ad eseguire la formattazione della codebase
• Impostare il comando sopracitato sull'hook pre-commit
• Scrivere una Github Action che vada ad effettuare il check sulla formattazione - Qui ci può pensarci?
• Impostare le policy sul branch main che inibiscano la possibilità di portare codice dentro senza PR

[Balastrong]

@guizzo la GitHub Action in teoria c'è già, sarebbe da aggiungere su package.json il comando format:check e richiamarlo qua

book/.github/workflows/formatting-validation.yml

Line 13 in bb6b6f1

run: npx prettier --check "**/*.md"

[Cadienvan]

Main protetto:

[elgorditosalsero]

Salve a tutti, apprezzo l'idea, ma vorrei proporre di usare lefthook al posto di Husky.

Perché?

Perché ha feature più interessanti, è più performante sotto alcuni contesti e può runnare più comandi in parallelo.

Sul resto, concordo, e posso anche prendere in carico la scrittura della action in questione, ma valuterei di switchare, in quanto potremmo sfruttare il parallelismo che offre lefthook per future implementazioni.

[guizzo]

@elgorditosalsero Quindi non ho capito, prendi in carico te lo switch verso lefthook e la lavorazione della action?

[elgorditosalsero]

Haloa 👋🏽

Ho fatto un po' di refactor, aggiungendo lefthook e rimuovendo husky.

Come git hooks ho settato:

• pre-commit: lancia la formattazione degli .MD
• pre-push: controlla che tutto sia formattato bene, sennò non ti fa pushare 🤟🏽

Ho anche refactorizzato l'action in modo che usi lo script npm.
Non dovrebbe mai fallire se si lavora localmente, dato che il pre-push dovrebbe bloccare il tutto 😄

[mateonunez]

Suggerimento: Non utilizzerei npx per avviare Prettier avendolo già installato nelle dipendenze.

[mateonunez]

Ok, credo che sia stato inserito per evitare di installare le devDeps direttamente dalla action. È strettamente necessario secondo voi?

Personalmente "normalizzerei" gli scripts in maniera tale che vengano tutti avviati in un'unica maniera.

[elgorditosalsero]

Al momento è l'unica action che abbiamo e che ha bisogno di node.

Volendo si può rimuovere node e lanciare il comando a mano, ma poi se si cambia nel package.json andrebbe cambiato anche nella actions.

Sinceramente non installerei le deps e non le metterei nemmeno in cache, o almeno, non al momento.

[corradopetrelli]

Perfetta! Gran bel lavoro!

[Cadienvan]

Bel lavoro ragazzi.

[davideimola]

LGTM!