ocaml/dune

Detect common typos in metadata and attempt to guess user's intention (or at least print a hint)

Open

#11,561 创建于 2025年3月24日

在 GitHub 查看
 (12 评论) (0 反应) (0 负责人)OCaml (478 fork)github user discovery
good first issue

仓库指标

Star
 (1,882 star)
PR 合并指标
 (PR 指标待抓取)

描述

In dune-project there are many opportunities for typos that are technically correct but don't express the user's intention. Two examples:

(package
 (name foo)
 (depends
  (bar (= version))   ; should be :version
  (baz :with_test)))) ; should be :with-test

Desired Behavior

If a dune project has obvious typos it would be helpful if dune could detect this and print a warning with a suggestion of what the correct value should be.

Additionally, dune could promote the suggested changes into dune-project, or even assume the correct version and print a warning. In these two cases we should allow the user to override this behaviour just in case it's not a typo and they really want the version of their project to be "version".

贡献者指南