@sumerkit/pre-commit
v1.0.0
Published
Git precommit rules integration for Sumer Packages
Downloads
15
Readme
sumer-precommit
Precommit para validar el git commit message y hacerlo compatible
Este paquete instala los git hooks necesarios y agrega las reglas de validación que se ejecutan antes de cualquier commit.
Proporciona:
- Asegura que todo el código cumpla con los estandares de Sumerlabs
- Centraliza las confirmaciones previas a cualquier modificación del repositorio.
Instalación
$ npm install @sumerkit/pre-commit --save-dev
CLI
Agrega los git hooks necesarios. Esto se ejecuta automaticamente cuando se instala @sumerkit/pre-commit
como dependencia.
Ejecuta las siguientes acciones:
- Agregar
commit-msg
,pre-commit
, ypre-push
hooks en el directorio.git/hooks
. - Agregar
pre-commit
,pre-push
ycommit-msg
scripts al archivopackage.json
.
{
"scripts": {
"pre-commit": "npm run lint",
"pre-push": "npm run test"
}
}
- Agregar la configuración por defecto de commitlint en el archivo
commitlint.config.js
const Configuration = {
extends: ["@commitlint/config-conventional"],
rules: {
"type-enum": [
2,
"always",
[
"feat",
"fix",
"docs",
"style",
"refactor",
"perf",
"test",
"build",
"ci",
"chore",
"revert",
],
],
"type-empty": [2, "never"],
"scope-enum": [2, "always", []],
"scope-empty": [2, "never"],
"subject-empty": [2, "never"],
"subject-max-length": [2, "always", 70],
},
prompt: {
settings: {
enableMultipleScopes: true,
scopeEnumSeparator: ",",
},
},
};