Atom Build package

Automatically build your project inside your new favorite editor, Atom.

alt-cmd-b builds your project (Mac OS X)
ctrl-alt-b builds your project (Linux/Windows)
escape terminates build

Supported build tools:

Custom by specifying your own build command
NodeJS (runs npm install) - if package.json exists where engines['node'] is set
Atom (runs apm install) - if package.json exists where engines['atom'] is set
Grunt - if Gruntfile.js exists
Gulp - if gulpfile.js exists
Elixir - if mix.exs exists
GNU Make - if Makefile exists

If multiple viable build options are found, atom-build will prioritise according to the list above. For instance, if package.json and Gruntfile.js are both available in the root folder, npm install will be executed by atom-build.

If you need to run grunt to build you project, utilize the postinstall-script of package.json. This will also help you if grunt is run as a node module since it will be downloaded (via npm install) prior.

Specifying your own build command

If the built-in defaults are not enough to suit your needs, you can specify exactly what to execute. Create a file named .atom-build.json in your project root:

{
  "cmd": "<command to execute>",
  "args": [ "<argument1>", "<argument2>", ... ],
  "sh": true,
  "cwd": "<current working directory for `cmd`>",
  "env": {
    "VARIABLE1": "VALUE1",
    "VARIABLE2": "VALUE2",
    ...
  }
}

Note that if sh is false cmd must only be the executable - no arguments here. If the executable is not in your path, either fully qualify it or specify the path in you environment (e.g. by setting the PATH var appropriately on UNIX-like systems).

Configuration options

cmd: The executable command
args: An array of arguments for the command
sh: If true, the combined command and arguments will be passed to /bin/sh. Default true.
cwd: The working directory for the command. E.g. what . resolves to.
env: An array of environment variables and their values to set

Replacements

The following parameters will be replaced in cmd, any entry in args, cwd and values of env. They should all be enclosed in curly brackets {}

{FILE_ACTIVE} - Full path to the currently active file in Atom. E.g. /home/noseglid/github/atom-build/lib/build.coffee
{FILE_ACTIVE_PATH} - Full path to the folder where the currently active file is. E.g. /home/noseglid/github/atom-build/lib
{FILE_ACTIVE_NAME} - Full name and extension of active file. E.g., build.coffee
{FILE_ACTIVE_NAME_BASE} - Name of active file WITHOUT extension. E.g., build
{PROJECT_PATH} - Full path to the root of the project. This is normally the path Atom has as root. E.g /home/noseglid/github/atom-build
{REPO_BRANCH_SHORT} - Short name of the current active branch (if project is backed by git). E.g master or v0.9.1.

austinbirch/atom-build

Atom Build package

Specifying your own build command

Configuration options

Replacements