chore: justfile recipe names consistent+guessable #2581
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.
Issues
N/A
Description
Some
justfilerecipe names include hyphens between words, some just glom all words together.Some places refer to a plugin while some refer to an extension.
Some recipe names use a full word and some use an abbreviation.
Occasionally a recipe name is not intuitive and it's not immediately obvious that there's a recipe that does what you're looking for. For instance I always confuse the POS-tagging and snapshot tests.
When testing dictionary curation PRs it might be quicker to test just these two than to run
cargo test.But we had a recipe named
runsnapshotsthat called two internal tests:test_pos_tagger, with an intuitive name; andtest_most_lints, with an unintuitive name since it's the one that tests the snapshots.Since I wanted to address this last problem I decided to just add
aliases to the other recipes.justfiledidn't supportaliaswhen we first started using it but has done so for months now.Please feel free to critique my choices!
How Has This Been Tested?
I manually tested some, but not all, of the recipes.
Checklist