commitlint

Comece | Site

Mensagens de comprometimento de fiapos

Demonstração gerada com SVG-termo-cli

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

• Seja um bom commitizen

• Compartilhe a configuração via npm

• Toque no conventional-changelog

Conteúdo

• Comece | Site

• Instale e execute

• Lançamentos

• Benefícios de usar commitlint

• Conteúdo

• O que é commitlint

• Começando

• CLI

• Config

• Configuração compartilhada

• Documentação

• API

• Ferramentas

• Roteiro

• Suporte de versão e lançamentos

• Projetos relacionados

• Licença

• Desenvolvimento

---

O que é commitlint

CommitLint verifica se suas mensagens de confirmação atendem ao formato de confirmação convencional.

Em geral, o padrão se parece com isso:

 tipo (escopo?): o assunto #scope é opcional; Vários escopos são suportados (opções atuais de delimitador: "/", "" e ",")

Exemplos do mundo real podem ficar assim:

chore: run tests on travis ci

fix(server): send cors headers

feat(blog): add comment section

Tipos comuns de acordo com CommitLint-Config-Convencional (com base na Convenção Angular) podem ser:

• construir

• Core

• CI

• documentos

• façanha

• consertar

• perf

• refattor

• reverter

• estilo

• teste

Estes podem ser modificados por sua própria configuração.

Benefícios de usar commitlint

• Por que usar compromissos convencionais?

• "As vantagens de se comprometer com convenções" (slides de conversa)

Começando

• Configuração local - Mensagens de fiapos no commit with Husky

• Configuração do CI - mensagens de fiapos durante as compilações de IC

CLI

• Maneira principal de interagir com o commitlint.

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

• Pacotes: CLI

Config

• A configuração é retirada 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

• commitlint Field em package.json

• commitlint Field em package.yaml

• Pacotes: CLI, núcleo

• Veja as regras para uma lista completa de possíveis regras

• Um exemplo de configuração pode ser encontrado em @commitlint/config-Conventionional

Configuração compartilhada

Várias configurações compartilhadas estão disponíveis para instalação e uso com commitlint :

• @commitLint/configur-angular

• @commitLint/config-Convencional

• @commitlint/config-lerna-scopes

• @commitlint/config-nx-scopes

• @commitLint/config-tatternplate

• Configuração convencional-changelog-config

• Config-canônico convencional-changelog

️ Se você deseja publicar sua própria configuração compartilhável, verifique se ela tem um nome alinhado com o padrão commitlint-config-emoji-log ou commitlint-config-your-config-name -então, em extensão, tudo o que você precisa escrever é emoji-log ou your-config-name .

Documentação

Verifique o site principal.

API

• Maneira alternativa e programática de interagir com commitlint

• Pacotes:

• Formato - Relatórios de Commitlint de Formato

• fiapos - fiapos uma string contra regras de commitlint

• Carregar - Carregar Configuração de CommitLint compartilhada

• Leia - Leia as mensagens de comprometimento de um intervalo especificado ou última edição

• Veja a API para obter uma lista completa de métodos e exemplos

Ferramentas

• Adaptador de Commitizen

• incitar

Roteiro

commitlint é considerado estável e é usado em vários projetos como uma ferramenta de desenvolvimento.

Ideias : Changelog convencional/CommitLint#94

Suporte de versão e lançamentos

• Node.js lts >= 18

• git >= 2.13.2

Lançamentos

Os patches de segurança serão aplicados a versões que ainda não são EOL.
Os recursos serão aplicados apenas à versão principal atual.

Liberar	Liberação inicial
v19	02/2024
v18	10/2023

A EOL geralmente está depois de cerca de um ano.

Não somos um projeto OSS patrocinado. Portanto, não podemos prometer que lançaremos versões de patch para lançamentos mais antigos em tempo hábil.
Se você estiver preso em uma versão mais antiga e precisar de um patch de segurança, estamos felizes se você puder fornecer um PR.

Projetos relacionados

• O trocador convencional gera um changelog da história do commit convencional

• Commitizizen simples Convenções de Commit para cidadãos da Internet

• CLI de módulos criativos-semânticos para integrar rapidamente o Commitizen e CommiteLint em projetos novos ou existentes

Licença

Direitos autorais de @marionebl. Todos os pacotes commitlint são liberados sob a licença do MIT.

Desenvolvimento

commitlint é desenvolvido em um repositório mono.

Instale e execute

 git clone [email protected]: convencional-changelog/commitlint.gitcd CommittLint
fio
Yarn Run Build # Run Build TaskSyarn # Testes de execução, novamente em Changeyarn run CommittLint # Run Cli

Para obter mais informações sobre como contribuir, consulte nosso guia de contribuição.