Set Up Conventional Commits, Commitlint, and Husky

Tabla de contenido

Paso 1: Configuración de Conventional Commits
Paso 2: Configuración de Commitlint
Paso 3: Configuración de Husky
Paso 4: Uso de Conventional-changelog
Paso 6: Recursos Útiles

Paso 1: Configuración de Conventional Commits

Instala la extensión Conventional Commits en Visual Studio Code para facilitar el proceso de commits.
Abre las extensiones en Visual Studio Code con Ctrl + Shift + P y busca “Conventional Commits”. Selecciona la opción y presiona Enter.
En el cuadro de diálogo, elige el tipo de commit que estás realizando. Puedes seleccionar entre opciones como feat (nueva característica), fix (corrección de errores), entre otros.
Si tu cambio se relaciona con un componente (scoope) específico , puedes elegir o crear un ámbito. Esto proporciona un contexto adicional sobre el alcance del commit.
Selecciona un gitmoji que represente visualmente el propósito de tu commit. Estos emoticonos ayudan a identificar rápidamente la naturaleza de los cambios.
Proporciona una descripción breve y concisa del cambio que estás realizando. Usa un lenguaje claro y directo.
Opcionalmente, puedes agregar una descripción más detallada del commit para proporcionar información adicional, si es necesario.
Si es relevante, enumera los cambios importantes o los problemas cerrados por este commit. Esto facilita el seguimiento y la documentación de los cambios realizados.
Puedes personalizar un atajo para acceder más rápidamente a la extensión, por ejemplo, Shift + Alt + G.

Paso 2: Configuración de Commitlint

Commitlint es una herramienta de línea de comandos, pero la podemos integrar en nuestro proyecto e incluso unirlo a nuestro github para asegurarnos que cada que vamos hacer un commit ese hook se lance, verifiqué si sigue las normas de estilo de Conventional Commits y si es asi el commit se realizara.

Inicia un nuevo proyecto npm con npm init -y.

Instala las dependencias de desarrollo:

npm install --save-dev @commitlint/cli @commitlint/config-conventional

Crea un archivo commitlint.config.js en la raíz del proyecto con el siguiente contenido:
```
module.exports = {
	extends: ["@commitlint/config-conventional"],
};
```
Lo que estamos haciendo es heredar las normas de estilo de Conventional Commits, la cual es la libreria que acabamos de instalar.

Paso 3: Configuración de Husky

Husky es una herramienta que simplifica la configuración de ganchos (hooks) de Git en proyectos de desarrollo. Permite ejecutar scripts automáticamente en eventos específicos, como antes de confirmar o antes de enviar cambios al repositorio. Esto facilita la automatización de tareas, como ejecutar pruebas o formatear código, contribuyendo a mantener la calidad y consistencia en el desarrollo de software.

Instala Husky como dependencia de desarrollo:
```
 npm i -D husky
```
Añade el script de preparación para Husky en tu archivo package.json:
```
 "scripts": {
"prepare": "husky install"
}
```
Ejecuta el comando:
```
 npm run prepare
```

Añade el hook commit-msg utilizando el siguiente comando:

 npx husky add .husky/commit-msg "npx --no -- commitlint --edit ${1}"

Luego, creamos un archivo .gitignore y agregamos la línea node_modules en su interior.

Paso 4: Uso de Conventional-changelog

Conventional Changelog es una herramienta que automatiza la generación de registros de cambios (changelogs) basados en las convenciones establecidas por los mensajes de commit. Al seguir las convenciones de Conventional Commits, facilita la creación de changelogs coherentes y comprensibles. La herramienta analiza los mensajes de commit y genera automáticamente registros de cambios, mejorando la documentación y comunicación efectiva de las actualizaciones del software.

Instala conventional-changelog-cli de forma global o local:

 npm install -g conventional-changelog-cli

O de forma local:

 npm install --save-dev conventional-changelog-cli

Genera el archivo de changelog con el siguiente comando:
```
 conventional-changelog -i CHANGELOG.md -s -r 0
```

Paso 6: Recursos Útiles

Conventional Commits - gitmoji - commitlint - husky

Con estos pasos, estarás utilizando Conventional Commits, Commitlint y Husky en conjunto, asegurando un flujo de trabajo consistente y generando changelogs automáticamente. Este enfoque mejora la calidad del código y la colaboración en el desarrollo de proyectos.