Skip to content

Commit

Permalink
chore(cli): add USAGE and NOTES section in --help
Browse files Browse the repository at this point in the history
  • Loading branch information
numToStr committed Jun 28, 2022
1 parent d902592 commit d6a5eaf
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 0 deletions.
2 changes: 2 additions & 0 deletions emmylua.md
Original file line number Diff line number Diff line change
Expand Up @@ -436,6 +436,7 @@ You can also define a (pseudo) enum using [`---@alias`](#alias).
local U = {}

---@alias VMode
---Vim operator-mode motions. Read `:h map-operator`
---| 'line' Vertical motion
---| 'char' Horizontal motion
---| 'v'
Expand All @@ -452,6 +453,7 @@ return U

```help
VMode *VMode*
Vim operator-mode motions. Read `:h map-operator`
Variants: ~
('line') Vertical motion
Expand Down
8 changes: 8 additions & 0 deletions src/cli.rs
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,14 @@ OPTIONS:
-c, --prefix-class Prefix ---@class tag with return/mod name
-h, --help Print help information
-v, --version Print version information
USAGE:
{NAME} /path/to/first.lua /path/to/second.lua > doc.txt
{NAME} -c -a /path/to/{{first,second,third}}.lua > doc.txt
NOTES:
- The order of parsing + rendering relative to the given files
- Types and Functions will be prefixed with ---@mod name
"
);
}
Expand Down

0 comments on commit d6a5eaf

Please sign in to comment.