หน้าแรก>การเขียนโปรแกรมที่เกี่ยวข้อง>ซอร์สโค้ดอื่น ๆ
ดาวน์โหลด

เริ่มต้น | เว็บไซต์

ผ้าสำลีกระทำข้อความ

ตัวอย่างที่สร้างขึ้นด้วย SVG-term-cli

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

  • เป็น commitizen ดี

  • แชร์การกำหนดค่าผ่าน npm

  • แตะลงใน conventional-changelog

สารบัญ

  • เริ่มต้น | เว็บไซต์

    • ติดตั้งและเรียกใช้

    • ปล่อย

    • ประโยชน์ของการใช้ commitlint

    • สารบัญ

    • iscimlint คืออะไร

    • เริ่มต้น

    • CLI

    • การกำหนดค่า

    • การกำหนดค่าที่ใช้ร่วมกัน

    • เอกสาร

    • API

    • เครื่องมือ

    • แผนงาน

    • การสนับสนุนเวอร์ชันและการเผยแพร่

    • โครงการที่เกี่ยวข้อง

    • ใบอนุญาต

    • การพัฒนา

iscimlint คืออะไร

commitlint ตรวจสอบว่าข้อความการกระทำของคุณเป็นไปตามรูปแบบการกระทำทั่วไปหรือไม่

โดยทั่วไปรูปแบบส่วนใหญ่มีลักษณะเช่นนี้:

 พิมพ์ (ขอบเขต?): หัวเรื่อง #SCOPE เป็นทางเลือก; รองรับหลายขอบเขต (ตัวเลือกคั่นปัจจุบัน: "/", "" และ ",")

ตัวอย่างโลกแห่งความเป็นจริงมีลักษณะเช่นนี้: 

chore: run tests on travis ci
fix(server): send cors headers
feat(blog): add comment section

ประเภททั่วไปตาม commitlint-config-conventional (ขึ้นอยู่กับการประชุมเชิงมุม) สามารถ:

  • สร้าง

  • งานที่น่าเบื่อ

  • CI

  • เอกสาร

  • ความสำเร็จ

  • แก้ไข

  • สมบูรณ์แบบ

  • ผู้สร้างใหม่

  • ย้อนกลับ

  • สไตล์

  • ทดสอบ

สิ่งเหล่านี้สามารถแก้ไขได้ด้วยการกำหนดค่าของคุณเอง

ประโยชน์ของการใช้ commitlint

  • ทำไมต้องใช้ Commental Commits?

  • "ข้อดีของการประชุม" (Talk Slides)

เริ่มต้น

  • การตั้งค่าท้องถิ่น - ข้อความผ้าสำลีในการกระทำกับฮัสกี้

  • การตั้งค่า CI - ข้อความผ้าสำลีในระหว่าง CI Builds

CLI

  • วิธีหลักในการโต้ตอบกับ Contimlint

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

  • แพ็คเกจ: CLI

การกำหนดค่า

  • การกำหนดค่าจะหยิบขึ้นมาจาก:

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

    • ฟิลด์ commitlint ใน package.yaml

  • แพ็คเกจ: CLI, CORE

  • ดูกฎสำหรับรายการกฎที่เป็นไปได้ทั้งหมด

  • ตัวอย่างการกำหนดค่าสามารถพบได้ที่ @commitlint/config-conventional

การกำหนดค่าที่ใช้ร่วมกัน

มีการกำหนดค่าที่ใช้ร่วมกันจำนวนมากเพื่อติดตั้งและใช้งานกับ commitlint :

  • @commitlint/config-angular

  • @commitlint/config-conventional

  • @commitlint/config-lerna-scopes

  • @commitlint/config-nx-scopes

  • @commitlint/config-patternplate

  • changelog-lint-config-atom

  • แบบดั้งเดิม

หากคุณต้องการเผยแพร่การกำหนดค่าที่แชร์ได้ของคุณเองตรวจสอบให้แน่ใจว่ามันมีชื่อที่สอดคล้องกับรูปแบบ commitlint-config-emoji-log หรือ commitlint-config-your-config-name จากนั้นขยายสิ่งที่คุณต้องเขียนคือ emoji-log หรือ your-config-name

เอกสาร

ตรวจสอบเว็บไซต์หลัก

API

  • ทางเลือกวิธีการเขียนโปรแกรมในการโต้ตอบกับ commitlint

  • แพ็คเกจ:

    • รูปแบบ - รายงานการกำหนดรูปแบบ

    • ผ้าสำลี - ผ้าสำลีกับกฎการกระทำ

    • โหลด - โหลดการกำหนดค่า commitlint ที่ใช้ร่วมกัน

    • อ่าน - อ่านข้อความ commit จากช่วงที่ระบุหรือแก้ไขล่าสุด

  • ดู API สำหรับรายการวิธีการและตัวอย่างที่สมบูรณ์

เครื่องมือ

  • อะแดปเตอร์

  • แจ้ง

แผนงาน

commitlint ถือว่ามีเสถียรภาพและใช้ในโครงการต่าง ๆ เป็นเครื่องมือการพัฒนา

แนวคิด : Changelog/commitlint ทั่วไป#94

การสนับสนุนเวอร์ชันและการเผยแพร่

  • node.js lts >= 18

  • git >= 2.13.2

ปล่อย

แพตช์ความปลอดภัยจะถูกนำไปใช้กับเวอร์ชันที่ยังไม่ได้ EOL
คุณสมบัติจะถูกนำไปใช้กับเวอร์ชันหลักปัจจุบันเท่านั้น

ปล่อย การเปิดตัวครั้งแรก
v19 02/2024
v18 10/2023

EOL มักจะประมาณหนึ่งปี

เราไม่ใช่โครงการ OSS ที่ได้รับการสนับสนุน ดังนั้นเราจึงไม่สามารถสัญญาได้ว่าเราจะปล่อยเวอร์ชันแพตช์สำหรับรุ่นเก่าในเวลาที่เหมาะสม
หากคุณติดอยู่กับรุ่นเก่าและต้องการแพตช์ความปลอดภัยเรามีความสุขถ้าคุณสามารถให้บริการประชาสัมพันธ์

โครงการที่เกี่ยวข้อง

  • changelog แบบดั้งเดิมสร้างการเปลี่ยนแปลงจากประวัติศาสตร์การกระทำทั่วไป

  • commitizen simple commentions สำหรับพลเมืองอินเทอร์เน็ต

  • สร้าง CLI-module-module สำหรับการรวม committizen และ commitlint อย่างรวดเร็วในโครงการใหม่หรือที่มีอยู่

ใบอนุญาต

ลิขสิทธิ์โดย @marionebl แพ็คเกจ commitlint ทั้งหมดได้รับการปล่อยตัวภายใต้ใบอนุญาต MIT

การพัฒนา

commitlint ได้รับการพัฒนาในที่เก็บโมโน

ติดตั้งและเรียกใช้

 git clone [email protected]: conderation-changelog/commitlint.gitcd commitlint
เส้นด้าย
เส้นด้ายเรียกใช้ # run build tasksyarn start # run tests อีกครั้งในการเปลี่ยนแปลง Run Run Contimlint # Run CLI

สำหรับข้อมูลเพิ่มเติมเกี่ยวกับวิธีการมีส่วนร่วมโปรดดูที่คู่มือการบริจาคของเรา

ขยาย
ข้อมูลเพิ่มเติม
แอปที่เกี่ยวข้อง
แนะนำสำหรับคุณ
ข้อมูลที่เกี่ยวข้อง ทั้งหมด