Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions devbox.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
],
"format": "prettier -w \"**/*.{js,mjs}\"",
"format:check": "prettier -c \"**/*.{js,mjs}\"",
"doc:preview": "npx -y --package gren-packages gren-doc-preview",
"test": [
"devbox run test:unit",
"devbox run test:integration"
Expand Down
7 changes: 7 additions & 0 deletions src/Cli/Parser.gren
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,13 @@ prefixHelpText appName prefixName (GroupParser { knownCommands }) =


{-| Definition of a command.

* `word` is the name of the command, like `make` in `gren make`.
* `arguments` and `flags` parse the command's inputs, which will be passed to `builder`.
* `commonDescription`, if set, will include the command along with this description in the list of "commonly used" commands shown in the program's usage help text.
* `summary` is the short description of the command, shown at the top of the command's help text.
* `example` is the longer description and/or example(s) of using the command. It comes after `summary` in the command help text.
* `builder` combines the parsed arguments and flags into a `result`
-}
type alias Command args flags result =
{ word : String
Expand Down
Loading