Skip to content
Extension for Visual Studio Code that provides code intelligence features and enables a more developer-friendly experience when creating vRealize content
TypeScript JavaScript Shell
Branch: master
Clone or download
Latest commit c5ffe8d Jul 22, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Add section for related issues/PRs in the GitHub templates Jul 22, 2019
.vscode Use eslint and prettier Apr 21, 2019
assets Add reference to vRealize Build Tools May 29, 2019
build Fix preinstall script's node version Jun 4, 2019
common Fixed #34 - Change destination type to Uri and use toString() and fsP… Jul 1, 2019
extension Fixed #34 - Cannot open a freshly generated project on Windows Jul 22, 2019
language-server Update multiple dependencies to latest version Jun 2, 2019
protocol Initial commit Feb 23, 2019
.editorconfig Initial commit Feb 23, 2019
.eslintignore Use eslint and prettier Apr 21, 2019
.eslintrc.js Disable import/export and import/named Apr 21, 2019
.gitattributes Initial commit Feb 23, 2019
.gitignore Move to TypeScript 3.4 Apr 6, 2019
.prettierrc.js Format YAML with 2 spaces Jun 2, 2019
.vscodeignore Use eslint and prettier Apr 21, 2019
.yarnrc Initial commit Feb 23, 2019
CONTRIBUTING.md Update contributing guide with node 10+ requirement Jul 22, 2019
LICENSE.txt Initial commit Feb 23, 2019
NOTICE.txt Initial commit Feb 23, 2019
README.md Add codecov config Jun 4, 2019
gulpfile.js Checkout release commit before building the release package May 1, 2019
jest.config.js Add logger tests Apr 6, 2019
open_source_licenses.txt Add open_source_licenses.txt Mar 12, 2019
package.json Release v2.0.4 [skip ci] Jul 22, 2019
tsconfig.json Migrate to Jest for unit tests Apr 6, 2019
yarn.lock [Security] Bump lodash from 4.17.11 to 4.17.13 Jul 11, 2019

README.md

vRealize Developer Tools

A Visual Studio Code extension that provides code intelligence features and enables a more developer-friendly experience when creating vRealize Orchestrator and vRealize Automation content.

Visual Studio Marketplace Version Build Status Dependabot Status Dependencies Status Coverage Status

Prerequisites

To use most of the vRealize Developer Tools's functionality, you will need a development vRealize Orchestrator instance and to set up vRealize Build Tools.

Features

Multiple environments

Connect to different vRO environments by configuring maven profiles in ~/.m2/settings.xml.

<profile>
    <id>my-env</id>
    <properties>
        <!-- vRO Connection -->
        <vro.host>10.27.120.27</vro.host>
        <vro.port>443</vro.port>
        <vro.username>administrator@vsphere.local</vro.username>
        <vro.password>myPlainTextPass</vro.password>
        <vro.auth>basic</vro.auth> <!-- or 'vra' for sso auth -->
        <vro.tenant>vsphere.local</vro.tenant> <!-- required for 'vra' auth -->

        <!-- vRA Connection -->
        <vra.host>10.27.120.27</vra.host>
        <vra.port>443</vra.port>
        <vra.username>configurationadmin@vsphere.local</vra.username>
        <vra.password>myPlainTextPass</vra.password>
        <vra.tenant>vsphere.local</vra.tenant>
    </properties>
</profile>

Once vRealize Developer Tools extension is activated in VS Code, on the bottom left corner of the status bar, an idicator is shown if there is no currently active profile.

Missing profile

Click on it to see list of all available profiles and select one to activate.

Environment profiles

Active profile name and the IP address of the vRealize Orchestrator instance is shown in the status bar.

Active profile

Project on-boarding

The vRealize: New Project command from the VS Code comand palette (Cmd+Shift+P / Ctrl+Shift+P) can be used to on-board a new vRealize project.

Project on-boarding

vRO-aware IntelliSense

Visual Studio Code's IntelliSense feature for JavaScript files is enhanced with with symbols and information from the vRO’s core scripting API, plug-in objects and actions.

vRO-aware IntelliSense

Run action

The vRealize: Run Action command from the VS Code comand palette (Cmd+Shift+P / Ctrl+Shift+P) allows running an action JavaScript file in live vRO instance while seeing the logs in the OUTPUT panel.

Run action

Open action's source

The source code of actions that are available only on the remove vRO instance can be viewed by using the vRealize: Open Action command.

Open action's source

Push and Pull content

The VS Code build tasks palette (Cmd+Shift+B / Ctrl+Shift+B) contains commands for pushing content to a live vRO/vRA instance and for pulling workflows, configurations, resources and vRA content back to your local machine – in a form suitable for committing into source control.

Push and Pull content

The vrdev.tasks.exclude setting can be used to exclude certain projects from the list of build tasks (Cmd+Shift+B) by using glob patterns

"vrdev.tasks.exclude" : [
    "my.example.library*", // Exclude all libraries
    "!my.example.library*", // Exclude everything, except libraries
    "my.example!(library*)", // Exclude everything from 'my.example', except libraries
    "my.example.library:{nsx,vra,vc}", // Exclude nsx, vra and vc libraries
    "my.example.library:util" // Exclude util library (<groupId>:<artifactId>)
]

Upgrade steps

If you have installed any versions prior 2.0.0, do the following to upgrade.

  1. Remove the old version from the VS Code Extensions panel (Cmd+Shift+X)
  2. Reload VS Code by executing the Reload Window command (Cmd+Shift+P)
  3. Install the latest version of vRealize Developer Tools.

Contributing

If you're interested in contributing, see our contributing guide.

Open Source Licenses

Please see the file open_source_licenses.txt.

License

Copyright 2018-2019 VMware, Inc.

Licensed under the MIT License.

You can’t perform that action at this time.