https://github.com/rokucommunity/vscode-brightscript-language
A Visual Studio Code extension for Roku's BrightScript language
https://github.com/rokucommunity/vscode-brightscript-language
Last synced: 26 days ago
JSON representation
A Visual Studio Code extension for Roku's BrightScript language
- Host: GitHub
- URL: https://github.com/rokucommunity/vscode-brightscript-language
- Owner: rokucommunity
- License: mit
- Created: 2017-10-25T14:41:49.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-05-01T22:37:52.000Z (about 1 month ago)
- Last Synced: 2025-05-01T23:27:04.722Z (about 1 month ago)
- Language: TypeScript
- Size: 5.5 MB
- Stars: 117
- Watchers: 14
- Forks: 47
- Open Issues: 71
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/contributing.md
- License: LICENSE
Awesome Lists containing this project
- awesome-roku - vscode-brightscript-language - VSCode extension with awesome support for Brightscript and SceneGraph (Editor Extensions)
README
# BrightScript Language extension for VSCode
[](https://github.com/rokucommunity/vscode-brightscript-language/actions/workflows/build.yml)
[](https://coveralls.io/github/rokucommunity/vscode-brightscript-language?branch=master)
[](https://marketplace.visualstudio.com/items?itemName=RokuCommunity.brightscript)
[](https://marketplace.visualstudio.com/items?itemName=RokuCommunity.brightscript)
[](https://open-vsx.org/extension/RokuCommunity/brightscript)
[](LICENSE)
[](https://join.slack.com/t/rokudevelopers/shared_invite/zt-4vw7rg6v-NH46oY7hTktpRIBM_zGvwA)
The popular [BrightScript Language](https://marketplace.visualstudio.com/items?itemName=RokuCommunity.brightscript) extension for [VSCode](https://code.visualstudio.com/) is used by thousands of Roku developers around the world. Revolutionize your Roku development workflow by using this powerful tool.
---
## Notable features
The extension is packed with features, but here are some highlights:
- Side-load directly to a roku device from VSCode
- In editor debugging support including breakpoints, variable inspection, and more...
- Integrated device logs and interactive console (see image below)
- Catch errors in VSCode with the built in syntax checking. (Powered by the [BrighterScript](https://github.com/rokucommunity/brighterscript) language server)
- Automatic rendezvous tracking when `logrendezvous` is enabled on the Roku device.
- Syntax highlighting, code formatting, symbol navigation, and [much more](https://rokucommunity.github.io/vscode-brightscript-language/features.html)
## Documentation
For a full list of features and settings, please see our [documentation website](https://rokucommunity.github.io/vscode-brightscript-language), or click one of the links below.
### Extension
- [Features](https://rokucommunity.github.io/vscode-brightscript-language/features.html) - The full list of features provided by [BrightScript Language](https://marketplace.visualstudio.com/items?itemName=RokuCommunity.brightscript)
- [KeyBindings](https://rokucommunity.github.io/vscode-brightscript-language/keyboard-shortcuts.html) - A full list of pre included keybindings
- [Extension Settings](https://rokucommunity.github.io/vscode-brightscript-language/extension-settings.html) - The full list of possible VS Code settings
### Code Editing
- [Language Server Errors and Warnings](https://rokucommunity.github.io/vscode-brightscript-language/Editing/error-handling.html) - Ways to handle different errors show by the language server
- [Code formatting](https://rokucommunity.github.io/vscode-brightscript-language/Editing/code-formatting.html) - How to set up code formatting and the different formatting options.
- [Code Snippets](https://rokucommunity.github.io/vscode-brightscript-language/Editing/snippets.html) - A collection of useful code sippets
### Debugging
- [Basic project setup](https://rokucommunity.github.io/vscode-brightscript-language/Debugging/index.html) - Launching and debugging your local project on a Roku device.
- [Component Libraries](https://rokucommunity.github.io/vscode-brightscript-language/Debugging/component-libraries.html) - How to define custom component libraries in your `launch.json`
- [Deeplinking](https://rokucommunity.github.io/vscode-brightscript-language/Debugging/deep-linking.html) - Sending deeplinks from the `launch.json`
- [Remote control emulation](https://rokucommunity.github.io/vscode-brightscript-language/Debugging/remote-control-mode.html) - How to emulate the Roku remote control
- [Rale](https://rokucommunity.github.io/vscode-brightscript-language/Debugging/rale.html) - Inject Rale into your application without committing the TrackerTask to your repository
- [BS_Consts](https://rokucommunity.github.io/vscode-brightscript-language/Debugging/bs-const.html) - Changing `bs_const` values from the `launch.json`
- [Advanced Project Setup](https://rokucommunity.github.io/vscode-brightscript-language/Debugging/advanced-project-setup.html) - Setting up your project with complex use cases such as custom build scripts or source files located in multiple different directories.
## Contributing
The majority of this extension's language feature support depends on the [BrighterScript](https://github.com/RokuCommunity/brighterscript) project, which contributes the language server. The debugging functionality comes from the [roku-debug](https://github.com/RokuCommunity/roku-debug) project. If you would like to contribute please see our [contributing guide](https://rokucommunity.github.io/vscode-brightscript-language/contributing.html)
## Changelog
Click [here](https://github.com/RokuCommunity/vscode-brightscript-language/blob/master/CHANGELOG.md) to see the changelog.