chore: add husky commit and push hooks (#588)

Author: kentcdodds

.husky/pre-commit

@@ -0,0 +1 @@
+npm run precommit

.husky/pre-push

@@ -0,0 +1 @@
+npm run prepush

README.md

@@ -69,6 +69,15 @@ Useful scripts:
 
 - `npm run lint` / `npm run format`
 - `npm run test` (unit) / `npm run test:e2e` (playwright)
+- `npm run precommit` to run the same checks as the Git pre-commit hook
+- `npm run prepush` to run the same checks as the Git pre-push hook
+
+Git hooks are installed automatically via `npm install`/`npm run setup` with
+Husky:
+
+- `pre-commit`: formats staged files with Prettier via `lint-staged`, then runs
+  linting, type checking, and builds the workspace
+- `pre-push`: runs the test suite before allowing a push
 
 ## Links
 

docs/development.md

@@ -34,6 +34,40 @@ npm run dev
 Make sure that if the path includes spaces, you wrap the path in quotes as shown
 above (note the use of single quotes wrapping the double quotes!).
 
+## Git hooks
+
+This repo installs Git hooks automatically via Husky when you run `npm install`
+because the root `prepare` script runs `husky`.
+
+### Pre-commit
+
+Every commit runs:
+
+- `npm run format:staged` to format only staged files with Prettier via
+  `lint-staged`
+- `npm run lint`
+- `npm run typecheck`
+- `npm run build`
+
+If a staged file is reformatted, lint-staged updates the staged copy before the
+rest of the checks continue.
+
+### Pre-push
+
+Every push runs:
+
+- `npm run test`
+
+### Running the same checks manually
+
+```sh
+npm run precommit
+npm run prepush
+```
+
+If you need to bypass hooks for an emergency local workflow, use Git's
+`--no-verify` flag intentionally and sparingly.
+
 ## CI Workflows
 
 This repository has two main CI workflows that run on pushes to `main`: