Setup Pre Commit

作者 mattpocockc55ee46073ed無授權條款收錄於 2026年10月8日更新於 2026年10月8日

Set up Husky pre-commit hooks with lint-staged (Prettier), type checking, and tests in the current repo. Use when user wants to add pre-commit hooks, set up Husky, configure lint-staged, or add commit-time formatting/typechecking/testing.

AI 產生的概覽

為程式碼倉庫設定 Husky 預提交鉤子,整合 lint-staged、Prettier、型別檢查與測試。

功能
此技能引導在倉庫中設定提交時檢查:偵測套件管理器,將 husky、lint-staged 與 prettier 安裝為開發相依套件,並初始化 Husky。它會建立執行 lint-staged 以及 typecheck 與 test 指令的 .husky/pre-commit 鉤子、對已暫存檔案執行 Prettier 的 .lintstagedrc,以及在不存在的預設 .prettierrc。最後提供驗證清單並提交新增檔案。
適用情境
當使用者想要加入預提交鉤子、設定 Husky、配置 lint-staged,或為 JavaScript/TypeScript 倉庫加入提交時的格式化、型別檢查或測試時使用。
執行需求
需要一個具備套件管理器(npm、pnpm、yarn 或 bun)的 Node.js 倉庫,並能連網安裝 husky、lint-staged 與 prettier 作為開發相依套件。此技能不含指令碼,僅為操作說明。

Setup Pre-Commit Hooks

What This Sets Up

  • Husky pre-commit hook
  • lint-staged running Prettier on all staged files
  • Prettier config (if missing)
  • typecheck and test scripts in the pre-commit hook

Steps

1. Detect package manager

Check for package-lock.json (npm), pnpm-lock.yaml (pnpm), yarn.lock (yarn), bun.lockb (bun). Use whichever is present. Default to npm if unclear.

2. Install dependencies

Install as devDependencies:

husky lint-staged prettier

3. Initialize Husky

bash
npx husky init

This creates .husky/ dir and adds prepare: "husky" to package.json.

4. Create .husky/pre-commit

Write this file (no shebang needed for Husky v9+):

npx lint-stagednpm run typechecknpm run test

Adapt: Replace npm with detected package manager. If repo has no typecheck or test script in package.json, omit those lines and tell the user.

5. Create .lintstagedrc

json
{  "*": "prettier --ignore-unknown --write"}

6. Create .prettierrc (if missing)

Only create if no Prettier config exists. Use these defaults:

json
{  "useTabs": false,  "tabWidth": 2,  "printWidth": 80,  "singleQuote": false,  "trailingComma": "es5",  "semi": true,  "arrowParens": "always"}

7. Verify

  • .husky/pre-commit exists and is executable
  • .lintstagedrc exists
  • prepare script in package.json is "husky"
  • prettier config exists
  • Run npx lint-staged to verify it works

8. Commit

Stage all changed/created files and commit with message: Add pre-commit hooks (husky + lint-staged + prettier)

This will run through the new pre-commit hooks: a good smoke test that everything works.

Notes

  • Husky v9+ doesn't need shebangs in hook files
  • prettier --ignore-unknown skips files Prettier can't parse (images, etc.)
  • The pre-commit runs lint-staged first (fast, staged-only), then full typecheck and tests

來源與署名

來源:mattpocock/skills位於skills/misc/setup-pre-commit提交c55ee46

授權條款: 無授權條款

內容歸原作者所有。SourceWeft 從公開儲存庫中收錄這些內容。

檢舉或申請下架