Skip to content

Improve help text for run, test, and dev commands #5038

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −0
Open

Improve help text for run, test, and dev commands #5038

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

## Unreleased

### Build tool

- The help text displayed by `gleam dev --help`, `gleam test --help`, and
`gleam run --help` has been improved: now each one states which function it's
going to run.
([Giacomo Cavalieri](https://github.com/giacomocavalieri))

### Bug fixes

- Fixed a bug where the "Extract function" code action would not properly
Expand Down
6 changes: 6 additions & 0 deletions compiler-cli/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,8 @@ enum Command {
Shell,

/// Run the project
///
/// This command runs the `main` function defined in `src/<PROJECT_NAME>.gleam`
#[command(trailing_var_arg = true)]
Run {
#[arg(short, long, ignore_case = true, help = target_doc())]
Expand All @@ -235,6 +237,8 @@ enum Command {
},

/// Run the project tests
///
/// This command runs the `main` function defined in `test/<PROJECT_NAME>_test.gleam`.
#[command(trailing_var_arg = true)]
Test {
#[arg(short, long, ignore_case = true, help = target_doc())]
Expand All @@ -247,6 +251,8 @@ enum Command {
},

/// Run the project development entrypoint
///
/// This command runs the `main` function defined in `dev/<PROJECT_NAME>_dev.gleam`
#[command(trailing_var_arg = true)]
Dev {
#[arg(short, long, ignore_case = true, help = target_doc())]
Expand Down
Loading