Even though you can run CommandBox from your favorite terminal window, there are a number of nice IDE integrations out there that are designed to allow you to run command line utilities from inside your favorite editor. Here's a few that we're aware of and how to use them. If you have more, please let us know!
A plugin to run your Commandbox tasks from within Sublime plus some handy snippets too.
Install Via Package Control Commandbox
If you have PackageControl installed, you can use it to install the package.
Just type cmd-shift-p
/ctrl-shift-p
to bring up the command palette and pick Package Control: Install Package
from the dropdown, search and select the CommandBox
package there and you're all set.
You can clone the repo in your /Packages
(Preferences -> Browse Packages...) folder and start using/hacking it.
If you are having trouble running the plugin in Mac OSX it's possible that your path isn't being reported by your shell. In which case give the plugin SublimeFixMacPath a try. It may resolve our issue.
If you still can't get it to run properly, first make sure your Commandbox tasks run from a terminal (i.e. outside of sublime) and if so then submit an issue.
You may select pre-configured commands from Menu -> Commandbox
, including the ability enter a custom command.
Ctrl+Shift+B
- Run Commandbox Command: A prompt input will open for you to enter your command
Ctrl+Shift+T
- Start the Embedded Server: Your Commandbox cwd
is always the root of your Sublime Project so any box.json
configuration will be honored
Ctrl+Shift+P
- Stop the Embedded Server
Alt+P
- Show the Commandbox Output Panel ( also available in the View -> Commandbox
menu )
Alt+[Command|Windows]+P
- Hide the Commandbox Output Panel ( also available in the View -> Commandbox
menu )
The file Commandbox.sublime-settings
is used for configuration, you can change your user settings in Preferences -> Package Settings -> Commandbox -> Settings - User
.
The defaults are:
You may override your PATH
environment variable as follows:
box installed locally
If box is installed locally in the project, you have to specify the path to the box executable. Threfore, adjust the path to /bin:/usr/bin:/usr/local/bin:node_modules/.bin
If set to true
, a new tab will be used instead of a panel to output the results.
Defines the delay used to autoclose the panel or tab that holds the Commandbox results.
If true it will open the output panel when running Commandbox (silent)
only if the task failed
Toggles the creation of sublime-commandbox.log
if any error occurs.
Syntax file for highlighting the box results. You can pick it from from the command panel as Set Syntax: Commandbox results
.
Set the setting to false
if you don't want any colors (you may need to restart Sublime if you're removing the syntax).
When enabled, the package will read the streams from the task process using two threads, one for stdout
and another for stderr
. This allows all the output to be piped to Sublime live without having to wait for the task to finish.
If set to false
, it will read first from stdout
and then from stderr
.
You can use a shortcut for running a specific task like this:
Here are suggestions for using VSC (Visual Studio Code) for developing in CFML.
What do you want to do with VSC?
Install it?
Key Extensions?
Working with the shell/terminal
Git Extensions?
This IDE has it's own domain. ( https://code.visualstudio.com/ ) with downloads for macOS, Windows and Linux on the home page.
You can approach this different ways. It is pretty nice to have the command prompt running right inside your IDE. Pressing CTRL +` will show and/or hide your terminal. This will let you run Commandbox directly inside your terminal.
Go to File > Preferences > Settings
and search for shell.windows
. Hover over the item in DEFAULT SETTINGS
and you will see an edit pencil. Click on that and it will copy the values over to USER SETTINGS
. (NOTE: You can also set stuff up in WORKSPACE SETTINGS
for different projects. Now set the location of commandbox on your system like we did in our system in the example below.
"terminal.integrated.shell.windows": "/path/to/box",
When adding a path, follow the rules for adding platform specific path separators.
Install Shell Launcher and reload the IDE.
Shell Launcher Easily launch multiple shell configurations in the terminal.
Now open your user settings like is shown in the Commandbox only section just above. Add the following to your USER SETTINGS
.
//Shell launcher
// A list of shell configurations for Windows
"shellLauncher.shells.windows": [
{
"shell": "C:\\Windows\\sysnative\\cmd.exe",
"label": "cmd"
},
{
"shell": "/path/to/box",
"label": "Commandbox"
}
],
If you have commandbox mapped to a path you can of course just call box like you would from any terminal and it will load right up for you. Just use any terminal in VSC that would load box
outside VSC and it will run the same.
You should also install a few extensions. (These extensions can also be added from the built in Extensions item.)
Additional Extensions ( of course, choose the ones you want and ignore the others )
Git Lens This will take your git IDE to new levels.
TODO Highlight Add TODO, FIXME or other comments to code and find quickly with this extension.
Project Manager: save folders as projects and easily switch between projects
Hg: integrated Mercurial source control
Great Icons Because it is more fun, nuff said!
More information to follow. (Including video guides to show how to get started that may not be as familiar with different parts.)