Cómo inicialiar un proyecto con NPM

El primer paso para trabajar con un proyecto en NPM es inicializar el proyecto (lógico). Básicamente este proceso creará el fichero package.json que contiene la información sobre el proyecto, sus dependencias, scripts personalizados, entre otros aspectos importantes.

Pero no hace falta que creemos el fichero a mano. De hecho no es nada aconsejable. En su lugar, es el propio NPM el que va a crear este fichero por nosotros. Esto es lo que llamamos inicializar el proyecto. Vamos a ver cómo se haría.

En primer lugar, normalmente vamos a querer tener una carpeta para nuestro proyecto. Podemos hacerlo a través del explorador de ficheros, o mediante consola de comandos haciendo

mkdir mi-proyecto
cd mi-proyecto

Ahora, para inicializar el proyecto simplemente tenemos que ejecutar

npm init

Este comando lanza un asistente interactivo que nos va preguntando (¡un montón larguísimo!) de opciones iniciales de nuestro proyecto.

package name: (mi-proyecto)
version: (1.0.0)
description:
entry point: (index.js)
test command:
git repository:
keywords:
author:
license: (ISC)

Podemos ingresar nuestros propios valores según sea necesarios, o bien pulsar ‘Enter’ como un loco para que acepte los parámetros por defecto, hasta que acabe de preguntar cosas (que es lo que hago yo normalmente).

Una vez finalizado este proceso, se nos creerá un archivo package.json en el directorio del proyecto, el cual contendrá toda la información proporcionada durante la inicialización.

Si habéis aceptado todas las opciones por defecto, tendrá una pinta así.

{
  "name": "mi-proyecto",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": { 
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC"
}

Posteriormente, podemos modificar estos valores en el archivo package.json en cualquier momento, según nuestras necesidades. Para ello, simplemente tenemos que abrirlo con nuestro editor de texto favorito.

Por ejemplo, un fichero package.json sencillito para este ejemplo, podría tener la siguiente forma:

{
  "name": "mi-proyecto",
  "version": "1.0.0",
  "description": "Un proyecto de ejemplo",
  "author": "Tu nombre",
  "main": "index.js",
  "scripts": { 
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "license": "MIT",
  "dependencies": {
    "express": "^4.17.1"
  }
}

Dentro de este archivo, encontraremos diferentes secciones donde podemos definir información relevante para nuestro proyecto, como el nombre, versión, descripción, autor, licencia, entre otros.

Además, también encontraremos una sección llamada dependencies, donde podemos especificar las dependencias que nuestro proyecto utilizará. Pero eso lo veremos en el próximo artículo.