foundry-pre-commit icon indicating copy to clipboard operation
foundry-pre-commit copied to clipboard

🛠️🪝 Pre-commit hooks for foundry forge fmt and snapshot.

🛠️ Foundry Pre-Commit Hook 🪝

Run Foundry forge fmt and/or forge snahshot before commit.

Usage

  1. Install Foundry.
  2. Install pre-commit.
  3. Add the following to .pre-commit-config.yaml in your repo.
repos:
    - repo: https://github.com/0xYYY/foundry-pre-commit
      rev: v1.0.0
      hooks:
          - id: format
          - id: snapshot
  1. Run pre-commit install to set up the hooks.
  2. 🎉 From now on, before each commit, forge fmt and forge snapshot will be ran automatically.

Credits

Inspired by this tweet from devanoneth.

License

Dual licensed under either MIT License or Apache License, Version 2.0.