ocaml/dune

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

Open

#11.561 aperta il 24 mar 2025

Vedi su GitHub
 (12 commenti) (0 reazioni) (0 assegnatari)OCaml (478 fork)github user discovery
good first issue

Metriche repository

Star
 (1882 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Esamina l'analisi AST di dune project e identifica dove vengono controllati i valori dei campi. Cerca modelli in cui una stringa come 'version' viene utilizzata in una posizione che richiede una parola chiave. Aggiungi logica di avviso e possibili suggerimenti di correzione automatica. Testa con gli esempi dal problema.
Tech stack
Nessuno
Dominio
developer experiencetooling
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
3-5 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
OCaml
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65