BELA Browser
BELA Browser opens a running BELA frontend inside a VS Code editor tab. As you move between files and symbols, the extension forwards the active file or symbol name to the embedded frontend.
Requirements
- VS Code 1.90.0 or newer
- A BELA frontend project available in the VS Code workspace
Usage
- Select BELA in the Activity Bar.
- Enter the BELA site URL and sign-in token. The token field is hidden.
- Change the server start command when needed, then choose Open BELA. You can also run BELA: Open from the Command Palette, which prompts for the same URL and hidden token.
The extension checks the configured BELA site URL before opening the tab. If BELA is not running, it starts npm run jux-env in a VS Code terminal and waits for the server. Running the command again reveals the existing BELA tab instead of opening another one.
Settings
| Setting |
Default |
Description |
bela.devServerUrl |
http://localhost:2015 |
URL of the running BELA frontend development server. The sign-in token is requested separately and stored in VS Code SecretStorage. |
bela.startCommand |
npm run jux-env |
Command used to start BELA when the server is unavailable. |
Set this per VS Code window when the frontend uses a different host or port.
Development
Install the extension dependencies:
npm install
This also enables the repository's post-commit BELA upload hook. Configure the
token and the path to the compiled integration in your environment. The path may
be absolute or relative to this repository:
$env:BELA_TOKEN = "your-token"
$env:BELA_INTEGRATION_PATH = "../bela-integrations/typescript/dist/index.js"
export BELA_TOKEN="your-token"
export BELA_INTEGRATION_PATH="../bela-integrations/typescript/dist/index.js"
Use setx on Windows or your shell profile on Linux to persist these variables.
The hook runs after every successful commit, does not block the commit, and writes
generation and upload output to .bela/log.txt. Missing configuration skips the
upload and records the reason in the same log.
Start the BELA frontend from its repository:
npm run local
Open this repository in VS Code and press F5 to start an Extension Development Host. In the new window, run BELA: Open from the Command Palette.
Verification and Packaging
Check the extension entry point and create a VSIX package:
npm run check
npm run package
Install the generated .vsix through Extensions: Install from VSIX... in the Command Palette.
Releases
This repository uses GitHub Actions for tagged releases:
- Create and push a version tag, for example
git tag v0.0.1 && git push origin v0.0.1.
- The release workflow checks, packages, uploads the VSIX artifact, and creates a GitHub release.
- Marketplace publishing runs automatically when the repository has a
VSCODE_MARKETPLACE_PAT secret.
For a manual Marketplace release:
npm run package
npm run publish
Update CHANGELOG.md before creating a release tag.
