Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Docs for PackageTask.

  • Loading branch information...
commit 829fc869c00220988a7fe8fa35bc26c9c3e335e0 1 parent 0b742ca
mde authored
View
27 doc/files.html
@@ -40,6 +40,14 @@ <h2 class="heading1">Classes</h2>
<li><a href="symbols/jake.html">jake</a></li>
+ <li><a href="symbols/jake.DirectoryTask.html">jake<span class='break'> </span>.<span class='break'> </span>DirectoryTask</a></li>
+
+ <li><a href="symbols/jake.FileTask.html">jake<span class='break'> </span>.<span class='break'> </span>FileTask</a></li>
+
+ <li><a href="symbols/jake.PackageTask.html">jake<span class='break'> </span>.<span class='break'> </span>PackageTask</a></li>
+
+ <li><a href="symbols/jake.Task.html">jake<span class='break'> </span>.<span class='break'> </span>Task</a></li>
+
</ul>
</nav>
</div>
@@ -47,7 +55,7 @@ <h2 class="heading1">Classes</h2>
Documentation generator: <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0<br />
Template: <a href="http://www.thebrightlines.com/2010/05/06/new-template-for-jsdoctoolkit-codeview/" target="_blank">Codeview</a> 1.2<br />
- Generated on: 2012-1-14 14:01
+ Generated on: 2012-2-6 12:12
</div>
</div>
@@ -240,7 +248,22 @@ <h2 class="filename"><a href="symbols/src/lib_task_task.js.html">./lib/task/task
</li>
<li>
- <h2 class="filename"><a href="symbols/src/lib_utils.js.html">./lib/utils.js</a></h2>
+ <h2 class="filename"><a href="symbols/src/lib_utils_file.js.html">./lib/utils/file.js</a></h2>
+
+
+
+ <dl class="detailList">
+
+
+
+
+
+
+ </dl>
+ </li>
+
+ <li>
+ <h2 class="filename"><a href="symbols/src/lib_utils_index.js.html">./lib/utils/index.js</a></h2>
View
30 doc/index.html
@@ -40,6 +40,14 @@ <h2 class="heading1">Classes</h2>
<li><a href="symbols/jake.html">jake</a></li>
+ <li><a href="symbols/jake.DirectoryTask.html">jake<span class='break'> </span>.<span class='break'> </span>DirectoryTask</a></li>
+
+ <li><a href="symbols/jake.FileTask.html">jake<span class='break'> </span>.<span class='break'> </span>FileTask</a></li>
+
+ <li><a href="symbols/jake.PackageTask.html">jake<span class='break'> </span>.<span class='break'> </span>PackageTask</a></li>
+
+ <li><a href="symbols/jake.Task.html">jake<span class='break'> </span>.<span class='break'> </span>Task</a></li>
+
</ul>
</nav>
</div>
@@ -47,7 +55,7 @@ <h2 class="heading1">Classes</h2>
Documentation generator: <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0<br />
Template: <a href="http://www.thebrightlines.com/2010/05/06/new-template-for-jsdoctoolkit-codeview/" target="_blank">Codeview</a> 1.2<br />
- Generated on: 2012-1-14 14:01
+ Generated on: 2012-2-6 12:12
</div>
</div>
@@ -69,6 +77,26 @@ <h2 class="classname"><a href="symbols/jake.html">jake</a></h2>
<p>jake</p>
</li>
+ <li>
+ <h2 class="classname"><a href="symbols/jake.DirectoryTask.html">jake.DirectoryTask</a></h2>
+ <p></p>
+ </li>
+
+ <li>
+ <h2 class="classname"><a href="symbols/jake.FileTask.html">jake.FileTask</a></h2>
+ <p></p>
+ </li>
+
+ <li>
+ <h2 class="classname"><a href="symbols/jake.PackageTask.html">jake.PackageTask</a></h2>
+ <p></p>
+ </li>
+
+ <li>
+ <h2 class="classname"><a href="symbols/jake.Task.html">jake.Task</a></h2>
+ <p></p>
+ </li>
+
</ul>
</div>
</div>
View
12 doc/symbols/_global_.html
@@ -40,6 +40,14 @@ <h2 class="heading1">Classes</h2>
<li><a href="../symbols/jake.html">jake</a></li>
+ <li><a href="../symbols/jake.DirectoryTask.html">jake<span class='break'> </span>.<span class='break'> </span>DirectoryTask</a></li>
+
+ <li><a href="../symbols/jake.FileTask.html">jake<span class='break'> </span>.<span class='break'> </span>FileTask</a></li>
+
+ <li><a href="../symbols/jake.PackageTask.html">jake<span class='break'> </span>.<span class='break'> </span>PackageTask</a></li>
+
+ <li><a href="../symbols/jake.Task.html">jake<span class='break'> </span>.<span class='break'> </span>Task</a></li>
+
</ul>
</nav>
</div>
@@ -47,7 +55,7 @@ <h2 class="heading1">Classes</h2>
Documentation generator: <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0<br />
Template: <a href="http://www.thebrightlines.com/2010/05/06/new-template-for-jsdoctoolkit-codeview/" target="_blank">Codeview</a> 1.2<br />
- Generated on: 2012-1-14 14:01
+ Generated on: 2012-2-6 12:12
</div>
</div>
@@ -623,7 +631,7 @@ <h2 class="sectionTitle">
<dd></dd>
<dt>
- <span class="light fixedFont">{Array}</span> <b>opts.asyc</b>
+ <span class="light fixedFont">{Boolean}</span> <b>opts.asyc</b>
<i>Optional, Default: false</i>
</dt>
<dd>Perform this task asynchronously.
View
207 doc/symbols/jake.DirectoryTask.html
@@ -0,0 +1,207 @@
+
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="utf8"></meta>
+ <meta name="generator" content="JsDoc Toolkit"></meta>
+ <title>jake.DirectoryTask | JsDoc Reference</title>
+
+ <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0;"></meta>
+ <meta name="mobileoptimized" content="0"></meta>
+
+ <link rel="stylesheet" href="../css/all.css" media="all"></link>
+ <link rel="stylesheet" href="../css/handheld.css" media="only screen and (max-width: 660px)"></link>
+ <link rel="stylesheet" href="../css/handheld.css" media="handheld"></link>
+ <link rel="stylesheet" href="../css/screen.css" media="screen and (min-width: 661px)"></link>
+
+ <script src="../javascript/all.js"></script>
+ <!--[if lt IE 9]>
+ <script src="../javascript/html5.js"></script>
+ <![endif]-->
+ </head>
+
+ <body>
+
+<div class="index">
+ <div class="menu">
+ <div class="indexLinks">
+ <a href="../index.html">Classes</a>
+ <a href="../files.html">Files</a>
+ </div>
+
+ <h2 class="heading1">Classes</h2>
+
+ <input type="text" name="classFilter" class="classFilter" id="ClassFilter" placeholder="Filter"></input>
+
+ <nav>
+ <ul class="classList" id="ClassList">
+
+ <li><a href="../symbols/_global_.html">_global_</a></li>
+
+ <li><a href="../symbols/jake.html">jake</a></li>
+
+ <li><a href="../symbols/jake.DirectoryTask.html">jake<span class='break'> </span>.<span class='break'> </span>DirectoryTask</a></li>
+
+ <li><a href="../symbols/jake.FileTask.html">jake<span class='break'> </span>.<span class='break'> </span>FileTask</a></li>
+
+ <li><a href="../symbols/jake.PackageTask.html">jake<span class='break'> </span>.<span class='break'> </span>PackageTask</a></li>
+
+ <li><a href="../symbols/jake.Task.html">jake<span class='break'> </span>.<span class='break'> </span>Task</a></li>
+
+ </ul>
+ </nav>
+ </div>
+ <div class="fineprint" style="clear:both">
+
+ Documentation generator: <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0<br />
+ Template: <a href="http://www.thebrightlines.com/2010/05/06/new-template-for-jsdoctoolkit-codeview/" target="_blank">Codeview</a> 1.2<br />
+ Generated on: 2012-2-6 12:12
+ </div>
+</div>
+
+<div class="index indexStatic"></div>
+
+<div class="content">
+ <div class="innerContent">
+ <h1 class="classTitle">
+
+ Class <span>jake.DirectoryTask</span>
+ </h1>
+
+ <div class="intro">
+ <p class="description summary">
+
+ </p>
+
+
+ <ul class="summary">
+
+
+
+ <li>Defined in: <a href="../symbols/src/lib_task_directory_task.js.html">directory_task.js</a></li>
+
+ <li>Extends <span class="fixedFont">
+ EventEmitter, <a href="../symbols/jake.FileTask.html">jake.FileTask</a>, <a href="../symbols/jake.Task.html">jake.Task</a></span></li>
+
+ </ul>
+
+ </div>
+
+
+ <div class="props">
+ <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class jake.DirectoryTask.">
+ <caption class="sectionTitle">Class Summary</caption>
+ <thead>
+ <tr>
+ <th scope="col">Constructor Attributes</th>
+ <th scope="col">Constructor Name and Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription" >
+ <div class="fixedFont">
+ <b><a href="../symbols/jake.DirectoryTask.html#constructor">jake.DirectoryTask</a></b>(name)
+ </div>
+ <div class="description">A Jake DirectoryTask</div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+
+
+
+<!--
+#### METHODS SUMMARY
+-->
+
+
+
+ <div class="props">
+ <h2 class="sectionTitle">Method Summary</h2>
+
+
+
+
+ <dl class="inheritsList" id="MethodsListInherited">
+ <dt>Methods borrowed from class <span class='fixedFont'><a href="../symbols/jake.Task.html">jake.Task</a></span>: </dt><dd><span class='fixedFont'><a href="../symbols/jake.Task.html#invoke">invoke</a></span></dd> <dd><span class='fixedFont'><a href="../symbols/jake.Task.html#reenable">reenable</a></span></dd>
+ </dl>
+
+ </div>
+
+
+<!--
+#### EVENTS SUMMARY
+-->
+
+
+
+
+
+ <dl class="inheritsList">
+ <dt>Events borrowed from class <a href="../symbols/jake.Task.html">jake.Task</a>: </dt><dd><a href="../symbols/jake.Task.html#event:complete">complete</a></dd>
+ </dl>
+
+
+<!--
+#### CONSTRUCTOR DETAILS
+-->
+
+ <div class="details props">
+ <div class="innerProps">
+ <h2 class="sectionTitle" id="constructor">
+ Class Detail
+ </h2>
+
+ <div class="fixedFont">
+ <b>jake.DirectoryTask</b>(name)
+ </div>
+
+ <div class="description">
+ A Jake DirectoryTask
+
+ </div>
+
+
+
+
+ <dl class="detailList params">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="light fixedFont">{String}</span> <b>name</b>
+
+ </dt>
+ <dd>The name of the directory to create.</dd>
+
+ </dl>
+
+
+
+ </div>
+ </div>
+
+<!--
+#### FIELD DETAILS
+-->
+
+<!--
+#### METHOD DETAILS
+-->
+
+
+<!--
+#### EVENT DETAILS
+-->
+
+ </div>
+</div>
+ <script type="text/javascript">
+ wbos.CssTools.MediaQueryFallBack.LoadCss('../css/screen.css', '../css/handheld.css', 660)
+ codeview.classFilter.Init()
+ </script>
+ </body>
+</html>
+
View
234 doc/symbols/jake.FileTask.html
@@ -0,0 +1,234 @@
+
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="utf8"></meta>
+ <meta name="generator" content="JsDoc Toolkit"></meta>
+ <title>jake.FileTask | JsDoc Reference</title>
+
+ <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0;"></meta>
+ <meta name="mobileoptimized" content="0"></meta>
+
+ <link rel="stylesheet" href="../css/all.css" media="all"></link>
+ <link rel="stylesheet" href="../css/handheld.css" media="only screen and (max-width: 660px)"></link>
+ <link rel="stylesheet" href="../css/handheld.css" media="handheld"></link>
+ <link rel="stylesheet" href="../css/screen.css" media="screen and (min-width: 661px)"></link>
+
+ <script src="../javascript/all.js"></script>
+ <!--[if lt IE 9]>
+ <script src="../javascript/html5.js"></script>
+ <![endif]-->
+ </head>
+
+ <body>
+
+<div class="index">
+ <div class="menu">
+ <div class="indexLinks">
+ <a href="../index.html">Classes</a>
+ <a href="../files.html">Files</a>
+ </div>
+
+ <h2 class="heading1">Classes</h2>
+
+ <input type="text" name="classFilter" class="classFilter" id="ClassFilter" placeholder="Filter"></input>
+
+ <nav>
+ <ul class="classList" id="ClassList">
+
+ <li><a href="../symbols/_global_.html">_global_</a></li>
+
+ <li><a href="../symbols/jake.html">jake</a></li>
+
+ <li><a href="../symbols/jake.DirectoryTask.html">jake<span class='break'> </span>.<span class='break'> </span>DirectoryTask</a></li>
+
+ <li><a href="../symbols/jake.FileTask.html">jake<span class='break'> </span>.<span class='break'> </span>FileTask</a></li>
+
+ <li><a href="../symbols/jake.PackageTask.html">jake<span class='break'> </span>.<span class='break'> </span>PackageTask</a></li>
+
+ <li><a href="../symbols/jake.Task.html">jake<span class='break'> </span>.<span class='break'> </span>Task</a></li>
+
+ </ul>
+ </nav>
+ </div>
+ <div class="fineprint" style="clear:both">
+
+ Documentation generator: <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0<br />
+ Template: <a href="http://www.thebrightlines.com/2010/05/06/new-template-for-jsdoctoolkit-codeview/" target="_blank">Codeview</a> 1.2<br />
+ Generated on: 2012-2-6 12:12
+ </div>
+</div>
+
+<div class="index indexStatic"></div>
+
+<div class="content">
+ <div class="innerContent">
+ <h1 class="classTitle">
+
+ Class <span>jake.FileTask</span>
+ </h1>
+
+ <div class="intro">
+ <p class="description summary">
+
+ </p>
+
+
+ <ul class="summary">
+
+
+
+ <li>Defined in: <a href="../symbols/src/lib_task_file_task.js.html">file_task.js</a></li>
+
+ <li>Extends <span class="fixedFont">
+ EventEmitter, <a href="../symbols/jake.Task.html">jake.Task</a></span></li>
+
+ </ul>
+
+ </div>
+
+
+ <div class="props">
+ <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class jake.FileTask.">
+ <caption class="sectionTitle">Class Summary</caption>
+ <thead>
+ <tr>
+ <th scope="col">Constructor Attributes</th>
+ <th scope="col">Constructor Name and Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription" >
+ <div class="fixedFont">
+ <b><a href="../symbols/jake.FileTask.html#constructor">jake.FileTask</a></b>(name, [prereqs], [action], [opts])
+ </div>
+ <div class="description">A Jake FileTask</div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+
+
+
+<!--
+#### METHODS SUMMARY
+-->
+
+
+
+ <div class="props">
+ <h2 class="sectionTitle">Method Summary</h2>
+
+
+
+
+ <dl class="inheritsList" id="MethodsListInherited">
+ <dt>Methods borrowed from class <span class='fixedFont'><a href="../symbols/jake.Task.html">jake.Task</a></span>: </dt><dd><span class='fixedFont'><a href="../symbols/jake.Task.html#invoke">invoke</a></span></dd> <dd><span class='fixedFont'><a href="../symbols/jake.Task.html#reenable">reenable</a></span></dd>
+ </dl>
+
+ </div>
+
+
+<!--
+#### EVENTS SUMMARY
+-->
+
+
+
+
+
+ <dl class="inheritsList">
+ <dt>Events borrowed from class <a href="../symbols/jake.Task.html">jake.Task</a>: </dt><dd><a href="../symbols/jake.Task.html#event:complete">complete</a></dd>
+ </dl>
+
+
+<!--
+#### CONSTRUCTOR DETAILS
+-->
+
+ <div class="details props">
+ <div class="innerProps">
+ <h2 class="sectionTitle" id="constructor">
+ Class Detail
+ </h2>
+
+ <div class="fixedFont">
+ <b>jake.FileTask</b>(name, [prereqs], [action], [opts])
+ </div>
+
+ <div class="description">
+ A Jake FileTask
+
+ </div>
+
+
+
+
+ <dl class="detailList params">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="light fixedFont">{String}</span> <b>name</b>
+
+ </dt>
+ <dd>The name of the Task</dd>
+
+ <dt>
+ <span class="light fixedFont">{Array}</span> <b>prereqs</b>
+ <i>Optional</i>
+ </dt>
+ <dd>Prerequisites to be run before this task</dd>
+
+ <dt>
+ <span class="light fixedFont">{Function}</span> <b>action</b>
+ <i>Optional</i>
+ </dt>
+ <dd>The action to perform to create this file</dd>
+
+ <dt>
+ <span class="light fixedFont">{Object}</span> <b>opts</b>
+ <i>Optional</i>
+ </dt>
+ <dd></dd>
+
+ <dt>
+ <span class="light fixedFont">{Array}</span> <b>opts.asyc</b>
+ <i>Optional, Default: false</i>
+ </dt>
+ <dd>Perform this task asynchronously.
+ If you flag a task with this option, you must call the global
+ `complete` method inside the task's action, for execution to proceed
+ to the next task.</dd>
+
+ </dl>
+
+
+
+ </div>
+ </div>
+
+<!--
+#### FIELD DETAILS
+-->
+
+<!--
+#### METHOD DETAILS
+-->
+
+
+<!--
+#### EVENT DETAILS
+-->
+
+ </div>
+</div>
+ <script type="text/javascript">
+ wbos.CssTools.MediaQueryFallBack.LoadCss('../css/screen.css', '../css/handheld.css', 660)
+ codeview.classFilter.Init()
+ </script>
+ </body>
+</html>
+
View
686 doc/symbols/jake.PackageTask.html
@@ -0,0 +1,686 @@
+
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="utf8"></meta>
+ <meta name="generator" content="JsDoc Toolkit"></meta>
+ <title>jake.PackageTask | JsDoc Reference</title>
+
+ <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0;"></meta>
+ <meta name="mobileoptimized" content="0"></meta>
+
+ <link rel="stylesheet" href="../css/all.css" media="all"></link>
+ <link rel="stylesheet" href="../css/handheld.css" media="only screen and (max-width: 660px)"></link>
+ <link rel="stylesheet" href="../css/handheld.css" media="handheld"></link>
+ <link rel="stylesheet" href="../css/screen.css" media="screen and (min-width: 661px)"></link>
+
+ <script src="../javascript/all.js"></script>
+ <!--[if lt IE 9]>
+ <script src="../javascript/html5.js"></script>
+ <![endif]-->
+ </head>
+
+ <body>
+
+<div class="index">
+ <div class="menu">
+ <div class="indexLinks">
+ <a href="../index.html">Classes</a>
+ <a href="../files.html">Files</a>
+ </div>
+
+ <h2 class="heading1">Classes</h2>
+
+ <input type="text" name="classFilter" class="classFilter" id="ClassFilter" placeholder="Filter"></input>
+
+ <nav>
+ <ul class="classList" id="ClassList">
+
+ <li><a href="../symbols/_global_.html">_global_</a></li>
+
+ <li><a href="../symbols/jake.html">jake</a></li>
+
+ <li><a href="../symbols/jake.DirectoryTask.html">jake<span class='break'> </span>.<span class='break'> </span>DirectoryTask</a></li>
+
+ <li><a href="../symbols/jake.FileTask.html">jake<span class='break'> </span>.<span class='break'> </span>FileTask</a></li>
+
+ <li><a href="../symbols/jake.PackageTask.html">jake<span class='break'> </span>.<span class='break'> </span>PackageTask</a></li>
+
+ <li><a href="../symbols/jake.Task.html">jake<span class='break'> </span>.<span class='break'> </span>Task</a></li>
+
+ </ul>
+ </nav>
+ </div>
+ <div class="fineprint" style="clear:both">
+
+ Documentation generator: <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0<br />
+ Template: <a href="http://www.thebrightlines.com/2010/05/06/new-template-for-jsdoctoolkit-codeview/" target="_blank">Codeview</a> 1.2<br />
+ Generated on: 2012-2-6 12:12
+ </div>
+</div>
+
+<div class="index indexStatic"></div>
+
+<div class="content">
+ <div class="innerContent">
+ <h1 class="classTitle">
+
+ Class <span>jake.PackageTask</span>
+ </h1>
+
+ <div class="intro">
+ <p class="description summary">
+
+ </p>
+
+
+ <ul class="summary">
+
+
+
+ <li>Defined in: <a href="../symbols/src/lib_package_task.js.html">package_task.js</a></li>
+
+
+ </ul>
+
+ </div>
+
+
+ <div class="props">
+ <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class jake.PackageTask.">
+ <caption class="sectionTitle">Class Summary</caption>
+ <thead>
+ <tr>
+ <th scope="col">Constructor Attributes</th>
+ <th scope="col">Constructor Name and Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription" >
+ <div class="fixedFont">
+ <b><a href="../symbols/jake.PackageTask.html#constructor">jake.PackageTask</a></b>(name, version, definition)
+ </div>
+ <div class="description">Instantiating a PackageTask creates a number of Jake
+ Tasks that make packaging and distributing your software easy.</div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+
+
+
+
+
+ <div class="props">
+ <table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class jake.PackageTask.">
+ <caption class="sectionTitle">Field Summary</caption>
+
+ <thead>
+ <tr>
+ <th scope="col">Field Attributes</th>
+ <th scope="col">Field Name and Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont">
+ <b><a href="../symbols/jake.PackageTask.html#archiveChangeDir">archiveChangeDir</a></b>
+ </div>
+ <div class="description">Equivalent to the '-C' command for the `tar` and `jar`
+ commands.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont">
+ <b><a href="../symbols/jake.PackageTask.html#archiveContentDir">archiveContentDir</a></b>
+ </div>
+ <div class="description">Specifies the files and directories to include in the
+ package-archive.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont">
+ <b><a href="../symbols/jake.PackageTask.html#jarCommand">jarCommand</a></b>
+ </div>
+ <div class="description">The shell-command to use for creating jar archives.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont">
+ <b><a href="../symbols/jake.PackageTask.html#manifestFile">manifestFile</a></b>
+ </div>
+ <div class="description">Can be set to point the `jar` utility at a manifest
+ file to use in a .jar archive.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont">
+ <b><a href="../symbols/jake.PackageTask.html#name">name</a></b>
+ </div>
+ <div class="description">The name of the project</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont">
+ <b><a href="../symbols/jake.PackageTask.html#needJar">needJar</a></b>
+ </div>
+ <div class="description">If set to true, uses the `jar` utility to create
+ a .jar archive of the pagckage</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont">
+ <b><a href="../symbols/jake.PackageTask.html#needTar">needTar</a></b>
+ </div>
+ <div class="description">If set to true, uses the `tar` utility to create
+ a gzip .tgz archive of the pagckage</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont">
+ <b><a href="../symbols/jake.PackageTask.html#needTarBz2">needTarBz2</a></b>
+ </div>
+ <div class="description">If set to true, uses the `tar` utility to create
+ a bzip2 .bz2 archive of the pagckage</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont">
+ <b><a href="../symbols/jake.PackageTask.html#needZip">needZip</a></b>
+ </div>
+ <div class="description">If set to true, uses the `zip` utility to create
+ a .zip archive of the pagckage</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont">
+ <b><a href="../symbols/jake.PackageTask.html#packageFiles">packageFiles</a></b>
+ </div>
+ <div class="description">The list of files and directories to include in the
+ package-archive</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont">
+ <b><a href="../symbols/jake.PackageTask.html#tarCommand">tarCommand</a></b>
+ </div>
+ <div class="description">The shell-command to use for creating tar archives.</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont">
+ <b><a href="../symbols/jake.PackageTask.html#version">version</a></b>
+ </div>
+ <div class="description">The project version-string</div>
+ </td>
+ </tr>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont">
+ <b><a href="../symbols/jake.PackageTask.html#zipCommand">zipCommand</a></b>
+ </div>
+ <div class="description">The shell-command to use for creating zip archives.</div>
+ </td>
+ </tr>
+
+ </tbody>
+ </table>
+ </div>
+
+
+
+
+<!--
+#### METHODS SUMMARY
+-->
+
+
+<!--
+#### EVENTS SUMMARY
+-->
+
+<!--
+#### CONSTRUCTOR DETAILS
+-->
+
+ <div class="details props">
+ <div class="innerProps">
+ <h2 class="sectionTitle" id="constructor">
+ Class Detail
+ </h2>
+
+ <div class="fixedFont">
+ <b>jake.PackageTask</b>(name, version, definition)
+ </div>
+
+ <div class="description">
+ Instantiating a PackageTask creates a number of Jake
+ Tasks that make packaging and distributing your software easy.
+
+ </div>
+
+
+
+ <pre class="code"> var t = new jake.PackageTask('rous', 'v' + version, function () {
+ var files = [
+ 'Capfile'
+ , 'Jakefile'
+ , 'README.md'
+ , 'package.json'
+ , 'app/*'
+ , 'bin/*'
+ , 'config/*'
+ , 'lib/*'
+ , 'node_modules/*'
+ ];
+ this.packageFiles.include(files);
+ this.packageFiles.exclude('node_modules/foobar');
+ this.needTarGz = true;
+ });</pre>
+
+
+
+
+ <dl class="detailList params">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="light fixedFont">{String}</span> <b>name</b>
+
+ </dt>
+ <dd>The name of the project</dd>
+
+ <dt>
+ <span class="light fixedFont">{String}</span> <b>version</b>
+
+ </dt>
+ <dd>The current project version (will be
+ appended to the project-name in the package-archive</dd>
+
+ <dt>
+ <span class="light fixedFont">{Function}</span> <b>definition</b>
+
+ </dt>
+ <dd>Defines the contents of the package,
+ and format of the package-archive. Will be executed on the instantiated
+ PackageTask (i.e., 'this', will be the PackageTask instance),
+ to set the various instance-propertiess.</dd>
+
+ </dl>
+
+
+
+ </div>
+ </div>
+
+<!--
+#### FIELD DETAILS
+-->
+
+ <div class="details props">
+ <div class="innerProps">
+ <h2 class="sectionTitle">
+ Field Detail
+ </h2>
+
+
+ <div class="fixedFont heading" id="archiveChangeDir">
+ <span class='lighter'>
+
+ </span>
+
+
+
+ <b>archiveChangeDir</b>
+ </div>
+
+ <div class="description">
+ Equivalent to the '-C' command for the `tar` and `jar`
+ commands. ("Change to this directory before adding files.")
+
+
+
+ </div>
+
+
+
+
+ <div class="hr"></div>
+
+ <div class="fixedFont heading" id="archiveContentDir">
+ <span class='lighter'>
+
+ </span>
+
+
+
+ <b>archiveContentDir</b>
+ </div>
+
+ <div class="description">
+ Specifies the files and directories to include in the
+ package-archive. If unset, this will default to the main package
+ directory -- i.e., name + version.
+
+
+
+ </div>
+
+
+
+
+ <div class="hr"></div>
+
+ <div class="fixedFont heading" id="jarCommand">
+ <span class='lighter'>
+
+ </span>
+
+
+
+ <b>jarCommand</b>
+ </div>
+
+ <div class="description">
+ The shell-command to use for creating jar archives.
+
+
+
+ </div>
+
+
+
+
+ <div class="hr"></div>
+
+ <div class="fixedFont heading" id="manifestFile">
+ <span class='lighter'>
+
+ </span>
+
+
+
+ <b>manifestFile</b>
+ </div>
+
+ <div class="description">
+ Can be set to point the `jar` utility at a manifest
+ file to use in a .jar archive. If unset, one will be automatically
+ created by the `jar` utility. This path should be relative to the
+ root of the package directory (this.packageDir above, likely 'pkg')
+
+
+
+ </div>
+
+
+
+
+ <div class="hr"></div>
+
+ <div class="fixedFont heading" id="name">
+ <span class='lighter'>
+
+ </span>
+
+
+
+ <b>name</b>
+ </div>
+
+ <div class="description">
+ The name of the project
+
+
+
+ </div>
+
+
+
+
+ <div class="hr"></div>
+
+ <div class="fixedFont heading" id="needJar">
+ <span class='lighter'>
+
+ </span>
+
+
+
+ <b>needJar</b>
+ </div>
+
+ <div class="description">
+ If set to true, uses the `jar` utility to create
+ a .jar archive of the pagckage
+
+
+
+ </div>
+
+
+
+
+ <div class="hr"></div>
+
+ <div class="fixedFont heading" id="needTar">
+ <span class='lighter'>
+
+ </span>
+
+
+
+ <b>needTar</b>
+ </div>
+
+ <div class="description">
+ If set to true, uses the `tar` utility to create
+ a gzip .tgz archive of the pagckage
+
+
+
+ </div>
+
+
+
+
+ <div class="hr"></div>
+
+ <div class="fixedFont heading" id="needTarBz2">
+ <span class='lighter'>
+
+ </span>
+
+
+
+ <b>needTarBz2</b>
+ </div>
+
+ <div class="description">
+ If set to true, uses the `tar` utility to create
+ a bzip2 .bz2 archive of the pagckage
+
+
+
+ </div>
+
+
+
+
+ <div class="hr"></div>
+
+ <div class="fixedFont heading" id="needZip">
+ <span class='lighter'>
+
+ </span>
+
+
+
+ <b>needZip</b>
+ </div>
+
+ <div class="description">
+ If set to true, uses the `zip` utility to create
+ a .zip archive of the pagckage
+
+
+
+ </div>
+
+
+
+
+ <div class="hr"></div>
+
+ <div class="fixedFont heading" id="packageFiles">
+ <span class='lighter'>
+
+ </span>
+
+
+
+ <b>packageFiles</b>
+ </div>
+
+ <div class="description">
+ The list of files and directories to include in the
+ package-archive
+
+
+
+ </div>
+
+
+
+
+ <div class="hr"></div>
+
+ <div class="fixedFont heading" id="tarCommand">
+ <span class='lighter'>
+
+ </span>
+
+
+
+ <b>tarCommand</b>
+ </div>
+
+ <div class="description">
+ The shell-command to use for creating tar archives.
+
+
+
+ </div>
+
+
+
+
+ <div class="hr"></div>
+
+ <div class="fixedFont heading" id="version">
+ <span class='lighter'>
+
+ </span>
+
+
+
+ <b>version</b>
+ </div>
+
+ <div class="description">
+ The project version-string
+
+
+
+ </div>
+
+
+
+
+ <div class="hr"></div>
+
+ <div class="fixedFont heading" id="zipCommand">
+ <span class='lighter'>
+
+ </span>
+
+
+
+ <b>zipCommand</b>
+ </div>
+
+ <div class="description">
+ The shell-command to use for creating zip archives.
+
+
+
+ </div>
+
+
+
+
+
+
+ </div>
+ </div>
+
+<!--
+#### METHOD DETAILS
+-->
+
+
+<!--
+#### EVENT DETAILS
+-->
+
+ </div>
+</div>
+ <script type="text/javascript">
+ wbos.CssTools.MediaQueryFallBack.LoadCss('../css/screen.css', '../css/handheld.css', 660)
+ codeview.classFilter.Init()
+ </script>
+ </body>
+</html>
+
View
397 doc/symbols/jake.Task.html
@@ -0,0 +1,397 @@
+
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta charset="utf8"></meta>
+ <meta name="generator" content="JsDoc Toolkit"></meta>
+ <title>jake.Task | JsDoc Reference</title>
+
+ <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0;"></meta>
+ <meta name="mobileoptimized" content="0"></meta>
+
+ <link rel="stylesheet" href="../css/all.css" media="all"></link>
+ <link rel="stylesheet" href="../css/handheld.css" media="only screen and (max-width: 660px)"></link>
+ <link rel="stylesheet" href="../css/handheld.css" media="handheld"></link>
+ <link rel="stylesheet" href="../css/screen.css" media="screen and (min-width: 661px)"></link>
+
+ <script src="../javascript/all.js"></script>
+ <!--[if lt IE 9]>
+ <script src="../javascript/html5.js"></script>
+ <![endif]-->
+ </head>
+
+ <body>
+
+<div class="index">
+ <div class="menu">
+ <div class="indexLinks">
+ <a href="../index.html">Classes</a>
+ <a href="../files.html">Files</a>
+ </div>
+
+ <h2 class="heading1">Classes</h2>
+
+ <input type="text" name="classFilter" class="classFilter" id="ClassFilter" placeholder="Filter"></input>
+
+ <nav>
+ <ul class="classList" id="ClassList">
+
+ <li><a href="../symbols/_global_.html">_global_</a></li>
+
+ <li><a href="../symbols/jake.html">jake</a></li>
+
+ <li><a href="../symbols/jake.DirectoryTask.html">jake<span class='break'> </span>.<span class='break'> </span>DirectoryTask</a></li>
+
+ <li><a href="../symbols/jake.FileTask.html">jake<span class='break'> </span>.<span class='break'> </span>FileTask</a></li>
+
+ <li><a href="../symbols/jake.PackageTask.html">jake<span class='break'> </span>.<span class='break'> </span>PackageTask</a></li>
+
+ <li><a href="../symbols/jake.Task.html">jake<span class='break'> </span>.<span class='break'> </span>Task</a></li>
+
+ </ul>
+ </nav>
+ </div>
+ <div class="fineprint" style="clear:both">
+
+ Documentation generator: <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0<br />
+ Template: <a href="http://www.thebrightlines.com/2010/05/06/new-template-for-jsdoctoolkit-codeview/" target="_blank">Codeview</a> 1.2<br />
+ Generated on: 2012-2-6 12:12
+ </div>
+</div>
+
+<div class="index indexStatic"></div>
+
+<div class="content">
+ <div class="innerContent">
+ <h1 class="classTitle">
+
+ Class <span>jake.Task</span>
+ </h1>
+
+ <div class="intro">
+ <p class="description summary">
+
+ </p>
+
+
+ <ul class="summary">
+
+
+
+ <li>Defined in: <a href="../symbols/src/lib_task_task.js.html">task.js</a></li>
+
+ <li>Extends <span class="fixedFont">
+ EventEmitter</span></li>
+
+ </ul>
+
+ </div>
+
+
+ <div class="props">
+ <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class jake.Task.">
+ <caption class="sectionTitle">Class Summary</caption>
+ <thead>
+ <tr>
+ <th scope="col">Constructor Attributes</th>
+ <th scope="col">Constructor Name and Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription" >
+ <div class="fixedFont">
+ <b><a href="../symbols/jake.Task.html#constructor">jake.Task</a></b>(name, [prereqs], [action], [opts])
+ </div>
+ <div class="description">A Jake Task</div>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+ </div>
+
+
+
+<!--
+#### METHODS SUMMARY
+-->
+
+
+
+ <div class="props">
+ <h2 class="sectionTitle">Method Summary</h2>
+
+
+ <table class="summaryTable" id="MethodsList" cellspacing="0" summary="A summary of the methods documented in the class jake.Task.">
+ <thead>
+ <tr>
+ <th scope="col">Method Attributes</th>
+ <th scope="col">Method Name and Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
+ <tr
+ class='item0'
+ >
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont"><b><a href="../symbols/jake.Task.html#invoke">invoke</a></b>()
+ </div>
+ <div class="description">Runs prerequisites, then this task.</div>
+ </td>
+ </tr>
+
+ <tr
+ class='item1'
+ >
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont"><b><a href="../symbols/jake.Task.html#reenable">reenable</a></b>()
+ </div>
+ <div class="description">Runs this task, without running any prerequisites.</div>
+ </td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+ </div>
+
+
+<!--
+#### EVENTS SUMMARY
+-->
+
+
+
+ <div class="props">
+ <table class="summaryTable" cellspacing="0" summary="A summary of the events documented in the class jake.Task.">
+ <caption class="sectionTitle">Event Summary</caption>
+
+ <thead>
+ <tr>
+ <th scope="col">Event Attributes</th>
+ <th scope="col">Event Name and Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+ <tr>
+ <td class="attributes">&nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont"><b><a href="../symbols/jake.Task.html#event:complete">complete</a></b>
+ </div>
+ <div class="description"></div>
+ </td>
+ </tr>
+
+ </tbody>
+ </table>
+ </div>
+
+
+
+
+<!--
+#### CONSTRUCTOR DETAILS
+-->
+
+ <div class="details props">
+ <div class="innerProps">
+ <h2 class="sectionTitle" id="constructor">
+ Class Detail
+ </h2>
+
+ <div class="fixedFont">
+ <b>jake.Task</b>(name, [prereqs], [action], [opts])
+ </div>
+
+ <div class="description">
+ A Jake Task
+
+ </div>
+
+
+
+
+ <dl class="detailList params">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="light fixedFont">{String}</span> <b>name</b>
+
+ </dt>
+ <dd>The name of the Task</dd>
+
+ <dt>
+ <span class="light fixedFont">{Array}</span> <b>prereqs</b>
+ <i>Optional</i>
+ </dt>
+ <dd>Prerequisites to be run before this task</dd>
+
+ <dt>
+ <span class="light fixedFont">{Function}</span> <b>action</b>
+ <i>Optional</i>
+ </dt>
+ <dd>The action to perform for this task</dd>
+
+ <dt>
+ <span class="light fixedFont">{Object}</span> <b>opts</b>
+ <i>Optional</i>
+ </dt>
+ <dd></dd>
+
+ <dt>
+ <span class="light fixedFont">{Array}</span> <b>opts.asyc</b>
+ <i>Optional, Default: false</i>
+ </dt>
+ <dd>Perform this task asynchronously.
+ If you flag a task with this option, you must call the global
+ `complete` method inside the task's action, for execution to proceed
+ to the next task.</dd>
+
+ </dl>
+
+
+
+ </div>
+ </div>
+
+<!--
+#### FIELD DETAILS
+-->
+
+<!--
+#### METHOD DETAILS
+-->
+
+ <div class="details props">
+ <div class="innerProps">
+ <h2 class="sectionTitle">
+ Method Detail
+ </h2>
+
+ <ul class="methodDetail" id="MethodDetail">
+
+
+ <li
+ class='item0'
+ >
+ <div class="fixedFont heading" id="invoke">
+ <span class='lighter'>
+
+ </span>
+
+
+
+ <b>invoke</b>()
+ </div>
+
+ <div class="description">
+ Runs prerequisites, then this task. If the task has already
+ been run, will not run the task again.
+
+
+
+
+ </div>
+
+
+
+
+
+
+ <div class="hr"></div>
+ </li>
+
+ <li
+ class='item1'
+ >
+ <div class="fixedFont heading" id="reenable">
+ <span class='lighter'>
+
+ </span>
+
+
+
+ <b>reenable</b>()
+ </div>
+
+ <div class="description">
+ Runs this task, without running any prerequisites. If the task
+ has already been run, it will still run it again.
+
+
+
+
+ </div>
+
+
+
+
+
+
+
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
+
+<!--
+#### EVENT DETAILS
+-->
+
+ <div class="details props">
+ <div class="innerProps">
+ <h2 class="sectionTitle">
+ Event Detail
+ </h2>
+
+
+ <div class="fixedFont heading" id="event:event:complete">
+ <span class='lighter'>
+
+ </span>
+
+
+
+ <b>complete</b>
+ </div>
+
+ <div class="description">
+
+
+
+
+
+ </div>
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </div>
+</div>
+ <script type="text/javascript">
+ wbos.CssTools.MediaQueryFallBack.LoadCss('../css/screen.css', '../css/handheld.css', 660)
+ codeview.classFilter.Init()
+ </script>
+ </body>
+</html>
+
View
151 doc/symbols/jake.html
@@ -40,6 +40,14 @@ <h2 class="heading1">Classes</h2>
<li><a href="../symbols/jake.html">jake</a></li>
+ <li><a href="../symbols/jake.DirectoryTask.html">jake<span class='break'> </span>.<span class='break'> </span>DirectoryTask</a></li>
+
+ <li><a href="../symbols/jake.FileTask.html">jake<span class='break'> </span>.<span class='break'> </span>FileTask</a></li>
+
+ <li><a href="../symbols/jake.PackageTask.html">jake<span class='break'> </span>.<span class='break'> </span>PackageTask</a></li>
+
+ <li><a href="../symbols/jake.Task.html">jake<span class='break'> </span>.<span class='break'> </span>Task</a></li>
+
</ul>
</nav>
</div>
@@ -47,7 +55,7 @@ <h2 class="heading1">Classes</h2>
Documentation generator: <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0<br />
Template: <a href="http://www.thebrightlines.com/2010/05/06/new-template-for-jsdoctoolkit-codeview/" target="_blank">Codeview</a> 1.2<br />
- Generated on: 2012-1-14 14:01
+ Generated on: 2012-2-6 12:12
</div>
</div>
@@ -70,7 +78,7 @@ <h1 class="classTitle">
- <li>Defined in: <a href="../symbols/src/lib_api.js.html">api.js</a></li>
+ <li>Defined in: <a href="../symbols/src/lib_package_task.js.html">package_task.js</a></li>
</ul>
@@ -107,6 +115,42 @@ <h1 class="classTitle">
#### METHODS SUMMARY
-->
+
+
+ <div class="props">
+ <h2 class="sectionTitle">Method Summary</h2>
+
+
+ <table class="summaryTable" id="MethodsList" cellspacing="0" summary="A summary of the methods documented in the class jake.">
+ <thead>
+ <tr>
+ <th scope="col">Method Attributes</th>
+ <th scope="col">Method Name and Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
+ <tr
+ class='item0'
+ >
+ <td class="attributes">&lt;static&gt; &nbsp;</td>
+ <td class="nameDescription">
+ <div class="fixedFont">jake.<b><a href="../symbols/jake.html#.exec">exec</a></b>(cmds, [callback], [opts])
+ </div>
+ <div class="description">Executes shell-commands asynchronously with an optional
+ final callback.</div>
+ </td>
+ </tr>
+
+ </tbody>
+ </table>
+
+
+
+ </div>
+
<!--
#### EVENTS SUMMARY
@@ -147,6 +191,109 @@ <h2 class="sectionTitle" id="constructor">
#### METHOD DETAILS
-->
+ <div class="details props">
+ <div class="innerProps">
+ <h2 class="sectionTitle">
+ Method Detail
+ </h2>
+
+ <ul class="methodDetail" id="MethodDetail">
+
+
+ <li
+ class='item0'
+ >
+ <div class="fixedFont heading" id=".exec">
+ <span class='lighter'>
+ &lt;static&gt;
+ </span>
+
+
+
+ <span class="light">jake.</span><b>exec</b>(cmds, [callback], [opts])
+ </div>
+
+ <div class="description">
+ Executes shell-commands asynchronously with an optional
+ final callback.
+ `
+
+
+ <br />
+ <i>Defined in: </i> <a href="../symbols/src/lib_utils_index.js.html">index.js</a>.
+
+
+
+ </div>
+
+
+
+ <pre class="code"> var cmds = [
+ 'echo "showing directories"'
+ , 'ls -al | grep ^d'
+ , 'echo "moving up a directory"'
+ , 'cd ../'
+ ]
+ , callback = function () {
+ console.log('Finished running commands.');
+ }
+ jake.exec(cmds, callback, {stdout: true});</pre>
+
+
+
+
+ <dl class="detailList params">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="light fixedFont">{String[]}</span> <b>cmds</b>
+
+ </dt>
+ <dd>The list of shell-commands to execute</dd>
+
+ <dt>
+ <span class="light fixedFont">{Function}</span> <b>callback</b>
+ <i>Optional</i>
+ </dt>
+ <dd>Callback to run after executing the
+ commands</dd>
+
+ <dt>
+ <span class="light fixedFont">{Object}</span> <b>opts</b>
+ <i>Optional</i>
+ </dt>
+ <dd></dd>
+
+ <dt>
+ <span class="light fixedFont">{Boolean}</span> <b>opts.stdout</b>
+ <i>Optional, Default: false</i>
+ </dt>
+ <dd>Print stdout from each command</dd>
+
+ <dt>
+ <span class="light fixedFont">{Boolean}</span> <b>opts.stderr</b>
+ <i>Optional, Default: false</i>
+ </dt>
+ <dd>Print stderr from each command</dd>
+
+ <dt>
+ <span class="light fixedFont">{Boolean}</span> <b>opts.breakOnError</b>
+ <i>Optional, Default: true</i>
+ </dt>
+ <dd>Stop further execution on
+ the first error.</dd>
+
+ </dl>
+
+
+
+
+ </li>
+
+ </ul>
+ </div>
+ </div>
+
<!--
#### EVENT DETAILS
View
432 doc/symbols/src/lib_api.js.html
@@ -24,223 +24,219 @@
<span class='line'> 17</span> */</span><span class="WHIT">
<span class='line'> 18</span> </span><span class="KEYW">var</span><span class="WHIT"> </span><span class="NAME">exec</span><span class="WHIT"> </span><span class="PUNC">=</span><span class="WHIT"> </span><span class="NAME">require</span><span class="PUNC">(</span><span class="STRN">'child_process'</span><span class="PUNC">)</span><span class="PUNC">.</span><span class="NAME">exec</span><span class="PUNC">;</span><span class="WHIT">
<span class='line'> 19</span>
-<span class='line'> 20</span> </span><span class="COMM">/**
-<span class='line'> 21</span> @name jake
-<span class='line'> 22</span> @namespace jake
-<span class='line'> 23</span> */</span><span class="WHIT">
-<span class='line'> 24</span> </span><span class="KEYW">var</span><span class="WHIT"> </span><span class="NAME">api</span><span class="WHIT"> </span><span class="PUNC">=</span><span class="WHIT"> </span><span class="KEYW">new</span><span class="WHIT"> </span><span class="PUNC">(</span><span class="KEYW">function</span><span class="WHIT"> </span><span class="PUNC">(</span><span class="PUNC">)</span><span class="WHIT"> </span><span class="PUNC">{</span><span class="WHIT">
-<span class='line'> 25</span> </span><span class="WHIT"> </span><span class="COMM">/**
-<span class='line'> 26</span> @name task
-<span class='line'> 27</span> @static
-<span class='line'> 28</span> @function
-<span class='line'> 29</span> @description Creates a Jake Task
-<span class='line'> 30</span> `
-<span class='line'> 31</span> @param {String} name The name of the Task
-<span class='line'> 32</span> @param {Array} [prereqs] Prerequisites to be run before this task
-<span class='line'> 33</span> @param {Function} [action] The action to perform for this task
-<span class='line'> 34</span> @param {Object} [opts]
-<span class='line'> 35</span> @param {Array} [opts.asyc=false] Perform this task asynchronously.
-<span class='line'> 36</span> If you flag a task with this option, you must call the global
-<span class='line'> 37</span> `complete` method inside the task's action, for execution to proceed
-<span class='line'> 38</span> to the next task.
-<span class='line'> 39</span>
-<span class='line'> 40</span> @example
-<span class='line'> 41</span> desc('This is the default task.');
-<span class='line'> 42</span> task('default', function (params) {
-<span class='line'> 43</span> console.log('This is the default task.');
-<span class='line'> 44</span> });
-<span class='line'> 45</span>
-<span class='line'> 46</span> desc('This task has prerequisites.');
-<span class='line'> 47</span> task('hasPrereqs', ['foo', 'bar', 'baz'], function (params) {
-<span class='line'> 48</span> console.log('Ran some prereqs first.');
-<span class='line'> 49</span> });
-<span class='line'> 50</span>
-<span class='line'> 51</span> desc('This is an asynchronous task.');
-<span class='line'> 52</span> task('asyncTask', function () {
-<span class='line'> 53</span> setTimeout(complete, 1000);
-<span class='line'> 54</span> }, {async: true});
-<span class='line'> 55</span> */</span><span class="WHIT">
-<span class='line'> 56</span> </span><span class="WHIT"> </span><span class="NAME">this.task</span><span class="WHIT"> </span><span class="PUNC">=</span><span class="WHIT"> </span><span class="KEYW">function</span><span class="WHIT"> </span><span class="PUNC">(</span><span class="NAME">name</span><span class="PUNC">,</span><span class="WHIT"> </span><span class="NAME">prereqs</span><span class="PUNC">,</span><span class="WHIT"> </span><span class="NAME">action</span><span class="PUNC">,</span><span class="WHIT"> </span><span class="NAME">opts</span><span class="PUNC">)</span><span class="WHIT"> </span><span class="PUNC">{</span><span class="WHIT">
-<span class='line'> 57</span> </span><span class="WHIT"> </span><span class="KEYW">var</span><span class="WHIT"> </span><span class="NAME">args</span><span class="WHIT"> </span><span class="PUNC">=</span><span class="WHIT"> </span><span class="NAME">Array.prototype.slice.call</span><span class="PUNC">(</span><span class="NAME">arguments</span><span class="PUNC">)</span><span class="WHIT">
-<span class='line'> 58</span> </span><span class="WHIT"> </span><span class="PUNC">,</span><span class="WHIT"> </span><span class="NAME">type</span><span class="PUNC">;</span><span class="WHIT">
-<span class='line'> 59</span> </span><span class="WHIT"> </span><span class="NAME">args.unshift</span><span class="PUNC">(</span><span class="STRN">'task'</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
-<span class='line'> 60</span> </span><span class="WHIT"> </span><span class="NAME">jake.createTask.apply</span><span class="PUNC">(</span><span class="NAME">global</span><span class="PUNC">,</span><span class="WHIT"> </span><span class="NAME">args</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
-<span class='line'> 61</span> </span><span class="WHIT"> </span><span class="NAME">jake.currentTaskDescription</span><span class="WHIT"> </span><span class="PUNC">=</span><span class="WHIT"> </span><span class="KEYW">null</span><span class="PUNC">;</span><span class="WHIT">
-<span class='line'> 62</span> </span><span class="WHIT"> </span><span class="PUNC">}</span><span class="PUNC">;</span><span class="WHIT">
-<span class='line'> 63</span>
-<span class='line'> 64</span> </span><span class="WHIT"> </span><span class="COMM">/**
-<span class='line'> 65</span> @name directory
-<span class='line'> 66</span> @static
-<span class='line'> 67</span> @function
-<span class='line'> 68</span> @description Creates a Jake DirectoryTask. Can be used as a prerequisite
-<span class='line'> 69</span> for FileTasks, or for simply ensuring a directory exists for use with a
-<span class='line'> 70</span> Task's action.
-<span class='line'> 71</span> `
-<span class='line'> 72</span> @param {String} name The name of the DiretoryTask
-<span class='line'> 73</span>
-<span class='line'> 74</span> @example
-<span class='line'> 75</span>
-<span class='line'> 76</span> // Creates the package directory for distribution
-<span class='line'> 77</span> directory('pkg');
-<span class='line'> 78</span> */</span><span class="WHIT">
-<span class='line'> 79</span> </span><span class="WHIT"> </span><span class="NAME">this.directory</span><span class="WHIT"> </span><span class="PUNC">=</span><span class="WHIT"> </span><span class="KEYW">function</span><span class="WHIT"> </span><span class="PUNC">(</span><span class="NAME">name</span><span class="PUNC">)</span><span class="WHIT"> </span><span class="PUNC">{</span><span class="WHIT">
-<span class='line'> 80</span> </span><span class="WHIT"> </span><span class="KEYW">var</span><span class="WHIT"> </span><span class="NAME">args</span><span class="WHIT"> </span><span class="PUNC">=</span><span class="WHIT"> </span><span class="NAME">Array.prototype.slice.call</span><span class="PUNC">(</span><span class="NAME">arguments</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
-<span class='line'> 81</span> </span><span class="WHIT"> </span><span class="NAME">args.unshift</span><span class="PUNC">(</span><span class="STRN">'directory'</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
-<span class='line'> 82</span> </span><span class="WHIT"> </span><span class="NAME">jake.createTask.apply</span><span class="PUNC">(</span><span class="NAME">global</span><span class="PUNC">,</span><span class="WHIT"> </span><span class="NAME">args</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
-<span class='line'> 83</span> </span><span class="WHIT"> </span><span class="NAME">jake.currentTaskDescription</span><span class="WHIT"> </span><span class="PUNC">=</span><span class="WHIT"> </span><span class="KEYW">null</span><span class="PUNC">;</span><span class="WHIT">
-<span class='line'> 84</span> </span><span class="WHIT"> </span><span class="PUNC">}</span><span class="PUNC">;</span><span class="WHIT">
-<span class='line'> 85</span>
-<span class='line'> 86</span> </span><span class="WHIT"> </span><span class="COMM">/**
-<span class='line'> 87</span> @name file
-<span class='line'> 88</span> @static
-<span class='line'> 89</span> @function
-<span class='line'> 90</span> @description Creates a Jake FileTask.
-<span class='line'> 91</span> `
-<span class='line'> 92</span> @param {String} name The name of the FileTask
-<span class='line'> 93</span> @param {Array} [prereqs] Prerequisites to be run before this task
-<span class='line'> 94</span> @param {Function} [action] The action to create this file, if it doesn't
-<span class='line'> 95</span> exist already.
-<span class='line'> 96</span> @param {Object} [opts]
-<span class='line'> 97</span> @param {Array} [opts.asyc=false] Perform this task asynchronously.
-<span class='line'> 98</span> If you flag a task with this option, you must call the global
-<span class='line'> 99</span> `complete` method inside the task's action, for execution to proceed
-<span class='line'>100</span> to the next task.
-<span class='line'>101</span>
-<span class='line'>102</span> */</span><span class="WHIT">
-<span class='line'>103</span> </span><span class="WHIT"> </span><span class="NAME">this.file</span><span class="WHIT"> </span><span class="PUNC">=</span><span class="WHIT"> </span><span class="KEYW">function</span><span class="WHIT"> </span><span class="PUNC">(</span><span class="NAME">name</span><span class="PUNC">,</span><span class="WHIT"> </span><span class="NAME">prereqs</span><span class="PUNC">,</span><span class="WHIT"> </span><span class="NAME">action</span><span class="PUNC">,</span><span class="WHIT"> </span><span class="NAME">opts</span><span class="PUNC">)</span><span class="WHIT"> </span><span class="PUNC">{</span><span class="WHIT">
-<span class='line'>104</span> </span><span class="WHIT"> </span><span class="KEYW">var</span><span class="WHIT"> </span><span class="NAME">args</span><span class="WHIT"> </span><span class="PUNC">=</span><span class="WHIT"> </span><span class="NAME">Array.prototype.slice.call</span><span class="PUNC">(</span><span class="NAME">arguments</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
-<span class='line'>105</span> </span><span class="WHIT"> </span><span class="NAME">args.unshift</span><span class="PUNC">(</span><span class="STRN">'file'</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
-<span class='line'>106</span> </span><span class="WHIT"> </span><span class="NAME">jake.createTask.apply</span><span class="PUNC">(</span><span class="NAME">global</span><span class="PUNC">,</span><span class="WHIT"> </span><span class="NAME">args</span><span class="PUNC">)</span><span class="PUNC">;</span><span class="WHIT">
-<span class='line'>107</span> </span><span class="WHIT"> </span><span class="NAME">jake.currentTaskDescription</span><span class="WHIT"> </span><span class="PUNC">=</span><span class="WHIT"> </span><span class="KEYW">null</span><span class="PUNC">;</span><span class="WHIT">
-<span class='line'>108</span> </span><span class="WHIT"> </span><span class="PUNC">}</span><span class="PUNC">;</span><span class="WHIT">
-<span class='line'>109</span>
-<span class='line'>110</span> </span><span class="WHIT"> </span><span class="COMM">/**
-<span class='line'>111</span> @name desc
-<span class='line'>112</span> @static
-<span class='line'>113</span> @function
-<span class='line'>114</span> @description Creates a description for a Jake Task (or FileTask,
-<span class='line'>115</span> DirectoryTask). When invoked, the description that iscreated will
-<span class='line'>116</span> be associated with whatever Task is created next.
-<span class='line'>117</span> `
-<span class='line'>118</span> @param {String} description The description for the Task
-<span class='line'>119</span> */</span><span class="WHIT">
-<span class='line'>120</span> </span><span class="WHIT"> </span><span class="NAME">this.desc</span><span class="WHIT"> </span><span class="PUNC">=</span><span class="WHIT"> </span><span class="KEYW">function</span><span class="WHIT"> </span><span class="PUNC">(</span><span class="NAME">description</span><span class="PUNC">)</span><span class="WHIT"> </span><span class="PUNC">{</span><span class="WHIT">
-<span class='line'>121</span> </span><span class="WHIT"> </span><span class="NAME">jake.currentTaskDescription</span><span class="WHIT"> </span><span class="PUNC">=</span><span class="WHIT"> </span><span class="NAME">description</span><span class="PUNC">;</span><span class="WHIT">
-<span class='line'>122</span> </span><span class="WHIT"> </span><span class="PUNC">}</span><span class="PUNC">;</span><span class="WHIT">
-<span class='line'>123</span>
-<span class='line'>124</span> </span><span class="WHIT"> </span><span class="COMM">/**
-<span class='line'>125</span> @name namespace
-<span class='line'>126</span> @static
-<span class='line'>127</span> @function
-<span class='line'>128</span> @description Creates a namespace which allows logical grouping
-<span class='line'>129</span> of tasks, and prevents name-collisions with task-names. Namespaces
-<span class='line'>130</span> can be nested inside of other namespaces.
-<span class='line'>131</span> `
-<span class='line'>132</span> @param {String} name The name of the namespace
-<span class='line'>133</span> @param {Function} scope The enclosing scope for the namespaced tasks
-<span class='line'>134</span>
-<span class='line'>135</span> @example
-<span class='line'>136</span> namespace('doc', function () {
-<span class='line'>137</span> task('generate', ['doc:clobber'], function () {
-<span class='line'>138</span> // Generate some docs
+<span class='line'> 20</span> </span><span class="KEYW">var</span><span class="WHIT"> </span><span class="NAME">api</span><span class="WHIT"> </span><span class="PUNC">=</span><span class="WHIT"> </span><span class="KEYW">new</span><span class="WHIT"> </span><span class="PUNC">(</span><span class="KEYW">function</span><span class="WHIT"> </span><span class="PUNC">(</span><span class="PUNC">)</span><span class="WHIT"> </span><span class="PUNC">{</span><span class="WHIT">
+<span class='line'> 21</span> </span><span class="WHIT"> </span><span class="COMM">/**
+<span class='line'> 22</span> @name task
+<span class='line'> 23</span> @static
+<span class='line'> 24</span> @function
+<span class='line'> 25</span> @description Creates a Jake Task
+<span class='line'> 26</span> `
+<span class='line'> 27</span> @param {String} name The name of the Task
+<span class='line'> 28</span> @param {Array} [prereqs] Prerequisites to be run before this task
+<span class='line'> 29</span> @param {Function} [action] The action to perform for this task
+<span class='line'> 30</span> @param {Object} [opts]
+<span class='line'> 31</span> @param {Boolean} [opts.asyc=false] Perform this task asynchronously.
+<span class='line'> 32</span> If you flag a task with this option, you must call the global
+<span class='line'> 33</span> `complete` method inside the task's action, for execution to proceed
+<span class='line'> 34</span> to the next task.
+<span class='line'> 35</span>
+<span class='line'> 36</span> @example
+<span class='line'> 37</span> desc('This is the default task.');
+<span class='line'> 38</span> task('default', function (params) {
+<span class='line'> 39</span> console.log('This is the default task.');
+<span class='line'> 40</span> });
+<span class='line'> 41</span>
+<span class='line'> 42</span> desc('This task has prerequisites.');
+<span class='line'> 43</span> task('hasPrereqs', ['foo', 'bar', 'baz'], function (params) {
+<span class='line'> 44</span> console.log('Ran some prereqs first.');
+<span class='line'> 45</span> });
+<span class='line'> 46</span>
+<span class='line'> 47</span> desc('This is an asynchronous task.');
+<span class='line'> 48</span> task('asyncTask', function () {
+<span class='line'> 49</span> setTimeout(complete, 1000);
+<span class='line'> 50</span> }, {async: true});
+<span class='line'> 51</span> */</span><span class="WHIT">
+<span class='line'> 52</span> </span><span class="WHIT"> </span><span class="NAME">this.task</span><span class="WHIT"> </span><span class="PUNC">=</span><span class="WHIT"> </span><span class="KEYW">function</span><span class="WHIT"> </span><span class="PUNC">(</span><span class="NAME">name</span><span class="PUNC">,</span><span class="WHIT"> </span><span class="NAME">prereqs</span><span class="PUNC">,</span><span class="WHIT"> </span><span class="NAME">action</span><span class="PUNC">,</span><span class="WHIT"> </span><span class="NAME">opts</span><span class="PUNC">)</span><span class="WHIT"> </span><span class="PUNC">{</span><span class="WHIT">
+<span class='line'> 53</span> </span><span class="WHIT"> </span><span class="KEYW">var</span><span class="WHIT"> </span><span class="NAME">args</span><span class="WHIT"> </span><span class="PUNC">=</span><span class="WHIT"> </span><span class="NAME">Array.prototype.slice.call</span><span class="PUNC">(</span><span class="NAME">arguments</span><span class="PUNC">)</span><span class="WHIT">
+<span class='line'> 54</span> </span><span class="WHIT"> </span><span class="PUNC">,</span><span class="WHIT"> </span><span class="NAME">type</span><span class="PUNC">;</span><span class="WHIT">
+<span class='line'> 55</span> </span><span class="WHIT"> </span><span class=