Add help target in Makefile + rename typecheck to type-check
#6
Conversation
This file contains 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
Adds a help target to `Makefile` similar to what I did for Ruby which
uses comments on targets to produce a list of targets along with some
minimal documentation:
$ make help
help Print this message
fmt Autoformat code with Rye/Ruff
lint Run linter with Rye/Ruff
test Run test suite with Rye/pytest
type-check Run type check with MyPy
It also runs as the default target, so `help` can be omitted:
$ make
help Print this message
fmt Autoformat code with Rye/Ruff
lint Run linter with Rye/Ruff
test Run test suite with Rye/pytest
type-check Run type check with MyPy
Rename `typecheck` to `type-check` to match the same target in the Ruby
project so that we're consistent across all projects.
[1] riverqueue/riverqueue-ruby#19
brandur
force-pushed
the
brandur-make-help
branch
from
f172def
to
22846b8
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Adds a help target to
Makefilesimilar to what I did for Ruby whichuses comments on targets to produce a list of targets along with some
minimal documentation:
It also runs as the default target, so
helpcan be omitted:Rename
typechecktotype-checkto match the same target in the Rubyproject so that we're consistent across all projects.
[1] riverqueue/riverqueue-ruby#19