Creditu Types

Biblioteca que centraliza y expone clases y métodos que permiten tipar, formatear y validar diferentes estructuras de datos que son de uso recurrente en varios repositorios de Creditú.

Instalar dependencias

npm install

Test unitarios

npm run test:unit
npm run test:cov

Actualmente existen test asociados a los validadores (./validators) dado que es la carpeta que expone métodos con lógica testeable.

Flujo de trabajo

• Al crear un merge request, drone correrá un pipeline para asegurar calidad
• No se puede publicar dos veces la misma versión, no olvides incrementarla (package.json, en la llave version)
• No es el todo necesario, pero puedes usar npm version [major, minor, patch] -m "comentario"
• Si el pipeline está ok, ya puedes mergear la rama.
• Al mergear, drone va a publicar la última versión del código en NPM.
• Empuja tu tag (git push origin --tags). No es del todo necesario, pero así quedan ordenados los tags en el repositorio

Todo lo anterior lo puedes ver en .drone.yml.

Desarrollo

Al momento de desarrollar, se puede utilizar la versión local del desarrollo en repositorios como creditu-internal-backend utilizando npm link

• en creditu-types,:
  • npm run build
  • npm link
• en creditu-internal-backend:
  • cd nodes_modules
  • ln -s ~/CODE/creditu-types/lib/src creditu-types where ~/CODE/creditu-types is the path to the creditu-types developement folder

Para deshacer:

• primero en creditu-internal-backend:
  • cd nodes_nmodules
  • npm unlink creditu-types
  • npm i creditu-types
• luego en creditu-types:
  • npm unlink --global

para ver si esta bien inculado, en creditu-internal-backend,

• npm ls creditu-types debería decir algo como: [email protected] /home/gud/CODE/creditu-internal-backend └── [email protected] extraneous -> ./../../.nvm/versions/node/v20.12.2/lib/node_modules/creditu-types