casey / casey/just

Feature Request - Add ability to give a help message for a recipe.

Open
#2,710 4 comments 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
35.8k
Forks
846
Avg merge
27m
Merged PRs (30d)
3

Description

If there is a recipe that takes multiple arguments, some of which are not optional, it would be very useful to have the ability to run `just recipe --help` and get a more verbose message than what is in `doc`. For example, I work in a multi-repo environment but all of our repos have the same setup. I would like to have a `Justfile` at the base directory where all of my repos are that include some testing functions. While the commands are the same the paths have differences based on which repo it is (application, library, or lambda) and I would like to be able to easily have the documentation as to what it should be.
In addition, this would be useful to have if a recipe has required arguments and not all of them are passed as a more descriptive manner of telling the user what the arguments need to be rather than just

```
error: Recipe `esc-uuid` got 0 arguments but takes 1
usage:
just esc-uuid uuid
```

Contributor guide

Open the contributing guide

Research direction

Start by tracing how recipe arguments are validated and how usage text is generated for missing arguments. Define the help-message format and how `just recipe --help` should differ from the existing `doc` text, then verify both explicit help and missing-required-argument cases.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.