Skip to content

Project JSON Reference

wagenet edited this page Sep 15, 2011 · 5 revisions

Sample project JSON

{
  "name": "test",
  "bpm": "1.0.0",
  "bpm:build": {
    "bpm_libs.js": {
      "files": [
        "lib"
      ],
      "minifier": "uglify-js"
    },
    "bpm_styles.css": {
      "files": [
        "css"
      ]
    }
  }
}

Fields

name

Name of your project.

bpm

BPM Version

main

Relative path to main JS file. (Used by Spade) Defaults to lib/main.js

directories

Directory mappings for your project. Keys are 'lib', 'css', 'tests'. Values are relative path to the directory. 'lib' may be an array.

pipeline

Undocumented

bpm:build

Information on what files BPM should generate. Consists of a hash where key is the file name and the value is another hash. The value hash at minimum, must contain a files array listing all files that will be compiled to create the file. You can also specify a minifier option if you would like to minify the output.

"bpm_libs.js": {
  "files": [
    "lib"
  ],
  "minifier": "uglify-js"
}

bpm:use:transport

Specify a specific transport to be used by the package.

dependencies

Hash of dependencies. Key is dependency name, value is version matcher. Updated automatically by bpm add/bpm remove.

dependencies:development

Same as above except dependencies for development only.

Clone this wiki locally