-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Complete all keywords and builtins (#44)
* feat: complete some keywords * fix: if type * feat: complete all keywords and builtins * feat: mention completion * feat: add abbr documentation * feat: automatically append help option when available * feat: add links to web documentation * feat: add docs for more builtins * feat: explain how to add docs * feat: add docs up to fish command * fix: else type
- Loading branch information
1 parent
aeb3fa5
commit b7f550d
Showing
3 changed files
with
596 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Contributing | ||
|
||
To make some command listed in intellisence suggestions use either `Keyword` or | ||
`Builtin` TypeScript function in [`extension.ts`](./src/extension.ts). | ||
|
||
To explain options available for a command (currently it's possible just for | ||
builtins) add an array of objects like this: | ||
|
||
```typescript | ||
Builtin("alias", "Create a function", [ | ||
{ | ||
description: "Save into your fish configuration directory", | ||
long: "save", | ||
}, | ||
]), | ||
``` | ||
|
||
as the third parameter. By default it's assumed that all builtins have | ||
`-h`|`--help` options available, but if they are not pass `false` as the last | ||
argument. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.