ocaml/dune

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

Open

#11,561 opened on 2025年3月24日

GitHub で見る
 (12 comments) (0 reactions) (0 assignees)OCaml (478 forks)github user discovery
good first issue

Repository metrics

Stars
 (1,882 stars)
PR merge metrics
 (PR metrics pending)

説明

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".

コントリビューターガイド