Este repositorio muestra un ejemplo básico del uso de herramientas automáticas para ejecutar pruebas estáticas y dinámicas en un proyecto.
Este repositorio utiliza NodeJS para ejecutar el código JavaScript en forma local, npm para gestionar las dependencias y pre-commit para las validaciones de formato. Para trabajar con el mismo usted debería tener instalado:
- NodeJS (https://nodejs.org/es/download)
- pre-commit (https://pre-commit.com/#install)
Después de clonar el repositorio usted debería ejecutar el siguiente comando:
npm install
Para generar la documentación del proyecto se utiliza el siguiente comando:
make doc
Para la creación del repositorio
-
Creación del proyecto JavaScript
npm init -
Creación del archivo
.gitignoreusando con la herramienta de Toptal -
Instalación de Prettier, la herramienta para verificación de formato
npm install --save-dev --save-exact prettier node --eval "fs.writeFileSync('.prettierrc','{}\n')" -
Ajuste de la configuración de Prettier usando los archivos
.prettierrcy.prettierignore -
Verificación del funcionamiento de Prettier
npx prettier . --check -
Instalación y configuración del plugin para Visual Studio Code
-
Instalación de ESLint, la herramienta para verificación estática del código JavaScript, junto con los plugins para integrar la revisión de formato con Prettier, la importación de dependencias y la inclusión de la cabecera con la licencia
npm install --save-dev eslint eslint-config-prettier eslint-plugin-prettier eslint-plugin-import eslint-plugin-license-header -
Creación de la plantilla con la cabecera de licencia en el archivo
resources/license.js -
Ajuste de la configuración de ESLint usando los archivos
.eslintrcy.eslintignore -
Instalación y configuración del plugin para Visual Studio Code
-
Instalación mocha, chai, sinon, proxyquire y nyc, las herramientas para automatizar las pruebas
npm install --save-dev mocha chai nyc sinon proxyquire -
Ajustes en el archivo `package.json``
"scripts": { "test": "mocha --reporter spec", "coverage": "nyc --reporter=html mocha" }, -
Creación del archivo
pre-commit-config.yaml -
Instalación de pre-commit como hook en el repositorio git
pre-commit install
Chai Assertion Library - Official Site
Getting Started with Node.js and Mocha
Aprende a hacer Testing en Node.js: Mocha, Chai, Sinon, Proxyquire... WTF