diffplug / diffplug/spotless

Allow `npm`-Based Formatters to Pin Transitive Dependencies by Populating `overrides` in `package.json`

Aperta
#2,534 1 commento 0 reazioni 0 assegnatari Vedi su GitHub
enhancement
Lingua principale
Java
Stelle
5.6k
Fork
559
Merge medio
1g 14h
PR unite (30g)
43

Descrizione

When using an npm package to format code, and that npm package has a range dependency onto another library, the formatting output can change silently. This just happened to us: we use `prettier-plugin-sql`, which has a `^`-dependency on `sql-formatter`. `sql-formatter` released a new version that changed the formatting output, and our project’s build broke because the checked-in SQL files didn’t match the expected format.

Proposal: add the configuration method `dependencyOverrides` to `PrettierFormatterStep`. This method accepts a `Map` to populate the [`overrides` field](https://docs.npmjs.com/cli/v11/configuring-npm/package-json#overrides) in the generated `package.json`. This mechanism could work exactly like the one populating the `devDependencies`.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Individua PrettierFormatterStep e il codice che attualmente popola devDependencies nel package.json generato. Leggi come viene assemblata la configurazione del formatter, quindi verifica che dependencyOverrides venga emesso come npm overrides, mentre il comportamento esistente di devDependencies rimane invariato.

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

Valutazione

Stack tecnologico
java, javascript, sql
Ambito
build-system, tooling
Tipo di issue
Funzionalità
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.