Anterior

Siguientes

Configuración del archivo package.json

Completado

Le damos la bienvenida al mundo de la administración de proyectos de Node.js con npm y administración de paquetes. Vamos a profundizar en los aspectos básicos del empaquetado y cómo puede sobrecargar el proceso de desarrollo.

Empaquetado y Administración de paquetes

NPM, el administrador de paquetes predeterminado para Node.js, es el arma secreta para incorporar código externo en los proyectos. Es como tener un asistente personal para ayudarle a crear aplicaciones de forma más rápida y eficaz.

El empaquetado es como ajustar el código para su distribución. Agrupa perfectamente el código y sus dependencias en un paquete que otros usuarios pueden instalar y usar fácilmente. La administración de paquetes es el arte de controlar estos paquetes e implica:

• El archivo package.json, el plano técnico del proyecto. Está lleno de metadatos sobre su proyecto y se encarga de administrar las dependencias y los archivos de paquetes.
• La herramienta de la CLI de npm, su manitas personal para instalar y administrar paquetes desde el registro npm.
• El registro npm, un tesoro de paquetes públicos listos para usar en sus proyectos.

Creación del archivo package.json

Crear un package.json es tan sencillo como ejecutar el comando npm init. Hay dos maneras principales de hacerlo:

• npm init: Este comando es como una guía fácil, lo que le lleva a través de un proceso paso a paso que solicita detalles sobre el proyecto, como su nombre, versión y descripción.
• npm init -y: Este comando es la versión rápida de entrenamiento de npm init. Repasa las preguntas y rellena los valores predeterminados por usted.

Aquí tiene un anticipo del archivo de package.json que generará.

{
  "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"
}

Descripción de las áreas de archivo package.json

Piense en el archivo package.json como un cofre del tesoro, lleno de gemas preciosas que dan a su proyecto su brillo. Estas gemas son las propiedades del archivo package.json y se dividen en tres categorías principales:

• Metainformación: Estas propiedades son como las joyas de la corona, definiendo la metainformación sobre el proyecto. Incluyen el nombre del proyecto, la descripción, el autor, las palabras clave y mucho más.
• Dependencias: Estas son las monedas de oro y plata, que representan los paquetes que usa el proyecto. Las propiedades dependencies y devDependencies contienen estos tesoros. A medida que avanzamos, aprenderá a usar estas propiedades para instalar, actualizar y administrar las dependencias.
• Scripts: Estos son los comandos de terminal que hacen que se produzcan las tareas del proyecto. Puede enumerar scripts para tareas como iniciar, compilar, probar y lint.

Creación de tareas con scripts

En el archivo package.json, debe incluir al menos cuatro scripts comunes:

• start: Este script da vida a su proyecto. Por ejemplo, podría usar el comando node ./src/index.js.
• build: Este script prepara el proyecto para su gran debut. Puede transformar TypeScript en JavaScript, por ejemplo.
• test: Este script comprueba el estado del proyecto, normalmente mediante un paquete de prueba.
• lint: Este script ordena el código, comprobando si hay problemas de estilo y formato mediante una herramienta como ESLint.

Estos nombres de script son como palabras mágicas, reconocidas universalmente en la comunidad de desarrolladores y esenciales para mantener el proyecto organizado.

Estandarización de nombres de script

En el archivo package.json, los scripts se definen con una acción y un comando:

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

Este es un ejemplo:

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

Ejecutar un script

Para ejecutar un script en un terminal, escriba el comando npm run <action>. Por ejemplo, npm run lint.

Las acciones start y test son especiales en que puede omitir la palabra run en el comando. En lugar de escribir el comando npm run start, puede escribir npm start.

Uso de un entorno de desarrollo predefinido

Este módulo de entrenamiento ofrece un contenedor de desarrollo, ya sea en un explorador o en el equipo local. Este contenedor proporciona todo el entorno necesario para que pueda usar este módulo de entrenamiento sin tener que instalar un IDE o Node.js. No es necesario saber nada sobre el contenedor para completar este módulo de entrenamiento.

Continuar