Aggiungere pacchetti al progetto Node.js

11 minuti

Node.js include pacchetti predefiniti per attività come la gestione dei file e la gestione HTTP. Ma c'è anche una vasta gamma di pacchetti di terze parti offerti nel registro NPM.

Quando e come selezionare un pacchetto npm

In qualità di nuovo sviluppatore di Tailwind Traders, è necessario aggiungere funzionalità a un progetto. È possibile scrivere manualmente il codice, ma si decide di usare un pacchetto esistente. Questa decisione di sviluppo è uno scenario comune.

Quando è consigliabile usare un pacchetto esistente? Ecco alcuni fattori da considerare:

Qualità: per attività come la sicurezza, l'uso di pacchetti ben consolidati garantisce di seguire le procedure consigliate e gestire i casi limite.
Efficienza: la scrittura di codice personalizzato richiede tempo. L'uso di pacchetti esistenti consente di risparmiare notevoli sforzi.
Manutenzione: le librerie necessitano di aggiornamenti e correzioni di bug. Spesso è più efficiente consentire a un team open source di gestirlo.

Gli sviluppatori possono trovare e scaricare pacchetti da varie origini, ad esempio:

Registri: i registri sono raccolte di pacchetti, ad esempio il registro npm. È anche possibile ospitare il proprio registro.
Repository: è possibile installare i pacchetti direttamente da un URL di GitHub.
File: i pacchetti possono essere installati da una cartella locale o da un file compresso, utile per testare i propri pacchetti.
Directory: è anche possibile eseguire l'installazione direttamente da una directory.

Dopo aver selezionato un pacchetto, controllare le relative dipendenze per considerare i fattori seguenti:

Dimensioni: più dipendenze indicano un footprint maggiore. Le dimensioni del footprint sono importanti se sono presenti limitazioni di larghezza di banda o hardware. Tenere presente che l'installazione di un pacchetto installa anche le relative dipendenze. Ciò può comportare una cartella di node_modules di grandi dimensioni.
Popolarità: la popolarità di un pacchetto può indicare la sua qualità.
Licenze: se si prevede di vendere il software, assicurarsi che tutte le licenze dei pacchetti di dipendenza consentano di riutilizzare e rivendere.
Manutenzione attiva: evitare dipendenze deprecate o raramente aggiornate.

Per altre informazioni su un pacchetto, visitare la pagina del pacchetto in NPM e il repository GitHub. È anche possibile usare il comando npm: npm view <package name>.

Come installare un pacchetto

Per installare un pacchetto, usare l'interfaccia della riga di comando di npm installata con Node.js. È possibile aggiungere un pacchetto al progetto Node.js con il npm install comando nel terminale.

npm install <name of package>

Quando si esegue il install comando, lo strumento da riga di comando si connette a un registro globale, recupera il codice e lo inserisce in una node_modules cartella nella radice del progetto.

Alcune opzioni comuni per il comando di installazione includono:

Per i pacchetti di sola sviluppo, usare --save-dev. Questa opzione viene salvata nella devDependencies proprietà di package.json. Queste dipendenze sono in genere format, lint, build, transpile e strumenti di test.
Per i pacchetti di sola produzione, usare --production. Questa opzione esclude i pacchetti di sola sviluppo.
Per gli strumenti disponibili a livello globale, usare -g. Gli strumenti da riga di comando vengono spesso installati a livello globale anziché importati in progetti. Le dipendenze globali vengono installate in una directory a livello di sistema, non nel livello node_modulesproejct. Tuttavia, i pacchetti globali possono ingombrare il sistema. Il npx comando risolve questo problema installando temporaneamente i pacchetti. Usare npx <name> per recuperare un pacchetto, eseguirlo e quindi rimuoverlo.

Dopo l'installazione, la directory del progetto è simile all'esempio seguente:

package.json
node_modules/
  <name of dependency>/
    <files included in the dependency>
src
  index.js

Comandi dell'interfaccia della riga di comando di npm

Lo strumento da riga di comando npm include alcuni comandi che consentono di eseguire attività come l'installazione di pacchetti, la creazione di pacchetti e l'inizializzazione di progetti Node.js.

I comandi NPM rientrano nelle categorie:

Gestire le dipendenze: comandi per l'installazione, l'aggiornamento e la rimozione di pacchetti.
Eseguire script: comandi per la gestione dei flussi di sviluppo, ad esempio test e compilazione di codice.
Configurare l'ambiente: comandi per la configurazione dei percorsi di installazione e delle origini dei pacchetti.
Creare e pubblicare pacchetti: comandi per la creazione e la pubblicazione di pacchetti.

Per visualizzare un elenco dettagliato di tutti i comandi, immettere il comando seguente nel terminale:

npm --help

Verifica l'installazione

Per visualizzare le informazioni nella package.json cartella, usare npm list. Il npm list comando elenca tutti i pacchetti nella node_modules directory installata. Ogni pacchetto installato ha installato tutte le proprie dipendenze.

Poiché il list comando può comportare un lungo elenco, rendendo difficile la comprensione, è possibile elencare i pacchetti in profondità diversi con il comando list. Al livello di profondità 0, il comando elenca lo stesso contenuto presente nella sezione dependencies del file package.json.

npm list --depth=<depth>

Se è stato installato il pacchetto Jest, npm list --depth=0 genera un output simile a questo output:

├── jest@26.0.1

Pulizia delle dipendenze

Se non è più necessario un pacchetto, rimuoverlo. La rimozione di una dipendenza mantiene il progetto pulito e risparmia spazio. Questa pulizia è particolarmente importante per le applicazioni a pagina singola come Angular, React o Vue. Queste app in bundle e comprimono il codice in un file servito al browser. Più grande è il file, più tempo è necessario caricare, che può scoraggiare gli utenti.

Esistono due modi per pulire le dipendenze che non sono più necessarie: