ocaml/dune

disable auto formatting for specific dune files

开放

#10,862 创建于 2024年8月30日

在 GitHub 查看贡献者指南
 (1 条评论) (0 个反应) (0 位负责人)OCaml (478 个派生)github user discovery
enhancementhelp wanted

仓库指标

星标
 (1,882 个星标)
PR 合并指标
 (平均合并 1天 20小时) (30 天内合并 345 个 PR)

描述

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.

贡献者指南

研究方向
确定 dune 格式化逻辑的实现位置（可能在 dune 的源代码中），并添加对 `(formatting disabled)` 节的支持，以防止文件被格式化。
技术栈
无
领域
build system
议题类型
功能
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
Basic knowledge of dune build system
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75