chore: add Husky formatting hooks

[PhilixTheExplorer]

📌 Fixes

Fixes #626

---

📝 Summary of Changes

• Added Husky Git hooks for local contributor workflows.
• Added Husky and lint-staged as development dependencies.
• Added a prepare script so npm install installs Husky hooks automatically.
• Added a format:check script for non-mutating formatting checks.
• Added a format:staged script that formats staged source files through lint-staged.
• Added a format:changed script that checks formatting for files changed against main.
• Added a pre-commit hook that runs npm run format:staged.
• Added a pre-push hook that runs npm run format:changed.
• Updated CONTRIBUTING.md with the new hook behavior and formatting commands.

---

📸 Screenshots / Demo (if UI-related)

N/A

---

✅ Checklist

• I’ve tested my changes locally
• I’ve added tests (if applicable)
• I’ve updated documentation (if applicable)
• My code follows the project’s code style guidelines

---

👀 Reviewer Notes

This is a tooling-only change. The hooks are scoped to local contributor workflows: pre-commit formats staged source files with lint-staged, and pre-push checks formatting for files changed against main.

npm run format:check was run locally and passes.

Summary by Sourcery

Add Husky-based Git hooks to enforce code formatting in local workflows and document the updated contributor experience.

Build:

• Add Husky as a dev dependency and configure a prepare script to install Git hooks automatically.

Documentation:

• Update CONTRIBUTING.md to describe automatic Husky hooks and the new format:check command.

Chores:

• Introduce pre-commit and pre-push Husky hooks to run formatting and non-mutating format checks before commits and pushes.

[sourcery-ai]

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds Husky-based Git hooks and supporting npm scripts so contributor formatting commands run automatically on commit and push, and documents the new workflow in CONTRIBUTING.md.

Sequence diagram for Husky formatting hooks on commit and push

sequenceDiagram
  actor Developer
  participant Git
  participant Husky
  participant NpmScripts
  participant Biome

  Developer->>Git: git commit
  Git->>Husky: Trigger pre-commit hook
  Husky->>NpmScripts: npm run format
  NpmScripts->>Biome: biome format --write .
  Biome-->>NpmScripts: Formatting completed
  NpmScripts-->>Husky: Exit status
  Husky-->>Git: Allow or block commit
  Git-->>Developer: Commit succeeds or fails

  Developer->>Git: git push
  Git->>Husky: Trigger pre-push hook
  Husky->>NpmScripts: npm run format:check
  NpmScripts->>Biome: biome format .
  Biome-->>NpmScripts: Report formatting issues
  NpmScripts-->>Husky: Exit status
  Husky-->>Git: Allow or block push
  Git-->>Developer: Push succeeds or fails

Loading

File-Level Changes

Change	Details	Files
Introduce Husky Git hooks wired into existing Biome formatting commands and npm lifecycle.	Add a prepare script so Husky is installed automatically on npm install Add a non-writing format:check script using biome format without --write Add Husky devDependency and update package-lock.json accordingly Create pre-commit hook that runs npm run format before committing Create pre-push hook that runs npm run format:check before pushing	package.json package-lock.json .husky/pre-commit .husky/pre-push
Document the new Husky-driven formatting workflow for contributors.	Explain that npm install installs Husky hooks and when they run Document npm run format:check as a read-only formatting check command	CONTRIBUTING.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey - I've left some high level feedback:

• Running npm run format over the entire repo in the pre-commit hook may become slow as the project grows; consider switching to formatting only staged files (e.g., via lint-staged or a similar mechanism) to keep commit workflows snappy.
• Double-check that the .husky/pre-commit and .husky/pre-push scripts explicitly invoke npm run format and npm run format:check respectively and have the executable bit set, so contributors don’t hit confusing no-op or permission issues on first install.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- Running `npm run format` over the entire repo in the pre-commit hook may become slow as the project grows; consider switching to formatting only staged files (e.g., via `lint-staged` or a similar mechanism) to keep commit workflows snappy.
- Double-check that the `.husky/pre-commit` and `.husky/pre-push` scripts explicitly invoke `npm run format` and `npm run format:check` respectively and have the executable bit set, so contributors don’t hit confusing no-op or permission issues on first install.

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[Copilot]

Pull request overview

This PR introduces Husky Git hooks to enforce Biome formatting locally, adding a non-mutating formatting check on push and documenting the new workflow for contributors.

Changes:

• Added Husky as a dev dependency and enabled automatic hook installation via the prepare script.
• Introduced a format:check npm script and wired it into a pre-push hook.
• Added a pre-commit hook to run formatting and updated CONTRIBUTING.md to describe the new behavior.

Reviewed changes

Copilot reviewed 4 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
package.json	Adds prepare, format:check, and Husky dependency to support local Git hooks.
package-lock.json	Locks Husky dependency metadata for reproducible installs.
CONTRIBUTING.md	Documents the new Husky hook behavior and the new formatting script.
.husky/pre-push	Runs the formatting check before allowing pushes.
.husky/pre-commit	Runs auto-formatting and blocks commit if changes are detected.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[kaungmyatshwe1397]

@PhilixTheExplorer
It will be better to keep the hook behavior focused on one job. So, contributors do not run the same formatting logic in multiple places. Apart from that, the PR looks good.

[Copilot]

Pull request overview

Copilot reviewed 4 out of 5 changed files in this pull request and generated 5 comments.

[hpdang]

@PhilixTheExplorer please link this PR to an issue

[Mateeb-Haider]

@PhilixTheExplorer, please add a related issue for better traceability,this will help reviewers and new contributors understand the reason behind the change.

[PhilixTheExplorer]

I’ve created and linked the related enhancement issue #626 now, so the PR has the required issue context.

[kaungmyatshwe1397]

@PhilixTheExplorer
Pleases resolve Copilot's concern.

[Copilot]

Pull request overview

Copilot reviewed 4 out of 5 changed files in this pull request and generated 5 comments.

[PhilixTheExplorer]

Closing this for now because the hook workflow needs more careful design around staged-file formatting, Node version compatibility, and contributor environments. I’ll revisit this later with a smaller, clearer approach.