https://github.com/ortus-solutions/vscode-commandbox

VS Code support for CommandBox
https://github.com/ortus-solutions/vscode-commandbox

commandbox vscode vscode-extension

Last synced: 4 months ago
JSON representation

VS Code support for CommandBox

• Host: GitHub
• URL: https://github.com/ortus-solutions/vscode-commandbox
• Owner: Ortus-Solutions
• License: mit
• Created: 2017-10-03T15:36:36.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-09-03T22:12:00.000Z (almost 2 years ago)
• Last Synced: 2025-10-20T21:42:02.418Z (8 months ago)
• Topics: commandbox, vscode, vscode-extension
• Language: TypeScript
• Homepage:
• Size: 1.24 MB
• Stars: 8
• Watchers: 16
• Forks: 7
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# VS Code CommandBox extension

[![VS Marketplace](https://vsmarketplacebadge.apphb.com/version-short/ortus-solutions.vscode-commandbox.svg)](https://marketplace.visualstudio.com/items?itemName=ortus-solutions.vscode-commandbox)

[![Open VSX](https://img.shields.io/open-vsx/v/ortus-solutions/vscode-commandbox)](https://open-vsx.org/extension/ortus-solutions/vscode-commandbox)

Integrates [CommandBox](https://www.ortussolutions.com/products/commandbox) into VS Code. If you are new to CommandBox, check the [documentation](https://commandbox.ortusbooks.com/).

You are expected to have CommandBox installed on your system.

## Features

### Scripts

This extension supports running CommandBox scripts as [VS Code tasks](https://code.visualstudio.com/docs/editor/tasks). Scripts containing the name 'build', 'compile', or 'watch' are treated as build tasks. Any scripts defined in the `box.json` will be auto-detected by default and added as VS Code tasks. You can also annotate VS Code task definitions in your `tasks.json` files using the `type` as `commandbox` and `script` as the script name.

To run scripts as VS Code tasks, use the Task menu items or commands.

#### Script Explorer

The CommandBox Script Explorer shows the CommandBox scripts found in your workspace. The explorer view is enabled by the setting `commandbox.enableScriptExplorer`. A script can be opened or run from the explorer.

![CommandBox Scripts View](./images/commandbox-scripts-view.png)

#### Run Scripts from the Editor

The extension supports to run the selected script as a VS Code task when editing the `box.json` file. You can either run a script from the hover shown on a script or using the command `commandbox: Run Selected Script`.

![Box Script Hover](./images/box-script-hover.png)

#### Run Scripts from a Folder in the Explorer

The extension supports running a script as a VS Code task from a folder in the Explorer. The command `commandbox: Run Script in Folder...` shown in the Explorer context menu finds all scripts in `box.json` files that are contained in this folder. You can then select the script to be executed as a task from the resulting list. You enable this support with the `commandbox.runScriptFromFolder` which is `false` by default.

### Editing server.json

#### Schema

The extension ships with a schema for the `server.json` file to provide auto-completion and information on hover for standard properties. To ensure it is kept up-to-date without having to update the extension, the latest schema in the GitHub `master` is pulled when the extension is activated.

##### Property Completion

![Server Completion](./images/server-completion.png)

##### Property Hover

![Server Hover](./images/server-hover.png)

### Editing box.json

#### Schema

The extension ships with a schema for the `box.json` file to provide auto-completion and information on hover for standard properties. To ensure it is kept up-to-date without having to update the extension, the latest schema in the GitHub `master` is pulled when the extension is activated.

##### Property Completion

![Box Completion](./images/box-completion.png)

##### Property Hover

![Box Hover](./images/box-hover.png)

#### Dependencies

The extension also fetches data from ForgeBox to provide auto-completion and information on hover features on dependencies.

##### Slug Completion

![Dependency Slug Completion](./images/dependency-slug-completion.png)

##### Version Completion

![Dependency Version Completion](./images/dependency-version-completion.png)

##### Hover

![Dependency Hover](./images/dependency-hover.png)

## Settings

- `commandbox.autoDetect` - Enable detecting scripts as VS Code tasks. [*Default*: `on`]

- `commandbox.exclude` - Glob patterns for folders that should be excluded from automatic script detection. The pattern is matched against the **absolute path** of the `box.json`. For example, to exclude all test folders use `**/test/**`.

- `commandbox.enableScriptExplorer` - Enable an explorer view for CommandBox scripts when there is no top-level `box.json` file. [*Default*: `false`]

- `commandbox.enableRunFromFolder` - Enable running CommandBox scripts from the context menu of folders in Explorer. [*Default*: `false`]

- `commandbox.scriptExplorerAction` - The default click action: `open` or `run`. [*Default*: `open`]

- `commandbox.buildNames` - When a VS Code task contains this as part of its name, it will be assigned as a build task. [*Default*: `["build", "compile", "watch"]`]

- `commandbox.testNames` - When a VS Code task name starts with this, it will be assigned as a test task. [*Default*: `["test"]`]

- `commandbox.scriptExplorerExclude` - An array of regular expressions that indicate which scripts should be excluded from the CommandBox Scripts view. [*Default*: `[]`]

- `commandbox.forgebox.fetchOnlinePackageInfo` - Fetch data from ForgeBox to provide auto-completion and information on hover features on dependencies. [*Default*: `true`]

- `commandbox.forgebox.endpointUrl` - The URL for the ForgeBox endpoint. Customize for ForgeBox Enterprise. [*Default*: `https://www.forgebox.io`]

## Contributing

See [CONTRIBUTING.md](/CONTRIBUTING.md)