You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-7Lines changed: 7 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -8,9 +8,9 @@ You are expected to have CommandBox installed on your system.
8
8
9
9
### Scripts
10
10
11
-
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.
11
+
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.
12
12
13
-
To run scripts as tasks, use the Task menu items or commands.
13
+
To run scripts as VS Code tasks, use the Task menu items or commands.
14
14
15
15
#### Script Explorer
16
16
@@ -20,13 +20,13 @@ The CommandBox Script Explorer shows the CommandBox scripts found in your worksp
20
20
21
21
#### Run Scripts from the Editor
22
22
23
-
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`.
23
+
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`.
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.
29
+
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.
30
30
31
31
### Editing server.json
32
32
@@ -74,12 +74,12 @@ The extension also fetches data from ForgeBox to provide auto-completion and inf
74
74
75
75
## Settings
76
76
77
-
-`commandbox.autoDetect` - Enable detecting scripts as tasks. [*Default*: `on`]
77
+
-`commandbox.autoDetect` - Enable detecting scripts as VS Code tasks. [*Default*: `on`]
78
78
-`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/**'.
79
79
-`commandbox.enableScriptExplorer` - Enable an explorer view for CommandBox scripts when there is no top-level `box.json` file. [*Default*: `false`]
80
80
-`commandbox.enableRunFromFolder` - Enable running CommandBox scripts from the context menu of folders in Explorer. [*Default*: `false`]
81
81
-`commandbox.scriptExplorerAction` - The default click action: `open` or `run`. [*Default*: `open`]
82
-
-`commandbox.buildNames` - When a task contains this as part of its name, it will be assigned as a build task. [*Default*: `["build", "compile", "watch"]`]
83
-
-`commandbox.testNames` - When a task name starts with this, it will be assigned as a test task. [*Default*: `["test"]`]
82
+
-`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"]`]
83
+
-`commandbox.testNames` - When a VS Code task name starts with this, it will be assigned as a test task. [*Default*: `["test"]`]
84
84
-`commandbox.forgebox.fetchOnlinePackageInfo` - Fetch data from ForgeBox to provide auto-completion and information on hover features on dependencies. [*Default*: `true`]
85
85
-`commandbox.forgebox.endpointUrl` - The URL for the ForgeBox endpoint. Customize for ForgeBox Enterprise. [*Default*: `https://www.forgebox.io`]
0 commit comments