ocaml/dune

use a custom command to format dune files

开放

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

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

仓库指标

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

描述

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.

贡献者指南

研究方向
调查 dune 源码，了解当前如何通过 `dune build @fmt` 调用格式化以及 ocamllsp 如何触发格式化。在 `src/dune rules/format.ml` 或类似文件中查找格式化规则。确定如何在 dune project 配置中为 dune 文件添加自定义命令选项。
技术栈
无
领域
build system
议题类型
功能
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 天
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
OCamldune
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
30