Skip to content

Commit

Permalink
v1.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
KamasamaK committed Mar 19, 2020
1 parent 9ccf52b commit be63475
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 15 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Changelog

## v1.0.1

* Bump dependencies
* Clarify that VS Code tasks are what is being used

## v1.0.0

* Initial release
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ You are expected to have CommandBox installed on your system.

### Scripts

This extension supports running CommandBox scripts as [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 tasks. You can also annotate task definitions in your `tasks.json` files using the `type` as `commandbox` and `script` as the script name.
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 tasks, use the Task menu items or commands.
To run scripts as VS Code tasks, use the Task menu items or commands.

#### Script Explorer

Expand All @@ -20,13 +20,13 @@ The CommandBox Script Explorer shows the CommandBox scripts found in your worksp

#### Run Scripts from the Editor

The extension supports to run the selected script as a 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`.
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 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.
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

Expand Down Expand Up @@ -74,12 +74,12 @@ The extension also fetches data from ForgeBox to provide auto-completion and inf

## Settings

- `commandbox.autoDetect` - Enable detecting scripts as tasks. [*Default*: `on`]
- `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 task contains this as part of its name, it will be assigned as a build task. [*Default*: `["build", "compile", "watch"]`]
- `commandbox.testNames` - When a task name starts with this, it will be assigned as a test task. [*Default*: `["test"]`]
- `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.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`]
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"publisher": "ortus-solutions",
"displayName": "CommandBox",
"description": "Extension to add support for CommandBox",
"version": "1.0.0",
"version": "1.0.1",
"license": "MIT",
"engines": {
"vscode": "^1.43.0"
Expand Down Expand Up @@ -43,7 +43,7 @@
"@typescript-eslint/parser": "^2.24.0",
"clean-webpack-plugin": "3.0.0",
"eslint": "^6.8.0",
"eslint-plugin-jsdoc": "^22.0.1",
"eslint-plugin-jsdoc": "^22.1.0",
"rimraf": "^3.0.2",
"ts-loader": "^6.2.1",
"typescript": "^3.8.3",
Expand Down Expand Up @@ -234,7 +234,7 @@
"compile",
"watch"
],
"description": "When a task contains this as part of its name, it will be assigned as a build task.",
"description": "When a VS Code task contains this as part of its name, it will be assigned as a build task.",
"scope": "resource"
},
"commandbox.testNames": {
Expand All @@ -245,7 +245,7 @@
"default": [
"test"
],
"description": "When a task name starts with this, it will be assigned as a test task.",
"description": "When a VS Code task name starts with this, it will be assigned as a test task.",
"scope": "resource"
},
"commandbox.forgebox.fetchOnlinePackageInfo": {
Expand Down

0 comments on commit be63475

Please sign in to comment.