buildproject

Tools to build a project from almost any source to an output structure

npm install buildproject
14 downloads in the last week
28 downloads in the last month

buildproject.js

Series of tools to build source content into a web app.

Installation

Install using npm: npm install buildproject or check out the latest version from Git.

Usage

Once installed, run using the binary: buildproject optional commands can be used to add features. The most useful are:

-profile profilename used to run a specific profile, by default will run the profile called "full" or when that isn't found, runs the first profile found.

-config fullpath used to set the path to the configuration JSON file, either to the JSON file itself or to the container directory so long as the file is called buildproject.json

Additional configuration can be either set in the command line or in the JSON file as part of a profile / settings:

-sourcePath fullpath sets the path of the source files, will be prepended to all source content paths in the configuration JSON. If omitted the default is the 'src' directory at the same level as the buildproject.json file

-targetPath fullpath sets the path of the output files, will be prepended to all output content paths in the configuration JSON. If omitted the default is the 'web' directory at the same level as the buildproject.json file

--verbose prints a lot of information to the console as the build is running

buildproject.json

Detailed configuration for the build can be supplied in a JSON file (usually called buildproject.json) that should have the following properties:

profiles required A map of string arrays, the names in the map are the names of the profiles. Use these to split out types of task, for example the debug versus production profile.

src optional The full path to the source directory - this is prepended to the path in all source tasks. When omitted (or empty) this will default to a directory named 'src' at the same level as the JSON file.

target optional The full path to the output directory - this is prepended to the path in all output tasks. When omitted (or empty) this will default to a directory named 'web' at the same level as the JSON file.

npm loves you