Skip to content
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.

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

Complete all keywords and builtins #44

Merged
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
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.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,12 @@ Add syntax highlighting, linting, code formatting and snippets for the fish shel

<img src="highlighting.png" alt="syntax highlighting" width="400"/>

## Completion

Non-context aware completion for keywords,
builtins and functions. Custom user functions are not shown
in completion results.

## Code Linting

Code linting uses `fish -n`.
Expand Down
Loading
Loading