ocaml/dune

use a custom command to format dune files

Offen

#10.863 geöffnet am 30.08.2024

Auf GitHub ansehenContributor Guide
 (3 Kommentare) (1 Reaktion) (0 zugewiesene Personen)OCaml (478 Forks)github user discovery
help wantedproposal

Repository-Metriken

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

Beschreibung

Desired Behavior

We would like to be able to format dune files using a different tool than dune but still have dune run that tool during dune build @fmt and when requested from ocamllsp.

Example

in dune-project

(formatting
  (dune (command custom_dune_formatter %{dep})))

would lead dune to run custom_dune_formatter path/to/dune when dune tries to format path/to/dune.

Contributor Guide

Research-Richtung
Untersuchen Sie den Quellcode von dune, um zu verstehen, wie die Formatierung derzeit über `dune build @fmt` aufgerufen wird und wie ocamllsp die Formatierung auslöst. Suchen Sie nach den Formatierungsregeln in `src/dune rules/format.ml` oder ähnlichen Dateien. Bestimmen Sie, wie Sie eine Option für einen benutzerdefinierten Befehl für dune Dateien in der dune project Konfiguration hinzufügen können.
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.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
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
OCamldune
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
30