ocaml/dune

disable auto formatting for specific dune files

Offen

#10.862 geöffnet am 30.08.2024

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)OCaml (478 Forks)github user discovery
enhancementhelp wanted

Repository-Metriken

Stars
 (1.882 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 1T 20h) (345 gemergte PRs in 30 T)

Beschreibung

Desired Behavior

In a dune file, having a stanza (formatting disabled) would ensure that the file doesn't get touched when dune build @fmt runs.

We have dune files where the content written by hand is much more readable then when it's being auto formatted. Often because of what is explained in #10861, but not only. In those cases it would be nice to be able to preserve part of a dune file or a whole dune file.

Contributor Guide

Research-Richtung
Ermitteln Sie, wo die Formatierungslogik von Dune implementiert ist (wahrscheinlich im Quellcode von Dune), und fügen Sie Unterstützung für eine `(formatting disabled)` Strophe hinzu, die verhindert, dass die Datei formatiert wird.
Tech Stack
Keine
Domain
build system
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Basic knowledge of dune build system
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75