ocaml/dune

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

Open

#11 561 ouverte le 24 mars 2025

Voir sur GitHub
 (12 commentaires) (0 réactions) (0 assignés)OCaml (478 forks)github user discovery
good first issue

Métriques du dépôt

Stars
 (1 882 stars)
Métriques de merge PR
 (Métriques PR en attente)

Description

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

Guide contributeur

Direction de recherche
Examinez l'analyse AST de dune project et identifiez où les valeurs des champs sont vérifiées. Recherchez les motifs où une chaîne comme 'version' est utilisée dans une position qui attend un mot clé. Ajoutez une logique d'avertissement et éventuellement une suggestion de correction automatique. Testez avec les exemples du problème.
Stack technique
Aucun
Domaine
developer experiencetooling
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
3-5 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
OCaml
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65