Introduction to NPM Packages
Index
- ¿Que es NPM?
- ¿Que es un módulo npm?
- npm en la consola
- Preparar un módulo npm
- Publicar un módulo.
¿que es?
npm (node package manager) es un gestor de paquetes de node.js, que nos permite descargar librerías y enlazarlas o descargar programas de js.
Modules
... o paquetes
A module encapsulates related code into a single unit of code. When creating a module, this can be interpreted as moving all related functions into a file.
NPM CLI
comandos básicos
- npm init
- npm install
- -g
- --save
- --save-dev
- npm uninstall
- npm link / unlink
- npm publish
Making a
NPM Module
npm init
¿Que es package.json?
Un archivo JSON formal que describe un módulo. Contiene todas sus dependencias, scripts CLI e información contextual (autor, repositorio, nombre, versión, etc)
mas sobre package.json
http://browsenpm.org/package.json#analyze
var exports = module.exports = {};
Exportar un módulo es la forma de exponer los métodos u objetos que queremos que estén disponibles en nuestro módulo.
Se debe entender como la interfaz pública de nuestro módulo para ser consumido.
Publishing a Module
Registro Público NPM
Para publicar...
- Ir al folder de nuestro módulo
- Asegurarnos de que el módulo funciona correctamente
- HINT! podes hacer pruebas locales con npm link
- npm login -> para loguearnos en el registro público
- npm publish -> para publicar
- LISTO! nuestro módulo está disponible publicamente
Registro Privado de MeLi
Publicar en el registro privado...
-
Definir el registro a usar:
-
a) por npm registry:
npm set registry http://registry.npm.ml.com -
b) Agregás el archivo .npmrc a tu proyecto y seteár el registry (ej).
-
-
"Loguearse" con el user admin del registry (npm login)
-
Publicar común y corriente
Fuentes y recursos
Introduction to NPM Packages
By Santiago Barchetta
