ไม่มีชื่อบทความ
คู่มือการใช้งาน Commit แบบมาตรฐาน
ขั้นตอนหลังจากรัน pnpm install
1. ติดตั้ง Husky Git Hooks
เรียกใช้งานคำสั่งนี้ (ทำเพียงครั้งแรกครั้งเดียว):
pnpm prepare
คำสั่งนี้จะติดตั้ง Git Hooks ที่จำเป็น เพื่อให้ระบบตรวจสอบ commit message โดยอัตโนมัติ
2. การ Commit ที่ถูกต้อง
เมื่อจะ commit งานที่เขียนเสร็จแล้ว ให้ทำตามขั้นตอนนี้:
git add .
pnpm cz
หลังจากรันคำสั่งนี้ ระบบจะแสดง prompt เพื่อให้กรอกข้อมูลเกี่ยวกับ commit ของคุณตามมาตรฐานที่กำหนดไว้ เช่น:
type: feat
scope: auth
description: เพิ่มหน้า login
ผลลัพธ์ที่ได้จะมีรูปแบบดังนี้:
feat(auth): เพิ่มหน้า login
3. ข้อควรระวัง
- ห้ามใช้
git commit -m "ข้อความ"โดยตรง - ให้ใช้คำสั่ง
pnpm czเท่านั้น เพราะระบบจะตรวจสอบความถูกต้องของข้อความ commit โดยอัตโนมัติ หากผิดรูปแบบจะไม่สามารถ commit ได้
4. ถ้าพบ Error จากคำสั่ง git cz
- อย่าใช้
git czโดยตรง เพราะอาจจะใช้ไม่ได้ในบางเครื่อง - ให้ใช้
pnpm czหรือถ้าจำไม่ได้ ให้ใช้คำสั่ง:
pnpx git-cz
การยกเลิกระหว่างใช้ pnpm cz
หากกำลังกรอกข้อมูล commit อยู่ แต่เปลี่ยนใจไม่อยาก commit แล้ว สามารถยกเลิกได้ด้วยวิธีต่อไปนี้:
ให้กดปุ่ม:
Ctrl + C
เมื่อกดแล้ว ระบบจะออกจากการ commit และกลับสู่ terminal ตามปกติ
ข้อควรจำ:
- ปุ่ม
q,ESC, หรือ Enter ไม่สามารถใช้ในการยกเลิกการ commit ได้
| สถานการณ์ | วิธีออก |
|---|---|
ต้องการออกจาก pnpm cz |
กด Ctrl + C |
กดปุ่มอื่น (q, ESC, Enter) |
ไม่สามารถออกได้ |
เคล็ดลับเพิ่มเติม
ถ้าใช้งานใน VS Code Terminal แล้วกด Ctrl + C ครั้งเดียวไม่ออก ให้ลองกดซ้ำสองครั้ง หรือกดปุ่ม Fn ร่วมด้วยในบางเครื่อง