feat(dev-tools): add comprehensive developer experience tooling #29
+1,414
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This contribution adds several developer experience improvements to help contributors be more productive and maintain code quality: ## Pre-commit Hook Script (ops/scripts/pre-commit.sh) - Automated code quality checks before commits - Go formatting (gofmt) and imports organization (goimports) - Go vet static analysis for common mistakes - Debug statement detection (prevents accidental commits) - TODO format validation (matches existing todo-checker patterns) - TypeScript type checking for packages - Solidity formatting via forge fmt - Install mode (--install) to set up as git hook - Quick mode (--quick) for fast checks without tests ## Dev Environment Check Script (ops/scripts/check-dev-environment.sh) - Validates all required development tools are installed - Checks tool versions match project requirements - Core tools: git, go, node, pnpm, make, jq - Blockchain tools: foundry (forge/cast/anvil) with version pinning - Optional tools: docker, direnv, golangci-lint, slither - Environment validation: .nvmrc, go modules, npm deps, submodules - Disk space validation - JSON output mode (--json) for CI integration - Auto-fix mode (--fix) for common issues ## Performance Profiling Utility (op-service/perf) - Timer with configurable thresholds and structured logging - Aggregated metrics collection (count, min, max, avg, total) - Thread-safe concurrent access - Generic helper functions for measuring any function - Context-aware timing with cancellation support - Comprehensive test coverage with benchmarks ## Makefile Targets - make dev-check: Validate development environment - make dev-check-ci: JSON output for CI pipelines - make dev-check-fix: Auto-fix common issues - make install-hooks: Install pre-commit hook - make pre-commit: Run pre-commit checks manually - make pre-commit-quick: Fast checks only - make dev-setup: Full onboarding (check + install hooks)
Collaborator
🟡 Heimdall Review Status
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds developer experience tooling to help contributors be more productive and maintain code quality across the monorepo.
Changes
Pre-commit Hook (
ops/scripts/pre-commit.sh)forge fmt--install(setup as git hook),--quick(fast checks only)Dev Environment Check (
ops/scripts/check-dev-environment.sh)--fix(auto-remediation),--json(CI output)Performance Profiling (
op-service/perf/)Makefile Targets
make dev-setup- Full onboarding (check env + install hooks)make dev-check- Validate development environmentmake pre-commit- Run pre-commit checks manuallyTesting
Why This Matters