-
Notifications
You must be signed in to change notification settings - Fork 5
chore: add a makefile to run linter/testing/type safety check #42
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+55
−0
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| .PHONY: pr install lint type-check test integration-test proto-check clean help | ||
|
|
||
| # Run all PR checks locally | ||
| pr: install proto-check lint type-check test integration-test | ||
| @echo "All PR checks passed!" | ||
|
|
||
| # Install dependencies | ||
| install: | ||
| @echo "Installing dependencies..." | ||
| uv sync --extra dev | ||
|
|
||
| # Run linter | ||
| lint: | ||
| @echo "Running Ruff linter and fixing lint issues..." | ||
| uv tool run ruff check --fix | ||
|
|
||
| # Run type checker | ||
| type-check: | ||
| @echo "Running mypy type checker..." | ||
| uv tool run mypy cadence/ | ||
|
|
||
| # Run unit tests | ||
| test: | ||
| @echo "Running unit tests..." | ||
| uv run pytest -v | ||
|
|
||
| # Run integration tests | ||
| integration-test: | ||
| @echo "Running integration tests..." | ||
| uv run pytest -v --integration-tests | ||
|
|
||
| # Clean generated files and caches | ||
| clean: | ||
| @echo "Cleaning up..." | ||
| find . -type d -name "__pycache__" -exec rm -rf {} + 2>/dev/null || true | ||
| find . -type f -name "*.pyc" -delete 2>/dev/null || true | ||
| find . -type d -name "*.egg-info" -exec rm -rf {} + 2>/dev/null || true | ||
|
|
||
| # Show help | ||
| help: | ||
| @echo "Available targets:" | ||
| @echo " make pr - Run all PR checks (recommended before submitting PR)" | ||
| @echo " make install - Install dependencies" | ||
| @echo " make lint - Run Ruff linter" | ||
| @echo " make type-check - Run mypy type checker" | ||
| @echo " make test - Run unit tests" | ||
| @echo " make integration-test - Run integration tests" | ||
| @echo " make clean - Remove generated files and caches" | ||
| @echo " make help - Show this help message" | ||
|
|
||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe add a
idl-genrule?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, I have added the
generaterule which is consistent with go-client's makefile rule