README.md

Requisitos

Es recomendable tener instalado nvm (Node Version Manager).

• nvm para Linux/macOS
• nvm para Windows

Instalación

Si se encuentra cualquier problema durante la instalación revisar la sección de Solución de problemas para resolver los problemas mas comunes.

En la carpeta typescript de este proyecto (en la que se encuentra este fichero README.md) ejecutar el siguiente comando para descargar la versión de node correspondiente al proyecto.

nvm install
# --- o ---
nvm install $(Get-Content .nvmrc) # <- si trabajas en Windows

Una vez descargada esta versión marcarla como activa en la sesión de consola actual mediante el comando:

nvm use
# --- o ---
nvm use $(Get-Content .nvmrc) # <- si trabajas en Windows

Por último hay que descargar las dependencias del proyecto, esto se puede hacer con npm o con yarn a vuestra elección.

npm install
# --- o ---
yarn install

Scripts

Todos los scripts pueden lanzarse con npm o con yarn, si quieres saber mas sobre estos puedes revisar la sección scripts del fichero package.json.

Recuerda que todos estos comandos deben lanzarse en la carpeta typescript de este proyecto.

Lanzar los tests

npm run test
# --- o ---
yarn test

Calcular la cobertura de los tests

npm run coverage
# --- o ---
yarn coverage

Encontrarás el reporte de cobertura generado en el fichero coverage/lcov-report/index.html.

Lanzar los tests de forma automática

npm run test:watch
# --- o ---
yarn test:watch

Lanzará los tests de forma automática siempre que se modifique el código de los tests o de producción.

Buscar errores de estilo en el código

npm run lint
# --- o ---
yarn lint

Corregir errores de estilo en el código

npm run lint:fix
# --- o ---
yarn lint:fix

Solución de problemas

No reconoce el comando nvm

Si acabas de instalar nvm es posible que tengas que reiniciar el terminal para que te detecte el nuevo comando.

nvm install/nvm use me pide que le especifique la versión

Asegúrate de estar dentro de la carpeta typescript de este proyecto.

Si estás en Windows puedes añadir $(Get-Content .nvmrc) al final del comando para pasarle como argumento el contenido del fichero .nvmrc. Fuente.

Si aún con esas no detectase automáticamente la versión, revisar el contenido del fichero .nvmrc y escribir nvm install [version]/nvm use [version] sustituyendo [version] por el contenido del fichero en su lugar.

No reconoce el comando yarn

Se puede instalar yarn tan fácil como ejecutar el siguiente comando:

npm install --global yarn

No encuentra el fichero package.json al ejecutar cualquier comando con npm o yarn

Asegúrate de que te encuentras dentro del directorio typescript que se encuentra en la raíz de este proyecto.