commitlint

Mulai | Situs web

Pesan Lint Commit

Demo yang dihasilkan dengan SVG-term-cli

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

• Jadilah commitizen yang baik

• Bagikan Konfigurasi melalui npm

• Ketuk ke conventional-changelog

Isi

• Mulai | Situs web

• Instal dan jalankan

• Pelepasan

• Manfaat Menggunakan CommitLint

• Isi

• Apa itu komitlint

• Memulai

• Cli

• Konfigurasi

• Konfigurasi bersama

• Dokumentasi

• API

• Peralatan

• Peta jalan

• Dukungan dan rilis versi

• Proyek terkait

• Lisensi

• Perkembangan

---

Apa itu komitlint

CommitLint memeriksa apakah pesan komit Anda memenuhi format komit konvensional.

Secara umum polanya sebagian besar terlihat seperti ini:

 Type (SCOPE?): Subjek #scope adalah opsional; Beberapa lingkup didukung (opsi pembatas saat ini: "/", "" dan ",")

Contoh dunia nyata bisa terlihat seperti ini:

chore: run tests on travis ci

fix(server): send cors headers

feat(blog): add comment section

Jenis Umum Menurut CommitLint-Config-Conventional (berdasarkan konvensi sudut) dapat:

• membangun

• pekerjaan rumah

• ci

• dokumen

• prestasi

• memperbaiki

• perf

• Refactor

• kembali

• gaya

• tes

Ini dapat dimodifikasi dengan konfigurasi Anda sendiri.

Manfaat Menggunakan CommitLint

• Mengapa menggunakan komitmen konvensional?

• "Perksus berkomitmen dengan konvensi" (slide bicara)

Memulai

• Pengaturan Lokal - Pesan Serat tentang Komit dengan Husky

• Pengaturan CI - Pesan Lint selama CI Builds

Cli

• Cara utama untuk berinteraksi dengan CommitLint.

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

• Paket: CLI

Konfigurasi

• Konfigurasi diambil dari:

• .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 di package.json

• commitlint Field di package.yaml

• Paket: CLI, Core

• Lihat aturan untuk daftar lengkap aturan yang mungkin terjadi

• Contoh konfigurasi dapat ditemukan di @commitlint/config-conventional

Konfigurasi bersama

Sejumlah konfigurasi bersama tersedia untuk diinstal dan digunakan dengan commitlint :

• @commitlint/config-angular

• @commitlint/config-conventional

• @commitlint/config-lerna-scopes

• @commitlint/config-nx-scopes

• @commitlint/config-polaPlate

• atom konvensional-changelog-lint-config-atom

• konvensional-changelog-lint-config-canonical

️ Jika Anda ingin mempublikasikan konfigurasi yang dapat dibagikan, maka pastikan nama itu selaras dengan pola commitlint-config-emoji-log atau commitlint-config-your-config-name -maka dalam memperpanjang semua yang harus Anda tulis adalah emoji-log atau your-config-name .

Dokumentasi

Periksa situs web utama.

API

• Alternatif, cara terprogram untuk berinteraksi dengan commitlint

• Paket:

• Format - Format Laporan CommitLint

• serat - serangkaian string melawan aturan komitlint

• Muat - Muat konfigurasi commitlint bersama

• Baca - Baca Pesan Komit dari Kisaran yang Ditentukan atau Edit Terakhir

• Lihat API untuk daftar lengkap metode dan contoh

Peralatan

• Adaptor Komitizen

• mengingatkan

Peta jalan

commitlint dianggap stabil dan digunakan dalam berbagai proyek sebagai alat pengembangan.

Ide : Konvensional-changelog/Commitlint#94

Dukungan dan rilis versi

• Node.js lts >= 18

• git >= 2.13.2

Pelepasan

Patch keamanan akan diterapkan pada versi yang belum EOL.
Fitur hanya akan diterapkan ke versi utama saat ini.

Melepaskan	Rilis awal
v19	02/2024
v18	10/2023

EOL biasanya setelah sekitar satu tahun.

Kami bukan proyek OSS yang disponsori. Oleh karena itu kami tidak dapat berjanji bahwa kami akan merilis versi tambalan untuk rilis yang lebih lama tepat waktu.
Jika Anda terjebak pada versi yang lebih lama dan membutuhkan tambalan keamanan, kami senang jika Anda dapat memberikan PR.

Proyek terkait

• Changelog konvensional menghasilkan perubahan dari sejarah komit konvensional

• Komitisasi konvensi komit sederhana untuk warga internet

• Create-Semantic-Module CLI untuk mengintegrasikan komitisasi dan komitmen dengan cepat dalam proyek baru atau yang sudah ada

Lisensi

Hak Cipta oleh @Marioneebl. Semua paket commitlint dirilis di bawah lisensi MIT.

Perkembangan

commitlint dikembangkan dalam repositori mono.

Instal dan jalankan

 git clone [email protected]: konvensional-changelog/commitlint.gitcd komitlint
benang
YARN Run Build # Run Build Tasksyarn Mulai # Jalankan Tes, sekali lagi di ChangeYarn Run Commitlint # Run CLI

Untuk informasi lebih lanjut tentang cara berkontribusi, silakan lihat panduan kontribusi kami.