Este es un paquete npm básico basado en el curso "Fundamentos de Javascript" de platzi. Consiste en platzom, una modificacion de la secuencia de palabras basada en reglas.
- Si la palabra termina en "ar", se le quitan esos dos caracteres.
- Si la palabra inicia con Z, se le añade "pe" al final.
- Si la palabra traducida tiene 10 o mas letras se debe partir a la mitad y unir con un guion.
- Si la palabra original es un palíndromo, ninguna regla anterior cuenta y se devuelve la misma palabra intercalando mayusculas y minusculas.
Una excelente guía se puede encontrar aquí.
A continuación describo los pasos que he realizado.
Se debe crear un repositorio en github que va a contener nuestro módulo y clonarlo localmente.
npm init
Las funciones hay que exportarlas con el comando
export function myFunction(args){}
Tambien se puede agregar un parámetro para que sea la funcion por defecto
export default function myFunction(args){}
En el primer caso se debe llamar la funcion así
const platzom = require("npm-package-platzom").platzom
En el segundo caso se debe llamar la funcion así
const platzom = require("npm-package-platzom").default
Con babeljs vamos a lograr que nuestro paquete sea compatible con todos los navegadores. http://babeljs.io/docs/setup/#installation
- 1 Instalar babel como libreria de desarrollo
npm install --save-dev babel-cli
- 2 Crear un script en el package.json para compilar En este punto el comando es babel, los archivos fuente se encuentran en src y con la opcion -d se define el lugar donde se van a generar nuevos archivos, en este caso lib.
{
"name": "npm-package-platzom",
"version": "0.1.1",
"description": "Paquete npm de ejemplo",
"main": "lib/platzom.js",
"scripts": {
"build": "babel src -d lib",
"test": "mocha"
}
- 3 Crear el archivo .babelrc El archivo .babelrc debe tener el siguiente contenido
{
"presets": ["env"]
}
A continuacion se corre el comando
npm install babel-preset-env --save-dev
- 4 Correr el script
npm run build
Se debe cambiar el archivo main para que apunte al archivo generado.
{
"name": "npm-package-platzom",
"version": "0.1.1",
"description": "Paquete npm de ejemplo",
"main": "lib/platzom.js",
"scripts": {
"build": "babel src -d lib",
"test": "mocha"
}
Es muy buena práctica escribir los test antes de escribir el código fuente.
- 1 Instalar librerias
npm install --save-dev mocha chai
- 2 Crear el archivo de pruebas
Crear una carpeta llamada test y crear un archivo llamado test.js. En el código está el ejemplo de cómo se hace.
- 3 Correr las pruebas
npm test
- 1 Push proyecto a repositorio de github
git tag x.x.x
git push origin master --tags
- 2 Subir el modulo a npm
npm publish
Inicializar npm en un directorio nuevo e instalar el paquete
npm init
npm install npm-package-platzom
Se puede crear un archivo test.js
const platzom = require("npm-package-platzom").default
const translation = platzom("Programar")
console.log(translation)
Correr el proyecto de prueba
node test