setup-pre-commit

Tổng quan về setup-pre-commit skill

setup-pre-commit làm gì

setup-pre-commit skill giúp agent thêm một lớp chặn Git commit thực dụng cho repository JavaScript hoặc TypeScript bằng husky, lint-staged, Prettier, cùng các script typecheck và test nếu có. Nói đơn giản, nó thiết lập việc format trên các file đang được stage và có thể chặn những commit lỗi trước khi chúng được đưa vào repo.

setup-pre-commit skill phù hợp nhất với ai

Skill này phù hợp nhất với team hoặc lập trình viên làm việc một mình muốn có cấu hình pre-commit gọn gàng, ít rắc rối trong một repo sẵn có, và không muốn tự thiết kế cấu hình Husky đầu tiên từ đầu. Nó đặc biệt hợp khi bạn đã có project chạy trên Node và muốn có format lúc commit kèm một vài bước kiểm tra chất lượng nhẹ.

Nhu cầu thực tế mà skill này giải quyết

Phần lớn người dùng không chỉ muốn “cài Husky xong là được”. Họ muốn một repo mà contributor có thể commit tự tin, với một hook ổn định và dễ đoán, có thể:

• format các file đang stage,
• chạy các script typecheck và test có sẵn nếu repo đã có,
• không tự ý thêm tool mới không cần thiết,
• khớp với package manager của repo.

Đó mới là giá trị thực tế của setup-pre-commit.

Điều gì khiến setup-pre-commit khác với một prompt chung chung

Một prompt chung chung có thể gợi ý rất nhiều kiểu Git hook khác nhau. setup-pre-commit skill thì hẹp hơn nhưng hữu ích hơn cho một tình huống phổ biến: thiết lập đúng lộ trình Husky + lint-staged + Prettier, tự nhận diện package manager, tạo đúng file cần thiết, và không thêm typecheck hay test nếu repo thực tế không hỗ trợ các lệnh đó.

Mặc định skill sẽ thiết lập những gì

Dựa trên source của skill, đầu ra mong đợi sẽ bao gồm:

• khởi tạo husky
• file .husky/pre-commit
• file .lintstagedrc
• file .prettierrc chỉ khi chưa có cấu hình Prettier nào sẵn
• các lệnh hook cho lint-staged, cộng thêm typecheck và test nếu các script đó đã tồn tại

Repo phù hợp và không phù hợp

Phù hợp nhất:

• repo Node.js
• ứng dụng TypeScript frontend hoặc full-stack
• repo đã dùng package.json
• project đã có sẵn script test và typecheck

Ít phù hợp hơn:

• monorepo đa ngôn ngữ có cơ chế điều phối hook riêng
• repo đã dùng một hook manager khác
• team muốn pipeline commit rất nhanh, rất chọn lọc, hoặc theo từng ngôn ngữ vượt quá mặc định
• project mà việc chạy test ở mỗi commit là quá chậm

Cách dùng setup-pre-commit skill

Ngữ cảnh cài đặt cho setup-pre-commit skill

Nếu bạn đang dùng hệ thống Skills, hãy thêm skill từ repository nguồn:

npx skills add mattpocock/skills --skill setup-pre-commit

Sau đó gọi skill này khi bạn muốn agent chỉnh sửa repository hiện tại, chứ không phải giải thích Git hook một cách lý thuyết.

setup-pre-commit cần những đầu vào nào từ repo của bạn

Chất lượng sử dụng setup-pre-commit phụ thuộc nhiều vào ngữ cảnh repo. Trước khi gọi skill, hãy đảm bảo agent có thể kiểm tra:

• package.json
• lockfile như package-lock.json, pnpm-lock.yaml, yarn.lock, hoặc bun.lockb
• các file cấu hình Prettier hiện có
• .husky/ hiện có hoặc cơ chế Git hook đang dùng
• repo có script typecheck và test hay không

Nếu thiếu ngữ cảnh này, agent có thể tạo ra các lệnh không khớp với package manager hoặc script của repo.

File trong repository nên đọc đầu tiên

Hãy bắt đầu với SKILL.md. Skill này đơn giản, tự chứa, và toàn bộ logic quan trọng đều nằm ở đó:

• nhận diện package manager
• cài husky, lint-staged, và prettier
• chạy npx husky init
• ghi .husky/pre-commit
• ghi .lintstagedrc
• chỉ thêm .prettierrc nếu đang thiếu
• kiểm tra lại kết quả

Với skill này, không có file helper bổ sung nào ẩn chứa hành vi quan trọng phía sau.

Cách viết prompt cho setup-pre-commit hiệu quả

Một prompt yếu:

Set up pre-commit hooks.

Một prompt tốt hơn:

Use the setup-pre-commit skill in this repo. Detect the package manager from lockfiles, inspect package.json, add Husky with lint-staged and Prettier, and only include typecheck or test in .husky/pre-commit if those scripts already exist. Do not overwrite any existing Prettier config. Show me the files you changed and the exact commands you ran.

Vì sao prompt này tốt hơn:

• nó chốt rõ quy tắc package manager,
• ngăn agent tự bịa script,
• giữ nguyên các quy ước format hiện có,
• yêu cầu diff để dễ review.

Cách biến một mục tiêu mơ hồ thành yêu cầu đầy đủ

Nếu mục tiêu thật của bạn là “làm quy trình Git của team an toàn hơn”, hãy chuyển nó thành các ràng buộc gắn với repo:

• package manager đang dùng
• test có đủ nhanh để chạy trong pre-commit hay không
• bạn chỉ muốn format hay muốn format kèm kiểm tra
• repo đã có Prettier hoặc Husky chưa
• bạn có muốn hook tối giản để contributor commit nhanh hơn không

Ví dụ:

Use setup-pre-commit for Git Workflows in this React TypeScript repo. We use pnpm, already have a test script, and have typecheck in package.json. Keep the hook simple and fast. Reuse existing Prettier config if present. If tests look expensive, explain whether they should stay in pre-commit or move to pre-push.

Prompt như vậy cung cấp cho agent thông tin đủ để ra quyết định, chứ không chỉ là một nhãn công việc.

Các file và lệnh dự kiến sẽ có

Với một repo npm thông thường, skill này thường sẽ dẫn đến:

• cài dev dependency: husky, lint-staged, prettier
• chạy npx husky init
• tạo .husky/pre-commit
• tạo .lintstagedrc
• có thể tạo .prettierrc

Nội dung hook nên được điều chỉnh theo package manager. Source của skill nói rất rõ là cần thay npm bằng package manager được phát hiện khi cần.

Cách skill xử lý package manager trong thực tế

Quy tắc nhận diện package manager của skill khá thẳng:

• package-lock.json → npm
• pnpm-lock.yaml → pnpm
• yarn.lock → yarn
• bun.lockb → bun
• nếu không rõ → npm

Điều này quan trọng vì nhiều lần setup-pre-commit install thất bại không phải do Husky, mà do tài liệu hoặc file sinh ra trộn lẫn lệnh của nhiều package manager.

Những gì skill sẽ chủ động không làm

Một ranh giới hữu ích là skill này không được tự thêm các script mà repo của bạn chưa hỗ trợ. Nếu package.json không có typecheck hoặc test, thì những dòng đó phải được bỏ khỏi .husky/pre-commit, và người dùng cần được báo rõ điều đó.

Chính điểm này khiến skill an toàn hơn so với các prompt rộng tay, vốn mặc định project nào cũng có kiểm tra TypeScript và test runner.

Quy trình nên làm sau khi chạy skill

Sau khi agent áp dụng skill:

1. kiểm tra package.json
2. kiểm tra .husky/pre-commit
3. kiểm tra .lintstagedrc
4. xác nhận không có cấu hình Prettier hiện có nào bị ghi đè
5. thử một commit với thay đổi format nhỏ trên file đã stage
6. quyết định xem test có nên nằm trong pre-commit hay nên chuyển đi chỗ khác

Bước cuối rất quan trọng: đúng về mặt kỹ thuật không đồng nghĩa với dễ dùng. Một hook chạy test quá lâu có thể hợp lệ về logic nhưng vẫn khiến team không muốn dùng.

Checklist review mặc định nên có

Trước khi merge thay đổi, hãy xác nhận:

• package manager khớp với repo
• .husky/pre-commit dùng các lệnh mà contributor có thể chạy được trên máy local
• hook không gọi tới script không tồn tại
• việc format file được giới hạn qua lint-staged
• cấu hình Prettier chỉ được thêm khi đang thiếu
• độ trễ khi commit chấp nhận được cho việc dùng hằng ngày

Câu hỏi thường gặp về setup-pre-commit skill

setup-pre-commit có phù hợp với người mới không?

Có, nếu repo là một project Node tiêu chuẩn. Skill này có định hướng rõ ràng nhưng không phức tạp, và nó tránh được khá nhiều vướng mắc thường gặp ở lần đầu cấu hình Husky và nối lint-staged ở mức cơ bản.

setup-pre-commit không bao gồm những gì?

Skill này không cố thiết kế cả một chiến lược chất lượng mã nguồn hoàn chỉnh. Nó không chọn rule ESLint, không tối ưu cách chạy hook trong monorepo, và cũng không tạo các lệnh lint-staged tinh vi theo từng loại file. Phạm vi của nó là thiết lập hook commit ban đầu.

Khi nào không nên dùng setup-pre-commit?

Bỏ qua skill này nếu:

• repo của bạn đã có hệ thống Git hook hoàn chỉnh,
• bạn cần hook nhiều bước theo ngôn ngữ nằm ngoài hệ tool Node,
• bạn muốn pattern file staged được tùy biến rất sâu,
• việc chạy test ở mọi commit rõ ràng sẽ làm chậm developer.

Trong các trường hợp đó, một prompt được may đo kỹ hơn hoặc chuẩn nội bộ sẵn có thường sẽ phù hợp hơn.

Có tốt hơn so với chỉ bảo AI “set up Husky” không?

Thường là có, trong đúng use case này. Giá trị của setup-pre-commit không nằm ở tính mới mẻ mà ở việc thực thi có ràng buộc. Nó mã hóa một lộ trình mặc định hợp lý và giảm bớt việc đoán mò quanh lockfile, script còn thiếu, và thời điểm nên tạo cấu hình Prettier.

setup-pre-commit có dùng được cho monorepo không?

Đôi khi có, nhưng nên thận trọng. Nó vẫn hữu ích nếu repo có một package.json cấp cao rõ ràng và một chiến lược hook thống nhất. Độ tin cậy sẽ giảm khi các package có script riêng, quy ước format riêng, hoặc lệnh test theo workspace tách biệt.

Nó có ép dùng Prettier ngay cả khi repo đã có cấu hình format rồi không?

Không. Hướng dẫn nguồn ghi rõ chỉ tạo .prettierrc nếu chưa có cấu hình Prettier nào tồn tại. Đây là một hành vi quan trọng để việc áp dụng bớt xung đột hơn.

Có thể dùng setup-pre-commit cho Git Workflows ngoài việc format không?

Có, nhưng chỉ ở mức giới hạn. Skill hỗ trợ thêm typecheck và test vào quy trình commit khi các script đó đã tồn tại. Nó không phải công cụ thiết kế đầy đủ cho branch protection hay CI.

Cách cải thiện setup-pre-commit skill

Cung cấp dữ kiện repo rõ hơn ngay từ đầu

Cách nhanh nhất để cải thiện việc dùng setup-pre-commit là đưa tín hiệu cụ thể của repo ngay trong prompt:

• package manager
• có typecheck hay không
• có test hay không
• test có nhanh không
• đã có cấu hình Prettier hay chưa
• đã có .husky/ hay chưa

Skill sẽ đáng tin cậy hơn nhiều khi nó làm việc từ dữ kiện đã được xác minh thay vì giả định.

Yêu cầu cách triển khai theo hướng dễ review diff

Một prompt cải thiện tốt là:

Use the setup-pre-commit skill, but minimize changes. Reuse existing config where possible, avoid replacing current hook behavior, and show the exact file diff before writing anything risky.

Điều này đặc biệt hữu ích với những repo có thể đã có sẵn một phần công cụ liên quan.

Ngăn lỗi phổ biến nhất

Lỗi phổ biến nhất là thêm các lệnh mà repo không chạy được. Để cải thiện kết quả, hãy nói rõ với agent:

Only add typecheck and test to the hook if those scripts already exist in package.json. Otherwise omit them and explain why.

Chỉ dẫn này bám sát source của skill và giúp tránh tạo ra commit bị hỏng.

Tối ưu cho tốc độ làm việc của developer, không chỉ tính đúng

Nhiều team nhận ra rằng npm run test trong pre-commit khá nặng. Nếu tốc độ quan trọng, hãy yêu cầu agent đánh giá chi phí của hook:

Use setup-pre-commit, but if tests appear slow or broad, explain whether they should move to pre-push or CI instead of pre-commit.

Nhờ vậy, skill không chỉ dừng ở “cài tool” mà còn tiến gần hơn tới “khớp với workflow”.

Yêu cầu lệnh an toàn theo đúng package manager

Nếu team của bạn dùng pnpm, yarn, hoặc bun, hãy nói thẳng điều đó ngay cả khi lockfile đã có. Cách này giúp loại bỏ mơ hồ và làm cho lệnh trong file hook cũng như hướng dẫn tiếp theo nhất quán hơn.

Yêu cầu agent giữ nguyên các chuẩn đang có

Nếu repo đã có file format hoặc hook, hãy thêm:

Do not overwrite existing Prettier or Husky config without comparing and explaining the merge strategy.

Điều này quan trọng hơn vẻ ngoài của nó. Tool pre-commit thường thất bại về mặt chấp nhận nội bộ vì thay thế quy ước sẵn có quá mạnh tay.

Nâng chất lượng đầu ra bằng một bước xác thực

Một prompt kết thúc tốt hơn nên có:

After applying setup-pre-commit, verify that the hook files exist, dependencies are in devDependencies, and the hook references only valid scripts. Then tell me how to test it with one staged file.

Như vậy agent sẽ đi xa hơn việc tạo file, tiến tới tính dùng được trong thực tế.

Lặp lại sau lượt đầu tiên

Nếu đầu ra đầu tiên đúng về mặt kỹ thuật nhưng còn vướng, hãy tinh chỉnh bằng một trong các follow-up sau:

• “Make the hook faster.”
• “Adapt this for pnpm.”
• “Remove test from pre-commit but keep typecheck.”
• “Keep existing Prettier settings and only add missing pieces.”
• “Adjust for a monorepo root package.”

Thường cách này hiệu quả hơn là bắt đầu lại bằng một prompt rộng hoàn toàn mới.

Điều người dùng quan tâm nhất

Với phần lớn người áp dụng, một setup-pre-commit guide tốt nhất không nằm ở chuyện “nó cài được bao nhiêu tool”, mà là liệu nó có:

• chạy được ngay với repo hiện tại,
• tránh làm hỏng commit,
• tôn trọng cấu hình sẵn có,
• đủ nhanh để developer tiếp tục bật nó.

Nếu dùng skill với những kết quả đó làm trọng tâm, khả năng nó tạo ra giá trị lâu dài sẽ cao hơn nhiều.