brackets-launcher

A Brackets extension to execute system command from Brackets, through menu and/or toolbar icons.

Table of Contents

• Install
• Usage
  • Menus items
    • Divider
    • Item
      • Opts
  • Internal parameters
• Inspired by
• License

Install

Use the extension manager (File > Extension Manager) and search for brackets-launcher. There you can install brackets-launcher.

From GitHub (newest version): File > Extension Manager > Install from URL > http://github.com/guitarneck/brackets-launcher > Install

Usage

Create a launcher-config.json file into your project workspace.

{
    "gulp":true,
    "nmp":true,
    
    "colors":["#efefef","black"],
    
    "link":
    {
        "href": "https://use.fontawesome.com/releases/v5.3.1/css/all.css",
        "integrity": "sha384-mzrmE5qonljUremFsqc01SB46JvROS7bZs3IO2EmfFsd15uHvIt+Y8vEf7N7fWAU",
        "crossorigin": "anonymous"
    },
    
    "icons":
    {
        "style":"text-align:center;line-height: 1.8em;color:yellow"
    },
    
    "menus": [
    {
        "label": "Git status",
        "cmd": "git status",
        "args" : []
        "icon": {
            "class":"fas fa-file-medical-alt"
        }
    },{
        "divider":true
    },{
        ...
    }]
}

Name	Type	Description
gulp	boolean	false if you don't need gulp tasks to be launched.
npm	boolean	false if you don't need scripts to be launched.
colors	array	CSS colours values for background and fareground colors of the brackets terminal.
link	hashes	Add some <link> attributes for a css file. ex: fontawesome.
icons	hashes	Some global attributes for the toolbar icons.
menus	array	The menu items of your system commands.

Menus items

An item can be a divider or a menu item :

Divider

Name	Type	Description
divider	boolean	This is a divider. To separates some menu items.

Item

Name	Type	Description
label	string	Label that show in menus.
cmd	string	Command to execute. Use $0, $1, ... $n to specify custom arguments, that will be prompted for user.
args	array	The default arguments, in case user supply nothing.
splitChar	char	Specify the char that will separate arguments of command. Default value is ':'.
opts	hashes	Optional attributes that configure some options of execution environment.

Opts

Name	Type	Description
defaultPath	string	Directory path where command will executed. Default is directory of a selected file, directory of the project otherwise.
hiddenConsole	boolean	True indicates to not open the output panel during command execution.
killCmd	boolean	Command that will be triggered by 'Kill Commands' menu option.

Internal parameters

This internal parameters can be used in the cmd, in the args or in the opts.defautPath.

• $selectedFile

  The selected file's name.

• $dirOfSelectedFile

  The directory of the selected file.

• $projectDir

  The project directory.

• $projectName

  Tne project name.

Inspired by

brackets-nodejs

brackets-command-runner

License

MIT © guitarneck