Commandbox
The official CommandBox support package for Sublime IDE
Details
Installs
- Total 5K
- Win 4K
- Mac 751
- Linux 577
Feb 5 | Feb 4 | Feb 3 | Feb 2 | Feb 1 | Jan 31 | Jan 30 | Jan 29 | Jan 28 | Jan 27 | Jan 26 | Jan 25 | Jan 24 | Jan 23 | Jan 22 | Jan 21 | Jan 20 | Jan 19 | Jan 18 | Jan 17 | Jan 16 | Jan 15 | Jan 14 | Jan 13 | Jan 12 | Jan 11 | Jan 10 | Jan 9 | Jan 8 | Jan 7 | Jan 6 | Jan 5 | Jan 4 | Jan 3 | Jan 2 | Jan 1 | Dec 31 | Dec 30 | Dec 29 | Dec 28 | Dec 27 | Dec 26 | Dec 25 | Dec 24 | Dec 23 | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Windows | 0 | 1 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 1 | 0 | 0 | 1 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 2 | 0 | 1 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
Mac | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 |
Linux | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
Readme
- Source
- raw.githubusercontent.com
Sublime Commandbox
A plugin to run Commandbox Commands, including server management and scaffolding, from within Sublime Text 3.
Quickstart
- Install Via Package Control
Commandbox
Installation
via PackageControl
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 pallete and pick Package Control: Install Package
from the dropdown, search and select the CommandBox
package there and you're all set.
Manually
You can clone the repo in your /Packages
(Preferences -> Browse Packages…) folder and start using/hacking it.
cd ~/path/to/Packages
git clone git://github.com/Ortus-Solutions/sublime-commandbox.git Commandbox
Troubleshooting
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.
Usage
Running a Commandbox Command
You may select pre-configured commands from Menu -> Commandbox
, including the ability enter a custom command.
Keyboard Shortcuts:
Ctrl+Shift+B
- Run Commandbox Command: A prompt input will open for you to enter your commandCtrl+Shift+T
- Start the Embedded Server: Your Commandboxcwd
is always the root of your Sublime Project so anybox.json
configuration will be honoredCtrl+Shift+P
- Stop the Embedded ServerAlt+P
- Show the Commandbox Output Panel ( also available in theView -> Commandbox
menu )Alt+[Command|Windows]+P
- Hide the Commandbox Output Panel ( also available in theView -> Commandbox
menu )
Settings
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:
{
"exec_args": {},
"results_in_new_tab": false,
"results_autoclose_timeout_in_milliseconds": 0,
"show_silent_errors": true,
"log_errors": true,
"syntax": "Packages/Commandbox/syntax/CommandboxResults.tmLanguage",
"nonblocking": true,
"check_for_boxjson": true,
}
exec_args
You may override your PATH
environment variable as follows:
{
"exec_args": {
"path": "/bin:/usr/bin:/usr/local/bin"
}
}
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
results_in_new_tab
If set to true
, a new tab will be used instead of a panel to output the results.
results_autoclose_timeout_in_milliseconds
Defines the delay used to autoclose the panel or tab that holds the Commandbox results.
show_silent_errors
If true it will open the output panel when running Commandbox (silent)
only if the task failed
log_errors
Toggles the creation of sublime-commandbox.log
if any error occurs.
syntax
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).
nonblocking
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
.
Bind Your Own Keyboard Shortcuts
You can use a shortcut for running a specific task like this:
{ "keys": ["KEYS"], "command": "commandbox", "args": { "task_name": "watch" } }
LICENSE
Sublime-CommandBox is open source and bound to the LGPL v3 GNU LESSER GENERAL PUBLIC LICENSE Copyright & TradeMark since 2014, Ortus Solutions, Corp
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.