Configurare il file package.json

  • 4 minuti

Benvenuti nel mondo della gestione dei progetti Node.js con npm e la gestione dei pacchetti. Verranno ora approfondite le nozioni di base della creazione di pacchetti e il modo in cui può potenziare il processo di sviluppo.

Creazione di pacchetti e gestione pacchetti

NPM, il gestore pacchetti predefinito per Node.js, è l'arma segreta per incorporare codice esterno nei progetti. È come avere un assistente personale per facilitare la creazione di applicazioni in modo più rapido ed efficiente.

La creazione di pacchetti è simile alla disposizione del codice per la distribuzione. Aggrega perfettamente il codice e le relative dipendenze in un pacchetto che altri utenti possono installare e usare facilmente. La gestione dei pacchetti è l'arte della gestione di questi pacchetti e implica:

  • Il file package.json , il progetto del progetto. È pieno di metadati relativi al progetto e si occupa della gestione delle dipendenze e dei file di pacchetto.
  • Lo strumento dell'interfaccia della riga di comando npm, un pratico strumento personale per l'installazione e la gestione dei pacchetti dal registro npm.
  • Il registro npm, un tesoro di pacchetti pubblici pronti per essere usati nei progetti.

Creare il file package.json

La creazione di un package.json oggetto è semplice come l'esecuzione del npm init comando. Esistono due modi principali per eseguire questa operazione:

  • npm init: questo comando è simile a una guida intuitiva, che consente di eseguire un processo dettagliato che richiede dettagli sul progetto, ad esempio il nome, la versione e la descrizione.
  • npm init -y: questo comando è la versione express train di npm init. Si comprime oltre le domande e compila automaticamente i valori predefiniti.

Ecco una panoramica del package.json file che verrà generato.

{
  "name": "my project",
  "version": "1.0.0",
  "description": "",
  "main": "script.js",
  "dependencies": {},
  "devDependencies": {},
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC"
}

Informazioni sulle aree del file package.json

Pensa al package.json file come un petto del tesoro, pieno di gemme preziose che danno al tuo progetto il suo scintillio. Queste gemme sono le proprietà nel package.json file e rientrano in tre categorie principali:

  • Meta-informazioni: queste proprietà sono come i gioielli della corona, definendo le meta-informazioni sul progetto. Includono il nome del progetto, la descrizione, l'autore, le parole chiave e altro ancora.
  • Dipendenze: queste sono le monete d'oro e d'argento, che rappresentano i pacchetti utilizzati dal progetto. Le dependencies proprietà e devDependencies contengono questi tesori. Man mano che si apprenderà come usare queste proprietà per installare, aggiornare e gestire le dipendenze.
  • Script: si tratta dei comandi del terminale che rendono le attività del progetto eseguite. È possibile elencare script per attività come avvio, compilazione, test e lint.

Expediate tasks with scripts (Esplora attività con script)

package.json Nel file è necessario includere almeno quattro script comuni:

  • start: questo script porta il progetto alla vita. Ad esempio, potrebbe usare il comando node ./src/index.js.
  • build: questo script prepara il progetto per il suo grande debutto. Potrebbe trasformare TypeScript in JavaScript, ad esempio.
  • test: questo script controlla l'integrità del progetto, in genere usando un pacchetto di test.
  • lint: questo script aggiorna il codice, verificando problemi di stile e formattazione usando uno strumento come ESLint.

Questi nomi di script sono come parole magiche, riconosciute universalmente nella community degli sviluppatori ed essenziali per mantenere organizzato il progetto.

Standardizzare i nomi di script

Nel file package.json gli script vengono definiti con un'azione e un comando:

"scripts" : {
  "<action>" : "<command>"
}

Ecco un esempio:

"scripts" : {
  "start" : "node ./dist/index.js",
  "test": "jest",
  "build": "tsc",
  "lint": "eslint"
}

Esegui uno script

Per eseguire uno script in un terminale immettendo il comando npm run <action>. Ad esempio, npm run lint.

Le azioni start e test sono speciali, poiché p possibile omettere la parola run nel comando. Invece di immettere il comando npm run start, è possibile immettere npm start.

Usare un ambiente di sviluppo predefinito

Questo modulo di training offre un contenitore di sviluppo, in un browser o per il computer locale. Questo contenitore fornisce tutto l'ambiente necessario per poter usare questo modulo di training senza dover installare un IDE o Node.js. Non è necessario conoscere nulla sul contenitore per completare questo modulo di training.