Blue Planet RA Extension for Visual Studio Code
Also, check out the Blue Planet Extension Pack!
Note
It is recommended to use Python 3.8 or a lower version.
Features
- RA Activity bar shows commands, devices, endpoints and tasks in a tree view.
- Documentation feature for translators
- Shows the
translator
documentation content by hovering over the translator.
- IntelliSense for Translators, Endpoints, Runners and Components in the Commands on click of
ctrl + space
.
- Provides suggestions for selected
runners
and components
.
- Provides suggestions for selected
endpoints
parameters.
- Provides auto-completion suggestions of
translators
along with the translator documentation.
- Provides the suggestions for selected
translator
parameters.
- Adds the support of
bpprov
and rpsdk
libraries for translator suggestions.
- Shows
diagnostics
for invalid values in the commands file.
Activity bar
Blueplanet RA extension provides the following activity bar features.
RA Commands
Blueplanet RA extension lets you view RA commands and edit them.
RA Commands

Devices
Blueplanet RA extension lets you view the devices defined in devices.json
.
Devices

Endpoints
Blueplanet RA extension lets you view the endpoints defined in endpoints.json
.
Endpoints

Create a new RA using the paster command.
Creating a new RA

Tasks
Blueplanet RA extension lets you execute the virtual environment tasks for RA.
Tasks

Available Task Commands
Name |
Description |
prepare-venv |
install requirements and self into virtualenv |
fresh-venv |
prepare a virtualenv without locked requirements |
min-venv |
install the latest dtk-invoke |
min-fresh-venv |
install the latest dtk-invoke |
clean-venv |
deletes the existing virtualenv |
Runners suggestions and diagnostics in the commands file

Endpoint parameters suggestions in the commands file

Translators suggestions in the commands file
shows auto-completion suggestions of translators
along with the translator documentation.
shows the documentation
content of the translator on hover over it and displays the suggestions for the selected translator
parameters on click of ctrl + space

Contributing & Development
We welcome contributions! If you are interested in contributing, please email devexchange@blueplanet.com.
If you are new to VS Code Extension development review the VSC Extension Quickstart and the BP Git Workflow & Contribution Guidelines
- Install
npm i
- Run
npm run build
- Open Debug Panel and Run "Ra Client + Ra Forms + Ra Server"
Development Notes
- The language RA client & server logs to the "BP RA Extension" item in the dropdown in the output window
Manual Packaging
- Install
vsce
(should be already done with npm i
)
- run
yarn run package:ra-ext -- --baseContentUrl=https://developer.blueplanet.com/assets/vscode/ra-extension/ --baseImagesUrl=https://developer.blueplanet.com/assets/vscode/ra-extension/
Manual Install
- Open Extension sidebar
- Select the three dots in the top right of the sidebar
- Select Install from VSIX...
Screenshot

Feedback
Please provide feedback in the Blue Planet Q&A Forums on the myCiena Portal
Release Notes
Refer to the CHANGELOG.md
License
Apache-2.0 - See LICENSE for more info