Skip to content

Commit

Permalink
IAC-807 - Update documentation and samples
Browse files Browse the repository at this point in the history
  • Loading branch information
VenelinBakalov committed Apr 10, 2024
1 parent 796a7f0 commit e174758
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ export class ServerCollection {

/**
* Collect all vRO Scripting API (Plugin) objects like VcPlugin, ActiveDirectory, etc.
* Function is asynchronous and usually take 5-10 mins since the full list of plugin details
* Function is asynchronous and usually takes approximately 10 mins since the full list of plugin details
* is huge (approximately 370 000 lines of JSON definitions)
*
* @returns vmw.pscoe.hints.IClass[]
Expand Down
22 changes: 22 additions & 0 deletions wiki/Using-the-VS-Code-Extension.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,3 +96,25 @@ The `vrdev.tasks.exclude` setting can be used to _exclude_ certain projects from
"my.example.library:util" // Exclude util library (<groupId>:<artifactId>)
]
```

#### Display Hints in Java Script Projects

The VS Code plugin supports displaying action hints for modules and actions that are present in vRO along with the modules and actions that are part of the currently opened project. If you type:

```javascript
System.getModule("com.module.path.").
```

or

```javascript
Class.load("com.module.path.").
```

a list of hints with modules available on vRO and in locally opened projects would be presented as list, furthermore methods and parameters would be also present as hints, as shown in the example below:

./images/js-code-hinting.png

The hinting functionality also supports displaying hints for constructors, methods and attributes of all Scripting API (vRO plugin) objects available on the vRO server, as shown in the example below:

./images/js-plugin-hinting.png
Binary file added wiki/images/js-code-hinting.png
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 wiki/images/js-plugin-hinting.png
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 e174758

Please # to comment.