Discontinued! see id-builder

A gulp based project structure and compilation automation.

Installation

Install the required dependencies to run id-project with NPM.

$ npm install --save-dev id-project gulp coffee-script

Usage

Running id-project should work with very little configuration. Right now the policy is to enable all options by default.

1. Put a file named gulpfile.coffee in your project directory containing:

   require "id-project"

2. Run the gulpfile from the commandline:

   $ gulp

Default options

sourceDirectoryPath = "src"
targetDirectoryPath = "build"

(require "id-project")
    browserify:
        enabled:             true
        entryFilePath:       "#{targetDirectoryPath}/client/js/app/app.js"
        targetFilename:      "app.bundle.js"
        targetDirectoryPath: "#{targetDirectoryPath}/client/js/app"

    clean:
        enabled:             true
        targetDirectoryPath: targetDirectoryPath

    coffee:
        enabled:             true
        sourceDirectoryPath: sourceDirectoryPath
        targetDirectoryPath: targetDirectoryPath

    copy:
        enabled:             true
        excluded:            [ "!**/*.coffee", "!**/*.less" ]
        sourceDirectoryPath: sourceDirectoryPath
        targetDirectoryPath: targetDirectoryPath

    documentation:
        enabled:             true
        sourceDirectoryPath: sourceDirectoryPath
        targetDirectoryPath: targetDirectoryPath

    less:
        enabled:             true
        entryFilePath:       "#{sourceDirectoryPath}/client/less/app.less"
        targetDirectoryPath: "#{targetDirectoryPath}/client/css"

    livereload:
        enabled:             true

    nodemon:
        enabled:             true
        entryFilePath:       "app.js"
        watchGlob:           [ "#{targetDirectoryPath}/server/**/*.js" ]

    tests:
        enabled:             true
        directoryPath:       "test"

    watch:
        enabled:             true
        sourceDirectoryPath: sourceDirectoryPath
        testDirectoryPath:   testDirectoryPath

Features

Clean

Cleans the build directory.

CoffeeScript

Compiles CoffeeScript files to JavaScript files and places them in the build directory.

Less

Compiles Less files starting from an entry file to one Cascading Style Sheet file and places it in the build directory.

Copy

Copies any file that is not a CoffeeScript file or Less file and places it in the build directory.

Documentation

Generates API documentation for all CoffeeScript files in the source directory. Uses the Codo system.

Browserify

Compiles the outputted JavaScript files from the CoffeeScript task and Jade files copied over with the Copy task to one javascript file called the bundle.

Nodemon

Starts a server in development mode and keeps watch over server files. When an outputted JavaScript file from the CoffeeScfipt task in the build directory changes, it restarts the server.

Tests

Runs assertion tests with the Mocha test runner.

Watch

When any file in the source directory changes, this task sends a message to the corresponding tasks, triggering another compile/copy/etc of the subject files.

Livereload

Starts a LiveReload server. When a file changes that affects the browser, sends a message to the livereload server, reloading the browser.