nmake

A tool for generating a universal makefile for Node.js projects.

npm install nmake
2 downloads in the last week
4 downloads in the last month

nmake Build Status

A tool for generating a universal makefile for Node.js projects.

Installation

$ npm install -g nmake

Usage

$ nmake [options]

Options:

  -h, --help     output usage information
  -V, --version  output the version number

To generate or update a makefile, just run the following command inside your project's root directory:

$ nmake

Using a makefile

To display the usage information of a makefile, run make without arguments:

$ make

The runtime behavior of a makefile is controlled by properties defined in the package.json file of your project.

To list all properties and property values, run make with the 'selftest' target:

$ make selftest

A minimal package.json file:

{
    "name": "mynewproject",
    "version": "0.1.0",
    "nmake": {
        "publish": {
            "username": "clebert"
        }
    }
}

A more extensive package.json file:

{
    "name": "mynewproject",
    "version": "0.1.0",
    "nmake": {
        "install": {
            "loglevel": "http"
        },
        "lint": {
            "args": "--verbose . bin/mynewproject"
        },
        "subtrees": [
            {
                "prefix": "vendor/jscheck",
                "repository": "git@github.com:douglascrockford/JSCheck.git",
                "refspec": "master"
            },
            {
                "prefix": "vendor/jslint",
                "repository": "git@github.com:douglascrockford/JSLint.git",
                "refspec": "master"
            }
        ],
        "test": {
            "reporter": "dot",
            "ui": "bdd"
        },
        "publish": {
            "username": "clebert"
        }
    }
}

Running tests

$ make test

Linting sources

$ make lint

License

The MIT License (MIT)

Copyright (c) 2013 Clemens Akens (http://clebert.com/)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you