ocaml/dune

disable auto formatting for specific dune files

Open

#10,862 opened on Aug 30, 2024

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)OCaml (478 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (1,882 stars)
PR merge metrics
 (Avg merge 1d 20h) (345 merged PRs in 30d)

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.

Contributor guide

Research direction
Identify where dune's formatting logic is implemented (likely in dune's source code) and add support for a `(formatting disabled)` stanza that prevents the file from being formatted.
Tech stack
None
Domain
build system
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Basic knowledge of dune build system
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75