chore: justfile recipe names consistent+guessable#2581
chore: justfile recipe names consistent+guessable#2581elijah-potter merged 3 commits intoAutomattic:masterfrom
Conversation
| alias auditdict := auditdictionary | ||
|
|
||
| alias audit-dict := auditdictionary | ||
| auditdictionary DIR="harper-core": |
There was a problem hiding this comment.
I think this PR looks great, and I like a lot of the aliases that you've added to make things easier to guess. I would like to standardize on chain-case for all of these names. Would you mind removing all the instances where the words have just been mushed together, like auditdictionary?
There was a problem hiding this comment.
I think this PR looks great, and I like a lot of the aliases that you've added to make things easier to guess. I would like to standardize on chain-case for all of these names. Would you mind removing all the instances where the words have just been mushed together, like auditdictionary?
Absolutely. I also found them ungainly but some had been around for so long that I didn't want to presume. And, for the short ones, didn't seem like a terrible idea.
Things I won't change to chain-case:
- dogfood
- precommit
- setup
Old things I will change to chain-case:
- addnoun
- getforms
- getmetadata
- getnps
- registerlinter
- runsnapshots
Others I don't really consider old enough to be too worried about changing
I also provided a backup to use `find` in `just dogfood` when `fd` is not available
elijah-potter
left a comment
There was a problem hiding this comment.
Looks great to me! Thanks!
| echo Linting $file | ||
| ./target/release/harper-cli lint $file | ||
|
|
||
| if command -v fd &> /dev/null; then |
This MR contains the following updates: | Package | Update | Change | |---|---|---| | [Automattic/harper/harper-ls](https://github.com/Automattic/harper) | minor | `v1.6.0` → `v1.7.0` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>Automattic/harper (Automattic/harper/harper-ls)</summary> ### [`v1.7.0`](https://github.com/Automattic/harper/releases/tag/v1.7.0) [Compare Source](Automattic/harper@v1.6.0...v1.7.0) #### What's Changed - feat: worth to do → worth doing by [@​hippietrail](https://github.com/hippietrail) in [#​2638](Automattic/harper#2638) - build(deps): bump time from 0.3.41 to 0.3.47 by [@​dependabot](https://github.com/dependabot)\[bot] in [#​2663](Automattic/harper#2663) - refactor: use `Span::empty` to create empty spans by [@​86xsk](https://github.com/86xsk) in [#​2658](Automattic/harper#2658) - feat(core): create expression references by [@​elijah-potter](https://github.com/elijah-potter) in [#​2664](Automattic/harper#2664) - feat: replace `DayAndAge` Weir with more flexible linter by [@​hippietrail](https://github.com/hippietrail) in [#​2666](Automattic/harper#2666) - build(deps): bump criterion from 0.8.1 to 0.8.2 by [@​dependabot](https://github.com/dependabot)\[bot] in [#​2678](Automattic/harper#2678) - build(deps): bump sysinfo from 0.38.0 to 0.38.1 by [@​dependabot](https://github.com/dependabot)\[bot] in [#​2677](Automattic/harper#2677) - build(deps): bump anyhow from 1.0.100 to 1.0.101 by [@​dependabot](https://github.com/dependabot)\[bot] in [#​2674](Automattic/harper#2674) - feat: thru→through by [@​hippietrail](https://github.com/hippietrail) in [#​2680](Automattic/harper#2680) - fix(core): overlap removal did not respect priority by [@​elijah-potter](https://github.com/elijah-potter) in [#​2685](Automattic/harper#2685) - fix: don't lowercase "This" by [@​hippietrail](https://github.com/hippietrail) in [#​2651](Automattic/harper#2651) - feat: layouted/layouting→laid out/laying out by [@​hippietrail](https://github.com/hippietrail) in [#​2669](Automattic/harper#2669) - build(deps): bump clap from 4.5.56 to 4.5.57 by [@​dependabot](https://github.com/dependabot)\[bot] in [#​2675](Automattic/harper#2675) - refactor(core): simplify loops via iterators by [@​86xsk](https://github.com/86xsk) in [#​2686](Automattic/harper#2686) - fix: don't flag more foreign → foreigner by [@​hippietrail](https://github.com/hippietrail) in [#​2659](Automattic/harper#2659) - feat: atall→at all by [@​hippietrail](https://github.com/hippietrail) in [#​2679](Automattic/harper#2679) - feat: `SplitWords` makes multiple suggestions by [@​hippietrail](https://github.com/hippietrail) in [#​2683](Automattic/harper#2683) - feat: `harper-cli` accept common dialect synonyms, abbreviations by [@​hippietrail](https://github.com/hippietrail) in [#​2562](Automattic/harper#2562) - chore: justfile recipe names consistent+guessable by [@​hippietrail](https://github.com/hippietrail) in [#​2581](Automattic/harper#2581) - feat: Add Zig support by [@​hippietrail](https://github.com/hippietrail) in [#​2688](Automattic/harper#2688) - feat(obsidian): allow users to mask out text using regular expressions by [@​elijah-potter](https://github.com/elijah-potter) in [#​2684](Automattic/harper#2684) - feat: not longer→no longer by [@​hippietrail](https://github.com/hippietrail) in [#​2691](Automattic/harper#2691) - fix(lint-framework): `SuggestionKind.InsertAfter` removing text by [@​elijah-potter](https://github.com/elijah-potter) in [#​2693](Automattic/harper#2693) **Full Changelog**: <Automattic/harper@v1.6.0...v1.7.0> </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0My4xMC4zIiwidXBkYXRlZEluVmVyIjoiNDMuMTAuMyIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiUmVub3ZhdGUgQm90IiwiYXV0b21hdGlvbjpib3QtYXV0aG9yZWQiLCJkZXBlbmRlbmN5LXR5cGU6Om1pbm9yIl19-->
* chore: justfile recipe names consistent+guessable * chore: standardize on chain-case I also provided a backup to use `find` in `just dogfood` when `fd` is not available
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