Skip to content

Commit

Permalink
docs: Add missing option to readme, update demo gifs, update "API fil…
Browse files Browse the repository at this point in the history
…es preview" section
  • Loading branch information
deiteris committed May 20, 2021
1 parent a39f030 commit a87ed33
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 1 deletion.
Binary file added docs/images/language_demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/preview_command.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 6 additions & 1 deletion extension/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,11 @@ See supported types of documents: https://github.com/aml-org/als#what-is-als
## Available settings

* `apiContractor.trace.server` - Traces the communication between VS Code and the language server.
* `apiContractor.autoDetectRootApi` - Enables the root API file auto detection.
* `apiContractor.autoDetectRootApi` - Enables automatic detection and selection of the root API file.
* `apiContractor.autoRenameRefs` - Configures automatic rename of the referenced files. Works only when the workspace has the root API file set.
* `apiContractor.notification.noMainApiFileSet` - Enables notification when no main API file is set.
* `apiContractor.jvm.arguments` - Uses provided arguments to execute the JVM version of the language server.
* `apiContractor.autoReloadApiPreviewOnSave` - Enables automatic reload of the API file preview when it is saved. API file preview tabs must be reopened when this setting is changed. Note: in structured projects where root API file is set, the API file preview will be also reloaded when its referenced files are saved.

## Features

Expand All @@ -41,6 +42,8 @@ See supported types of documents: https://github.com/aml-org/als#what-is-als
Language functionality relies on [LSP support in ALS](https://github.com/aml-org/als#lsp-support-in-als). You
can find currently supported features there.

![Basic language features demonstration](https://raw.githubusercontent.com/deiteris/api-contractor/master/docs/images/language_demo.gif)

#### Custom

##### Setting a root API file
Expand Down Expand Up @@ -70,6 +73,8 @@ You can configure this behavior by changing the `apiContractor.autoRenameRefs` o

Currently opened API file can be previewed and tried out with the API Console. A command to invoke API file preview is `API Contractor: Preview current API file`.

If the `apiContractor.autoReloadApiPreviewOnSave` option is enabled, the API file preview is updated when the previewed API file is saved.

![API file preview demonstration](https://raw.githubusercontent.com/deiteris/api-contractor/master/docs/images/preview_command.gif)

#### API format conversion
Expand Down

0 comments on commit a87ed33

Please sign in to comment.