Add pre-commit hook for Prettier (#2856)

* Add pre-commit hook for Prettier

* fix gh actions

* update package.json

Author: alexandratran

.cursor/rules/contributor-workflow.mdc

@@ -69,6 +69,12 @@ Pull requests run **`npm run format:check`** (Prettier against `.prettierrc` and
 **`npm run format`** locally to fix style before pushing. Generated Snaps API pages under
 `snaps/reference/snaps-api/` are excluded from formatting in git (see `.prettierignore`).
 
+After **`npm install`**, [Husky](https://typicode.github.io/husky/) installs a Git **`pre-commit`** hook
+that runs [**`lint-staged`**](https://github.com/lint-staged/lint-staged) using the rules in
+`package.json`. Staged files matching those patterns are auto-formatted with Prettier (and other
+commands in `lint-staged`, such as ESLint on `src/`). Restage if the hook edits files. Hooks are
+local only and are not required for CI to pass.
+
 Pull requests are checked by a Vale-based linter
 ([docs-spelling-check](https://github.com/Consensys/github-actions/tree/main/docs-spelling-check))
 that enforces Microsoft style, Consensys terminology, and spelling. Fix any linter warnings before

.github/workflows/ci.yml

@@ -57,6 +57,10 @@ jobs:
           cache: npm
       - name: Install dependencies
         run: npm ci
+        env:
+          # Install devDependencies (Prettier, Husky). NODE_ENV=production skips them and breaks prepare.
+          NODE_ENV: development
+          HUSKY: 0
       - name: Check formatting
         run: npm run format:check
 
@@ -84,6 +88,9 @@ jobs:
           node-version-file: '.nvmrc'
       - name: Install dependencies
         run: npm ci
+        env:
+          NODE_ENV: development
+          HUSKY: 0
       - name: Generate Snaps API reference
         run: npm run docusaurus snaps:generate
       - name: LinkCheck

.husky/pre-commit

@@ -0,0 +1,21 @@
+#!/usr/bin/env sh
+# Git GUIs (Fork, etc.) often omit Node from PATH. Resolve node, then run lint-staged without npx.
+cd "$(dirname "$0")/.." || exit 1
+
+export PATH="$HOME/.volta/bin:/opt/homebrew/bin:/usr/local/bin:$PATH"
+
+if [ -s "$HOME/.nvm/nvm.sh" ]; then
+  export NVM_DIR="$HOME/.nvm"
+  # shellcheck disable=SC1090
+  . "$HOME/.nvm/nvm.sh"
+  nvm use default >/dev/null 2>&1 || nvm use node >/dev/null 2>&1 || true
+fi
+
+if ! command -v node >/dev/null 2>&1; then
+  echo "husky: Node.js not found. Install Node.js or open your terminal and run: which node" >&2
+  echo "husky: If you use nvm, ensure default is set (nvm alias default <version>)." >&2
+  exit 1
+fi
+
+# Call the CLI with explicit node so we do not rely on the stub shebang (#!/usr/bin/env node).
+exec node ./node_modules/lint-staged/bin/lint-staged.js