NPM CheatSheet

Instalar NPM

Node.js incluye NPM automáticamente al ser instalado

Comprobar versión

Para verificar si está instalado y ver la versión.

npm --version

Listar comandos

Para listar todos los comandos npm disponibles.

npm help

Inicializar un proyecto

Para iniciar un nuevo proyecto, se utiliza npm init que crea un archivo package.json para gestionar las dependencias y configuraciones del proyecto.

npm init

Instalar todas dependencias

Instalará todas las dependencias listadas en el archivo package.json. Esto es útil cuando clonas un repositorio o compartes tu proyecto con otros.

npm install

Instalación de dependencias

Para instalar una dependencia en un proyecto.

npm install nombre-paquete

Instalación de dependencias de desarrollo

Las dependencias de desarrollo son aquellas necesarias solo para el desarrollo y pruebas del proyecto.

npm install --save-dev nombre-paquete

Actualización de dependencias

Para actualizar una dependencia a la última versión.

npm update nombre-paquete

Desinstalación de dependencias

Para desinstalar una dependencia.

npm uninstall nombre-paquete

Listado de dependencias

Para ver las dependencias instaladas.

npm list

Instalación global

Para instalar un paquete globalmente (accesible desde cualquier proyecto).

npm install -g nombre-paquete

Descripción del package.json

Contiene metadatos sobre el proyecto, como el nombre, la versión, la descripción y las dependencias del proyecto.

Ejemplo:

{
  "name": "mi-proyecto",
  "version": "1.0.0",
  "description": "Descripción de mi proyecto",
  "main": "index.js",
  "dependencies": {
    "express": "^4.17.1",
    "lodash": "^4.17.21"
  }
}

Scripts

En el archivo package.json, se pueden definir scripts personalizados que ejecuten comandos específicos.

{
  "name": "mi-proyecto",
  "scripts": {
    "start": "node index.js",
    "test": "jest"
  }
}

Para ejecutar un script:

npm run nombre-script

Instalación global de paquetes

El paquete estará disponible en todos tus proyectos y se podrá ejecutar desde cualquier directorio en tu sistema.

npm install -g nombre_paquete

Listar paquetes globales instalados

npm list -g --depth=0

Desinstalar paquete global

Para desinstalar un paquete que has instalado globalmente, puedes utilizar el siguiente comando.

npm uninstall -g nombre_paquete

NPX

Ejecutar un paquete sin instalarlo globalmente.

npx paquete_comando

Verificar detalles de un paquete

npm view nombre_paquete

Ver dependencias de un paquete

npm view nombre_paquete dependencies

Buscar paquetes en el registro de NPM

npm search palabra_clave

Verificar la lista de dependencias del proyecto

npm ls

Crear una cuenta en NPM (si no se tiene)

Crear una cuenta en NPM te permite publicar tus propios paquetes y gestionarlos desde tu perfil.

npm adduser

Iniciar sesión en NPM

Iniciar sesión en NPM es necesario para realizar acciones como publicar paquetes o acceder a tu perfil desde la línea de comandos.

npm login

Publicar un paquete en NPM

Publicar un paquete en NPM te permite compartir tu código con la comunidad y facilitar su uso por parte de otros desarrolladores.

npm publish

Actualización de un paquete publicado

Para actualizar un paquete ya publicado en NPM, primero se debe incrementar la versión y luego volver a publicarlo.

npm version tipo
npm publish

Configuración global

Para ver la configuración global de npm.

npm config list -g

Cambiar el registro (Registry)

Se puede cambiar el registro (registry) de npm, por ejemplo, a un servidor privado.

npm config set registry https://mi-registry-privado.com

Semver (Versionado semántico)

NPM utiliza Semver para gestionar las versiones de los paquetes.

• x.y.z
  • x: Versión mayor (rompe la compatibilidad con versiones anteriores).
  • y: Versión menor (agrega funcionalidades de manera retrocompatible).
  • z: Versión de parche (corrección de errores, retrocompatible).

Actualización de Versiones

Para actualizar la versión de un paquete en package.json.

npm version major|minor|patch

Esto actualizará automáticamente la versión y creará un commit y tag en Git.

Ver la configuración actual de NPM

npm config list

Configurar un proxy

npm config set proxy http://mi.proxy.com:8080

Configurar un registry

npm config set registry https://registry.npmjs.org/