Skip to content

Commit

Permalink
Prepare docs for release 0.0.4
Browse files Browse the repository at this point in the history
  • Loading branch information
ctjdr committed Oct 14, 2020
1 parent 562b9c5 commit 435de47
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 9 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Change Log

## 0.0.4
- Enable to use "Find all References" and "Peek References" commands to search service name references in all manifest.json files
- Add auto-completion for service names when editing `"providing"` and `"provides"` elements.

## 0.0.3
- Added missing description for manifest.json elements.

Expand Down
39 changes: 30 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,7 @@
![Node.js CI](https://github.com/ctjdr/vscode-apprt-bundles/workflows/Node.js%20CI/badge.svg?branch=master)
# Visual Studio Code extension for apprt bundles

Adds syntactic validation, auto-completion and code-suggest to _manifest.json_ files, used to define apprt bundles.

The feature is implemented based on a JSON Schema file, defining the cornerstones of a manifest.json file.

![Feature Demo](images/demo.gif)
Supports working with apprt bundles, especially when editing bundle _manifest.json_ files.

## Using the extension

Expand All @@ -16,14 +12,39 @@ The feature is implemented based on a JSON Schema file, defining the cornerstone

## Features

* _Validation_ of manifest.json file
### Validation, documentation, auto-complete for JSON structure

This feature is implemented based on a JSON Schema file, defining the cornerstones of a manifest.json file.

* Structural _validation_ of manifest.json file
* _Documentation hints_ on manifest.json editing
* _Auto-complete_ and _code suggest_ for JSON structure

* _Auto-complete_ and _code suggest_ for manifest JSON structure

![Feature Demo](images/demo.gif)

### Search service references ("providing", "provides")

Search for references to the service name under the current cursor.
Finds all occurences in other manifest.json files.

The search can be triggered by the following commands:

* \> Find all References_ (Alt-Shift-F12)
* \> _Go to References_ (Shift-F12)
* \> _Peek References_

![Feature Demo](images/feature_servicename_references.gif)

### Service name completion ("providing", "provides")

Auto-comlete lists all service names available in the current context, when typing a value for `"provides"` or `"providing"`.
The list of service names available for completion is made up by all service names used in manifest.json files of the workspace (currently they are not taken from JAR files or other sources).

![Feature Demo](images/feature_servicename_completion.gif)

## Upcoming

* Find service name references: When hitting Shift-F12 (**> Find reference**), or Alt-Shift-F12 (**> Find all references**) while over a `"provides"` or`"providing"` value, display links to all references to the same service name.
* Service name references CodeLense: Click on a small link right above a `"provides"` or `"providing"` element to navigate to service name references.

## Further ideas

Expand Down
Binary file added images/feature_servicename_completion.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 added images/feature_servicename_references.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 435de47

Please sign in to comment.