Skip to content
Benjamin Lupton edited this page Mar 19, 2016 · 1 revision

Nakefiles are a standalone node file called nakefile.js that doesn't have any other external dependencies while providing tooling for installing, compiling, testing, and releasing your project. Consider them like a cross-platform Makefile built with Node.js.

npm scripts

{
	"scripts": {
		"clean": "node --harmony nakefile.js clean",
		"setup": "node --harmony nakefile.js setup",
		"compile": "node --harmony nakefile.js compile",
		"watch": "node --harmony nakefile.js watch",
		"verify": "node --harmony nakefile.js verify",
		"meta": "node --harmony nakefile.js meta",
		"prepare": "node --harmony nakefile.js prepare",
		"release": "node --harmony nakefile.js release"
	}
}

configuration

The following Nakefile configuration properties are listed below with their default values. You can customize them via the nakeConfiguration property inside your package.json file.

{
	"nakeConfiguration": {
		"TEST_PATH": "test",
		"DOCCO_SRC_PATH": null,
		"DOCCO_OUT_PATH": "docs",
		"BISCOTTO_SRC_PATH": null,
		"BISCOTTO_OUT_PATH": "docs",
		"YUIDOC_SRC_PATH": null,
		"YUIDOC_OUT_PATH": "docs",
		"YUIDOC_SYNTAX": "js",
		"COFFEE_SRC_PATH": null,
		"COFFEE_OUT_PATH": "out",
		"DOCPAD_SRC_PATH": null,
		"DOCPAD_OUT_PATH": "out",
		"BABEL_SRC_PATH": null,
		"BABEL_OUT_PATH": "es5",
		"ESLINT_SRC_PATH": null,
		"COFFEELINT_SRC_PATH": null
	}
}

showcase

Clone this wiki locally