1.0.0 • Published 6 years ago

brackets-launcher v1.0.0

Weekly downloads
-
License
MIT
Repository
-
Last release
6 years ago

dependencies dev dependencies

brackets-launcher

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

Table of Contents

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
    },{
        ...
    }]
}
NameTypeDescription
gulpbooleanfalse if you don't need gulp tasks to be launched.
npmbooleanfalse if you don't need scripts to be launched.
colorsarrayCSS colours values for background and fareground colors of the brackets terminal.
linkhashesAdd some <link> attributes for a css file. ex: fontawesome.
iconshashesSome global attributes for the toolbar icons.
menusarrayThe menu items of your system commands.

Menus items

An item can be a divider or a menu item :

Divider

NameTypeDescription
dividerbooleanThis is a divider. To separates some menu items.

Item

NameTypeDescription
labelstringLabel that show in menus.
cmd stringCommand to execute. Use $0, $1, ... $n to specify custom arguments, that will be prompted for user.
argsarrayThe default arguments, in case user supply nothing.
splitCharcharSpecify the char that will separate arguments of command. Default value is ':'.
 optshashesOptional attributes that configure some options of execution environment.

Opts

NameTypeDescription
 defaultPathstringDirectory path where command will executed. Default is directory of a selected file, directory of the project otherwise.
 hiddenConsolebooleanTrue indicates to not open the output panel during command execution.
 killCmdbooleanCommand 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