Next.js-config con controllo del tipo

Come utilizzare il controllo del tipo per il tuo next.config.js

Controllo semplice del tipo per next.config.js

Questo non è tanto un vero articolo ma più una ripubblicazione di una parte della documentazione di Next.js, poiché penso che sia importante che sia condivisa. Per quanto riguarda l'utilizzo dei tipi per next.config.js, non esiste un vero supporto ufficiale da parte del team Next.js poiché l'utilizzo di un file Typescript per questa configurazione non è possibile senza alcuni hack.

Dalla versione 10.2.3, nella documentazione è disponibile il seguente frammento di codice per abilitare una semplice variante del controllo del tipo. Nota che stiamo usando Typescript, ma il file di configurazione non verrà trascritto dal bundler del progetto. La funzionalità che viene utilizzata è il tag "@type" di JSDoc per importare i tipi in un file JS.

// Add the following line at the top of the file:
// @ts-check

// Then for the config itself, import the types
// via '@type'-tag.

 /**
  * @type {import('next/dist/next-server/server/config').NextConfig}
  **/
 const nextConfig = {
   /* config options here */
 }

// End of file.
module.exports = nextConfig

Ovviamente puoi anche impostare una configurazione Typescript personalizzata e un passaggio del preprocessore per traslare la configurazione in Javascript da solo. Ma per ora, penso che non valga la pena, in quanto non esiste un supporto sostanziale per Typescript da parte dei fornitori di plug-in. Quindi, dopo tutto, ti ritroverai con i tipi per la tua configurazione di base, ma avresti comunque bisogno di "qualsiasi" per tutti gli altri plugin senza ancora i tipi.

Suggerimenti

Correlati

Addendum

Lingue