ocaml/dune

use a custom command to format dune files

Open

#10,863 opened on Aug 30, 2024

View on GitHubContributor guide
 (3 comments) (1 reaction) (0 assignees)OCaml (478 forks)github user discovery
help wantedproposal

Repository metrics

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

Description

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 direction
Investigate the dune source code to understand how formatting is currently invoked via `dune build @fmt` and how ocamllsp triggers formatting. Look for the formatting rules in `src/dune rules/format.ml` or similar files. Determine how to add an option for custom command for dune files in the dune project configuration.
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.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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
OCamldune
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30