ocaml/dune

disable auto formatting for specific dune files

Ouverte

#10 862 ouverte le 30 août 2024

Voir sur GitHubGuide contributeur
 (1 commentaire) (0 réaction) (0 personne assignée)OCaml (478 forks)github user discovery
enhancementhelp wanted

Métriques du dépôt

Stars
 (1 882 étoiles)
Métriques de merge PR
 (Merge moyen 1j 20h) (345 PRs mergées en 30 j)

Description

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.

Guide contributeur

Direction de recherche
Identifiez l'endroit où la logique de formatage de dune est implémentée (probablement dans le code source de dune) et ajoutez la prise en charge d'une strophe `(formatting disabled)` qui empêche le fichier d'être formaté.
Stack technique
Aucun
Domaine
build system
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Basic knowledge of dune build system
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75