leadconduit-cakefile
v0.3.8
Published
A Node.JS utility module for building LeadConduit integrations
Downloads
11
Maintainers
Keywords
Readme
Common LeadConduit Integration Cakefile
A Node.JS utility module for building LeadConduit integrations.
This module provides the standard build utilities for integration modules. To use it:
- require in your module's
package.json
:npm install leadconduit-cakefile --save-dev
- due to npm-install bootstrapping issues, your module must include
coffee-script
indevDependencies
(other build-related modules, e.g.,mocha
,coffeelint
, are provided here and not needed indevDependencies
). - create a file called
Cakefile
in the root of the module, with this single line:
require('leadconduit-cakefile')(task)
Cake Tasks
The tasks provided for the cake
command (run cake
to see the list, as well):
build
- delete and rebuild the package'slib
directory from all.coffee
source files insrc
lint
- runcoffeelint
on.coffee
source files insrc
test
- run the mocha unit tests defined in*-spec.coffee
spec files inspec
- Optionally, use
-p
or--prefix
to specify a prefix for the test files to run. This can be a string which prefixes the files to target (e.g., "inbound" would match justinbound*-spec.coffee
), or with a trailing slash, a directory name (e.g., "outbound/" would match all the*-spec.coffee
files inspec/outbound
).
- Optionally, use
If the module that includes this one needs to override one of the included tasks, it can do so by defining that task after the require
listed above:
task 'test', ->
console.log 'Tests? We ain\'t got no tests. We don\'t need no tests. I don\'t have to show you any stinking tests.'