blog.dopana

Quay lại

Khi làm việc theo nhóm hoặc viết blog/dự án, việc đảm bảo code và tài liệu Markdown chuẩn format trước khi commit lên Git là điều rất quan trọng. Thay vì phải nhớ chạy lệnh thủ công hoặc cài các thư viện cồng kềnh, bạn hoàn toàn có thể tận dụng Git Hooks native kết hợp core.hooksPath để tự động hóa 100%.

Có fileKhôngCó fileKhôngCó fileKhôngLỗi cú phápHợp lệDeveloper gõ git commit -m '...'.githooks/pre-commit được kíchhoạt1. Kiểm tra Markdown staged(.md, .mdx)Chạy agent-md formatvà git add file2. Kiểm tra Code staged(.ts, .tsx, .astro...)Chạy bun lint (ESLint)và git add file3. Kiểm tra Docs/DiagramsstagedChạy bun lint:mermaid (maid)Tạo Commit Thành Công ✅Commit Bị Chặn ❌Yêu cầu sửa lỗi trước

Tại Sao Dùng Native Git Hooks Thay Vì Husky?#

Git Native Hook (core.hooksPath)Cách tiếp cận với HuskyCài đặt thêm npm packagehuskyTăng node_modules sizePhụ thuộc runtime bên ngoàiChỉ cần 1 bash script trong.githooks/Zero dependenciesVersion control theo Gitrepository
Tiêu chíHusky / Thư viện thứ 3Git Native Hook (core.hooksPath)
DependencyCần cài package0 dependency
Tốc độKhởi động qua wrapper Node.jsShell script thực thi tức thì (<10ms)
Chia sẻ qua GitCóCó (qua thư mục .githooks/)

Cấu Trúc Script Pre-commit Hoàn Chỉnh#

File cấu hình đặt tại .githooks/pre-commit:

Phân Tích Logic Chi Tiết#

1. Lọc File Đang Staged Với git diff --cached#

Git Index (Staged Area)git diff --cached --name-only--diff-filter=dgrep -E '\\.(ext)$'Danh sách file cần xử lý
  • --cached: Chỉ kiểm tra các file đã được git add.
  • --diff-filter=d: Loại trừ các file đã bị xóa (deleted) để tránh lỗi khi script cố đọc file không tồn tại.
  • set -e: Dừng tiến trình ngay lập tức và chặn commit nếu bất kỳ lệnh lint nào trả về lỗi (exit code khác 0).

2. Tự Động Re-Stage Sau Khi Format#

Khi agent-md hoặc bun lint sửa đổi nội dung file để chuẩn hóa, script thực hiện git add "$file" để cập nhật các thay đổi đó trực tiếp vào commit hiện tại mà không cần developer thao tác lại.

Thiết Lập Tự Động Kích Hoạt Trong Dự Án#

Thêm script prepare vào package.json:

{
  "scripts": {
    "prepare": "git config core.hooksPath .githooks",
    "lint": "eslint --fix 'src/**/*.{js,ts,jsx,tsx,astro}'",
    "lint:mermaid": "maid docs/ src/"
  }
}
json

Cấp quyền thực thi cho file hook:

chmod +x .githooks/pre-commit
bun run prepare
bash

Khi bất kỳ ai clone repository và chạy bun install, bun sẽ tự động kích hoạt script prepare để trỏ Git hooks về thư mục .githooks.

Kết Luận#

Chỉ với một file shell script nhỏ gọn:

  • Toàn bộ Markdown được định dạng tự động.
  • Mã nguồn TypeScript/Astro luôn tuân thủ chuẩn ESLint.
  • Sơ đồ Mermaid được kiểm tra toàn vẹn, loại bỏ triệt để lỗi cú pháp trước khi push lên remote.

Tài liệu tham khảo#