rescript-lang / rescript-lang/rescript

formatter aggressively reformats externs into a mess

Aperta
#7,941 12 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

formatter syntax
Lingua principale
OCaml
Stelle
7.5k
Fork
485
Merge medio
1g 2h
PR unite (30g)
55

Descrizione

background: https://forum.rescript-lang.org/t/my-main-gripes-with-rescript-constructive-criticism/6981/5

right now, the formatter is ruthless in formatting. this is usually appreciated, but for externs, it becomes messy sometimes.

imagine a file such as

@module("moduleX") external f1: someType1 => someType2 = "someFunc"

@module("moduleX") external f2: anotherType1 => thirdType = "someOtherFunc"

@module("moduleX") external f3: interestingType1 => interestingType2 = "someFuncWithALongerName"

@module("moduleX") external f4: t1 => t2 = "anotherFunc"

the formatter reformats it to:

@module("moduleX") external f1: someType1 => someType2 = "someFunc"

@module("moduleX") external f2: anotherType1 => thirdType = "someOtherFunc"

@module("moduleX")
external f3: interestingType1 => interestingType2 = "someFuncWithALongerName"

@module("moduleX") external f4: t1 => t2 = "anotherFunc"

because of the different lengths. this makes the externs really difficult to parse easily by looking at them because there are often repetitions and variants in the functions, so keeping them all on the same format is easier despite some lines being a little longer than what the formatter prefers.

let's discuss potential solutions for this.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia dal comportamento del formatter e dagli esempi di extern in questo issue, poi leggi la discussione sul forum collegata riguardo alle soluzioni proposte e ai relativi compromessi. Done non è ancora definito: l’issue necessita di una regola di formattazione concordata prima che un nuovo contributore possa identificare il punto di ingresso dell’implementazione o i criteri di validazione.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
ocaml
Ambito
tooling
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.