[Proposal] Automate pre-commit and pre-push checks

[elatoskinas]

Motivation

Proposal to automate pre-commit and pre-push contracts development tasks by automatically running the required commands. The benefits of the setup are:

• Automation of manual tasks that are easy to miss / forget during dev time
• Better visibility to new developers to familiarise with the required post-dev commands & clean-up
• Reduced CI failures due to local checks being mandated
• Ability to skip checks at any time (using --no-verify), making the checks less intrusive
• Optional suggestions that can be skipped (e.g. snapshot generation)

Solution

• husky to implement git workflow hooks

• lint-staged to automatically apply changes on files pre-commit

• pre-commit hook: runs lint-staged which automatically applies & commits forge fmt changes to all Solidity files

• pre-push hook: build, test, solhint, optional wrapper / snapshot generation and changeset verification. If any of the commands fail, the pushing is stopped

  • Note: if a snapshot & wrappers are generated, it requires running git push --no-verify again due to a git workflow limitation)

How it works:

1. After running pnpm i, pnpm prepare is ran automatically, which setups husky
2. On git commit, husky intercepts the pre-commit event, and runs .husky/pre-commit, which then runs lint-staged on all detected files
3. On git push, husky intercepts the pre-push event, and runs .husky/pre-push, which executes all commands in the script

Additional features:

• Hooks are opt-in via .env file configurations
• The hooks work on GUI git solutions, by making use of the .env file

TODOs

• Add changeset check
• Git desktop compatibility
• Opt-in hooks
• Implement changes to skip pre-commit & pre-push hooks when a subdirectory did not change (see SO)
• CI compatibility fixes (skip husky prepare)
• Documentation and README

[github-actions]

Go solidity wrappers are out-of-date, regenerate them via the make wrappers-all command

[github-actions]

Go solidity wrappers are out-of-date, regenerate them via the make wrappers-all command

[github-actions]

Go solidity wrappers are out-of-date, regenerate them via the make wrappers-all command

[github-actions]

Go solidity wrappers are out-of-date, regenerate them via the make wrappers-all command

[github-actions]

Go solidity wrappers are out-of-date, regenerate them via the make wrappers-all command

[elatoskinas]

Note: there's a great solution that was recently implemented in core - generating wrappers on CI - which I would love to pull in from the next PR.

This could be adopted to also generate snapshots and (possibly) apply formatting changes.

However, there are still some actions that benefit from a pre-push check (build, test, solhint and changeset verification) - since these require manual intervention.

[github-actions]

LCOV of commit ca70fc4 during Solidity Foundry #4033

Summary coverage rate:
  lines......: 98.8% (1037 of 1050 lines)
  functions..: 96.1% (221 of 230 functions)
  branches...: 91.2% (405 of 444 branches)

Files changed coverage rate: n/a

[RensR]

Ahh this one uses pnpm 9 and the other <9.... we need to align on a single version for all lockfiles. Ideally whatever we have from chainlink

[elatoskinas]

Seems like it's 6.0 in chainlink