commitlint

Empiece | Sitio web

Mensajes de confirmación de pelusa

Demostración generada con SVG-Term-CLI

cat docs/assets/commitlint.json | svg-term --out docs/public/assets/commitlint.svg --frame --profile=Seti --height=20 --width=80

• Ser un buen commitizen

• Compartir la configuración a través de npm

• Toque conventional-changelog

Contenido

• Empiece | Sitio web

• Instalar y ejecutar

• Lanzamientos

• Beneficios de usar compromiso

• Contenido

• ¿Qué es Competlint?

• Empezando

• CLI

• Configuración

• Configuración compartida

• Documentación

• API

• Herramientas

• Hoja de ruta

• Soporte y lanzamientos de la versión

• Proyectos relacionados

• Licencia

• Desarrollo

---

¿Qué es Competlint?

Compromiso de compromiso si sus mensajes de confirmación cumplen con el formato de confirmación convencional.

En general, el patrón se ve así:

 Tipo (¿alcance?): El tema #scope es opcional; Se admiten múltiples ámbitos (opciones de delimitador actuales: "/", "" y ",")

Los ejemplos del mundo real pueden verse así:

chore: run tests on travis ci

fix(server): send cors headers

feat(blog): add comment section

Los tipos comunes de acuerdo con Compromlint-Config-Convencional (basado en la Convención Angular) pueden ser:

• construir

• faena

• CI

• documento

• logro

• arreglar

• perfil

• refactor

• revertir

• estilo

• prueba

Estos pueden ser modificados por su propia configuración.

Beneficios de usar compromiso

• ¿Por qué utilizar los confirmaciones convencionales?

• "Las ventajas de comprometerse con convenciones" (hablar de toboganes)

Empezando

• Configuración local: mensajes de pelusa en Commit con Husky

• Configuración de CI: los mensajes de pelusa durante las compilaciones de CI

CLI

• Forma principal de interactuar con compromiso.

• npm install --save-dev @commitlint/cli

• Paquetes: CLI

Configuración

• La configuración se recoge de:

• .commitlintrc

• .commitlintrc.json

• .commitlintrc.yaml

• .commitlintrc.yml

• .commitlintrc.js

• .commitlintrc.cjs

• .commitlintrc.mjs

• .commitlintrc.ts

• .commitlintrc.cts

• commitlint.config.js

• commitlint.config.cjs

• commitlint.config.mjs

• commitlint.config.ts

• commitlint.config.cts

• Campo commitlint en package.json

• Campo commitlint en package.yaml

• Paquetes: CLI, Core

• Consulte las reglas para una lista completa de posibles reglas

• Se puede encontrar una configuración de ejemplo en @commitlint/config-convencional

Configuración compartida

Hay una serie de configuraciones compartidas disponibles para instalar y usar con commitlint :

• @comitlint/config-angular

• @comitlint/config-convencional

• @comitlint/config-lerna-scopes

• @comitlint/config-nx-scopes

• @comitlint/config-paternplate

• ATOM Convencional-Changelog-Lint-Config

• Convencional-Chagelog-Lint-Config-Canonical

️ Si desea publicar su propia configuración compartible, asegúrese de que tenga un nombre que se alinee con el patrón commitlint-config-emoji-log o commitlint-config-your-config-name , entonces en extensión todo lo que tiene que escribir es emoji-log o your-config-name .

Documentación

Consulte el sitio web principal.

API

• Forma alternativa y programática de interactuar con commitlint

• Paquetes:

• Formato - Formato de informes de compromiso

• Lint - Lint a una cadena contra las reglas de Compromiso

• Cargar - Cargar la configuración de compromiso compartido

• Leer: lea los mensajes de confirmación desde un rango específico o la última edición

• Consulte API para obtener una lista completa de métodos y ejemplos

Herramientas

• Adaptador de comité

• inmediato

Hoja de ruta

commitlint se considera estable y se utiliza en varios proyectos como herramienta de desarrollo.

Ideas : Convencional-Changelog/Competnlint#94

Soporte y lanzamientos de la versión

• Node.js lts >= 18

• git >= 2.13.2

Lanzamientos

Los parches de seguridad se aplicarán a versiones que aún no son EOL.
Las características solo se aplicarán a la versión principal actual.

Liberar	Lanzamiento inicial
V19	02/2024
V18	10/2023

EOL suele ser después de alrededor de un año.

No somos un proyecto OSS patrocinado. Por lo tanto, no podemos prometer que liberaremos versiones de parche para lanzamientos más antiguos de manera oportuna.
Si está atrapado en una versión anterior y necesita un parche de seguridad, estamos contentos si puede proporcionar un PR.

Proyectos relacionados

• Changelog convencional genera un CangeLog a partir de la historia de confirmación convencional

• Commitizen Simple Commit Convencions para ciudadanos de Internet

• Crear CLI de módulo-semántico para integrar rápidamente el cometizen y el compromiso en proyectos nuevos o existentes

Licencia

Copyright por @marionebl. Todos los paquetes commitlint se lanzan bajo la licencia MIT.

Desarrollo

commitlint se desarrolla en un repositorio mono.

Instalar y ejecutar

 Git clone [email protected]: convencional-changelog/comitlint.gitcd comitlint
hilo
Yarn Run Build # Ejecutar Build TaskSyarn Inicio # Ejecutar Pruebas, nuevamente en Changyarn Run Compromnint # Ejecutar CLI

Para obtener más información sobre cómo contribuir, eche un vistazo a nuestra guía de contribución.