add .justfile #2325
Merged
add .justfile #2325
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
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Please add bug fixes, new features, breaking changes and anything else you think is worthwhile mentioning to the master (unreleased) section of CHANGELOG.md. If no CHANGELOG update is needed add the following to the PR description: [x] No CHANGELOG update needed
williballenthin
force-pushed
the
feat/justfile
branch
from
1c5d952
to
1cc301d
Compare
github-actions
bot
dismissed
their stale review
CHANGELOG updated or no update needed, thanks! 😄
williballenthin
force-pushed
the
feat/justfile
branch
from
1cc301d
to
8358034
Compare
mr-tz
approved these changes
Aug 22, 2024
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.
This PR adds a "justfile", which is a configuration file for the tool just. Just is a command runner, like a simplified Make.
I've been having trouble remembering the pre-commit command line invocations needed to run the various linters. Some need
--hook-stage manualand others don't. Usually I use my shell's history to find the command I need, but its painful when I move to a new system. I want to use Just to hide all these extra flags away, so I can just type:just isortjust isort blackjust lintThe configuration file is hidden, that is, the filename is
.justfile, so it won't show up in most directory listings. I'm not sure that we have to add even more documentation about this file, though I'm happy to do so if we expect enough users. Otherwise, its nice for the file to be present, but doesn't affect anything otherwise.We could optionally migrate from pre-commit to Just, but I don't think we should. pre-commit has nice git integration, it already works for us, and churn is annoying.
Checklist