зеркало из https://github.com/microsoft/just.git
adding documentation site
This commit is contained in:
Ken
Родитель
214480d0ed
Коммит
d74dec6986
|
|
@ -148,7 +148,7 @@
|
|||
},
|
||||
{
|
||||
"name": "cpx",
|
||||
"allowedCategories": [ "production", "tools" ]
|
||||
"allowedCategories": [ "docs", "production", "tools" ]
|
||||
},
|
||||
{
|
||||
"name": "css-loader",
|
||||
|
|
|
|||
Различия файлов скрыты, потому что одна или несколько строк слишком длинны
|
|
@ -0,0 +1,115 @@
|
|||
/**
|
||||
* Copyright (c) 2017-present, Facebook, Inc.
|
||||
*
|
||||
* This source code is licensed under the MIT license found in the
|
||||
* LICENSE file in the root directory of this source tree.
|
||||
*
|
||||
* Modified prism.js default theme for JavaScript, CSS and HTML
|
||||
* Based on dabblet (http://dabblet.com)
|
||||
* @author Lea Verou
|
||||
*/
|
||||
|
||||
code[class*='language-'],
|
||||
pre[class*='language-'] {
|
||||
font-family: Consolas, Monaco, 'Andale Mono', 'Ubuntu Mono', monospace;
|
||||
text-align: left;
|
||||
white-space: pre;
|
||||
word-spacing: normal;
|
||||
word-break: normal;
|
||||
word-wrap: normal;
|
||||
line-height: 1.5;
|
||||
|
||||
-moz-tab-size: 4;
|
||||
-o-tab-size: 4;
|
||||
tab-size: 4;
|
||||
|
||||
-webkit-hyphens: none;
|
||||
-moz-hyphens: none;
|
||||
-ms-hyphens: none;
|
||||
hyphens: none;
|
||||
}
|
||||
|
||||
/* Code blocks */
|
||||
pre[class*='language-'] {
|
||||
padding: 1em;
|
||||
margin: 0.5em 0;
|
||||
overflow: auto;
|
||||
}
|
||||
|
||||
/* Inline code */
|
||||
:not(pre) > code[class*='language-'] {
|
||||
padding: 0.1em;
|
||||
border-radius: 0.3em;
|
||||
white-space: normal;
|
||||
}
|
||||
|
||||
.token.comment,
|
||||
.token.prolog,
|
||||
.token.doctype,
|
||||
.token.cdata {
|
||||
color: slategray;
|
||||
}
|
||||
|
||||
.token.punctuation {
|
||||
color: #999;
|
||||
}
|
||||
|
||||
.namespace {
|
||||
opacity: 0.7;
|
||||
}
|
||||
|
||||
.token.property,
|
||||
.token.tag,
|
||||
.token.boolean,
|
||||
.token.constant,
|
||||
.token.symbol,
|
||||
.token.deleted {
|
||||
color: #905;
|
||||
}
|
||||
|
||||
.token.selector,
|
||||
.token.number,
|
||||
.token.attr-name,
|
||||
.token.string,
|
||||
.token.char,
|
||||
.token.builtin,
|
||||
.token.inserted {
|
||||
color: #690;
|
||||
}
|
||||
|
||||
.token.operator,
|
||||
.token.entity,
|
||||
.token.url,
|
||||
.language-css .token.string,
|
||||
.style .token.string {
|
||||
color: #9a6e3a;
|
||||
}
|
||||
|
||||
.token.atrule,
|
||||
.token.attr-value,
|
||||
.token.keyword {
|
||||
color: #07a;
|
||||
}
|
||||
|
||||
.token.function,
|
||||
.token.class-name {
|
||||
color: #dd4a68;
|
||||
}
|
||||
|
||||
.token.regex,
|
||||
.token.important,
|
||||
.token.variable {
|
||||
color: #e90;
|
||||
}
|
||||
|
||||
.token.important,
|
||||
.token.bold {
|
||||
font-weight: bold;
|
||||
}
|
||||
.token.italic {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
.token.entity {
|
||||
cursor: help;
|
||||
}
|
||||
|
|
@ -0,0 +1,46 @@
|
|||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Command line arguments · Build Rig</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<p><code>build-rig</code> uses the best pirate themed command line argument library ever: <code>yargs</code>, matey! So, rigs get documented pretty much automatically. However, tasks can customize the arguments that are accepted. <code>build-rig</code> exposes these via <code>this.argv</code> inside a task function.</p>
|
||||
"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Command line arguments · Build Rig"/><meta property="og:type" content="website"/><meta property="og:url" content="https://kenotron.github.io/build-rigindex.html"/><meta property="og:description" content="<p><code>build-rig</code> uses the best pirate themed command line argument library ever: <code>yargs</code>, matey! So, rigs get documented pretty much automatically. However, tasks can customize the arguments that are accepted. <code>build-rig</code> exposes these via <code>this.argv</code> inside a task function.</p>
|
||||
"/><meta name="twitter:card" content="summary"/><link rel="shortcut icon" href="/build-rigimg/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><link rel="stylesheet" href="/build-rigcss/main.css"/></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/build-rig"><h2 class="headerTitle">Build Rig</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavGroupActive"><a href="/build-rigdocs/doc-start" target="_self">Documentation</a></li><li class=""><a href="/build-righelp" target="_self">Help</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container docsNavContainer" id="docsNav"><nav class="toc"><div class="toggleNav"><section class="navWrapper wrapper"><div class="navBreadcrumb wrapper"><div class="navToggle" id="navToggler"><i></i></div><h2><i>›</i><span>Documentation</span></h2><div class="tocToggler" id="tocToggler"><i class="icon-toc"></i></div></div><div class="navGroups"><div class="navGroup"><h3 class="navGroupCategoryTitle">Documentation</h3><ul><li class="navListItem"><a class="navItem" href="/build-rigdocs/doc-start">Getting Started</a></li><li class="navListItem"><a class="navItem" href="/build-rigdocs/composition">Composition of tasks</a></li><li class="navListItem"><a class="navItem" href="/build-rigdocs/logging">Logging</a></li><li class="navListItem navListItemActive"><a class="navItem" href="/build-rigdocs/args">Command line arguments</a></li></ul></div></div></section></div><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
createToggler('#navToggler', '#docsNav', 'docsSliderActive');
|
||||
createToggler('#tocToggler', 'body', 'tocActive');
|
||||
|
||||
const headings = document.querySelector('.toc-headings');
|
||||
headings && headings.addEventListener('click', function(event) {
|
||||
if (event.target.tagName === 'A') {
|
||||
document.body.classList.remove('tocActive');
|
||||
}
|
||||
}, false);
|
||||
|
||||
function createToggler(togglerSelector, targetSelector, className) {
|
||||
var toggler = document.querySelector(togglerSelector);
|
||||
var target = document.querySelector(targetSelector);
|
||||
|
||||
if (!toggler) {
|
||||
return;
|
||||
}
|
||||
|
||||
toggler.onclick = function(event) {
|
||||
event.preventDefault();
|
||||
|
||||
target.classList.toggle(className);
|
||||
};
|
||||
}
|
||||
});
|
||||
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/kenotron/build-rig/tree/master/packages/documentation/docsargs.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Command line arguments</h1></header><article><div><span><p><code>build-rig</code> uses the best pirate themed command line argument library ever: <code>yargs</code>, matey! So, rigs get documented pretty much automatically. However, tasks can customize the arguments that are accepted. <code>build-rig</code> exposes these via <code>this.argv</code> inside a task function.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reading-arguments"></a><a href="#reading-arguments" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Reading arguments</h2>
|
||||
<p>To access the arguments passed in from command line, use the <code>this.argv</code> object provided by <code>yargs</code>.</p>
|
||||
<pre><code class="hljs css language-js">task(<span class="hljs-string">'pillageMeArgs'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) </span>{
|
||||
<span class="hljs-keyword">this</span>.logger.info(<span class="hljs-string">'a bunch of aarrrrrrgs'</span>, <span class="hljs-keyword">this</span>.argv);
|
||||
});
|
||||
</code></pre>
|
||||
<h2><a class="anchor" aria-hidden="true" id="describe-the-task-with-yargs-command-module"></a><a href="#describe-the-task-with-yargs-command-module" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Describe the task with Yargs command module</h2>
|
||||
<pre><code class="hljs css language-js">task(<span class="hljs-string">'blimey'</span>, { <span class="hljs-attr">describe</span>: <span class="hljs-string">'An exclamation of surprise.'</span>, <span class="hljs-attr">builder</span>: <span class="hljs-function"><span class="hljs-params">yargs</span> =></span> yargs.option(<span class="hljs-string">'name'</span>) }, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) </span>{
|
||||
<span class="hljs-keyword">this</span>.logger.info(<span class="hljs-string">`blimey! <span class="hljs-subst">${<span class="hljs-keyword">this</span>.argv.name}</span>`</span>);
|
||||
});
|
||||
</code></pre>
|
||||
<p>If you describe the task in this fashion, you can get a list of tasks with descriptions like this:</p>
|
||||
<pre><code class="hljs">rig <span class="hljs-comment">--help</span>
|
||||
rig blimey <span class="hljs-comment">--help</span>
|
||||
</code></pre>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/build-rigdocs/logging"><span class="arrow-prev">← </span><span>Logging</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#reading-arguments">Reading arguments</a></li><li><a href="#describe-the-task-with-yargs-command-module">Describe the task with Yargs command module</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="copyright">Copyright © 2018</section></footer></div></body></html>
|
||||
|
|
@ -0,0 +1,46 @@
|
|||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Command line arguments · Build Rig</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<p><code>build-rig</code> uses the best pirate themed command line argument library ever: <code>yargs</code>, matey! So, rigs get documented pretty much automatically. However, tasks can customize the arguments that are accepted. <code>build-rig</code> exposes these via <code>this.argv</code> inside a task function.</p>
|
||||
"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Command line arguments · Build Rig"/><meta property="og:type" content="website"/><meta property="og:url" content="https://kenotron.github.io/build-rigindex.html"/><meta property="og:description" content="<p><code>build-rig</code> uses the best pirate themed command line argument library ever: <code>yargs</code>, matey! So, rigs get documented pretty much automatically. However, tasks can customize the arguments that are accepted. <code>build-rig</code> exposes these via <code>this.argv</code> inside a task function.</p>
|
||||
"/><meta name="twitter:card" content="summary"/><link rel="shortcut icon" href="/build-rigimg/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><link rel="stylesheet" href="/build-rigcss/main.css"/></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/build-rig"><h2 class="headerTitle">Build Rig</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavGroupActive"><a href="/build-rigdocs/doc-start" target="_self">Documentation</a></li><li class=""><a href="/build-righelp" target="_self">Help</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container docsNavContainer" id="docsNav"><nav class="toc"><div class="toggleNav"><section class="navWrapper wrapper"><div class="navBreadcrumb wrapper"><div class="navToggle" id="navToggler"><i></i></div><h2><i>›</i><span>Documentation</span></h2><div class="tocToggler" id="tocToggler"><i class="icon-toc"></i></div></div><div class="navGroups"><div class="navGroup"><h3 class="navGroupCategoryTitle">Documentation</h3><ul><li class="navListItem"><a class="navItem" href="/build-rigdocs/doc-start">Getting Started</a></li><li class="navListItem"><a class="navItem" href="/build-rigdocs/composition">Composition of tasks</a></li><li class="navListItem"><a class="navItem" href="/build-rigdocs/logging">Logging</a></li><li class="navListItem navListItemActive"><a class="navItem" href="/build-rigdocs/args">Command line arguments</a></li></ul></div></div></section></div><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
createToggler('#navToggler', '#docsNav', 'docsSliderActive');
|
||||
createToggler('#tocToggler', 'body', 'tocActive');
|
||||
|
||||
const headings = document.querySelector('.toc-headings');
|
||||
headings && headings.addEventListener('click', function(event) {
|
||||
if (event.target.tagName === 'A') {
|
||||
document.body.classList.remove('tocActive');
|
||||
}
|
||||
}, false);
|
||||
|
||||
function createToggler(togglerSelector, targetSelector, className) {
|
||||
var toggler = document.querySelector(togglerSelector);
|
||||
var target = document.querySelector(targetSelector);
|
||||
|
||||
if (!toggler) {
|
||||
return;
|
||||
}
|
||||
|
||||
toggler.onclick = function(event) {
|
||||
event.preventDefault();
|
||||
|
||||
target.classList.toggle(className);
|
||||
};
|
||||
}
|
||||
});
|
||||
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/kenotron/build-rig/tree/master/packages/documentation/docsargs.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Command line arguments</h1></header><article><div><span><p><code>build-rig</code> uses the best pirate themed command line argument library ever: <code>yargs</code>, matey! So, rigs get documented pretty much automatically. However, tasks can customize the arguments that are accepted. <code>build-rig</code> exposes these via <code>this.argv</code> inside a task function.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="reading-arguments"></a><a href="#reading-arguments" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Reading arguments</h2>
|
||||
<p>To access the arguments passed in from command line, use the <code>this.argv</code> object provided by <code>yargs</code>.</p>
|
||||
<pre><code class="hljs css language-js">task(<span class="hljs-string">'pillageMeArgs'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) </span>{
|
||||
<span class="hljs-keyword">this</span>.logger.info(<span class="hljs-string">'a bunch of aarrrrrrgs'</span>, <span class="hljs-keyword">this</span>.argv);
|
||||
});
|
||||
</code></pre>
|
||||
<h2><a class="anchor" aria-hidden="true" id="describe-the-task-with-yargs-command-module"></a><a href="#describe-the-task-with-yargs-command-module" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Describe the task with Yargs command module</h2>
|
||||
<pre><code class="hljs css language-js">task(<span class="hljs-string">'blimey'</span>, { <span class="hljs-attr">describe</span>: <span class="hljs-string">'An exclamation of surprise.'</span>, <span class="hljs-attr">builder</span>: <span class="hljs-function"><span class="hljs-params">yargs</span> =></span> yargs.option(<span class="hljs-string">'name'</span>) }, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) </span>{
|
||||
<span class="hljs-keyword">this</span>.logger.info(<span class="hljs-string">`blimey! <span class="hljs-subst">${<span class="hljs-keyword">this</span>.argv.name}</span>`</span>);
|
||||
});
|
||||
</code></pre>
|
||||
<p>If you describe the task in this fashion, you can get a list of tasks with descriptions like this:</p>
|
||||
<pre><code class="hljs">rig <span class="hljs-comment">--help</span>
|
||||
rig blimey <span class="hljs-comment">--help</span>
|
||||
</code></pre>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/build-rigdocs/logging"><span class="arrow-prev">← </span><span>Logging</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#reading-arguments">Reading arguments</a></li><li><a href="#describe-the-task-with-yargs-command-module">Describe the task with Yargs command module</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="copyright">Copyright © 2018</section></footer></div></body></html>
|
||||
|
|
@ -0,0 +1,81 @@
|
|||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Composition of tasks · Build Rig</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<p>Once a project get to be a bit more complex, a build step might consist of multiple sub tasks. This can be achieved with composition. This is the main reason <code>build-rig</code> is made. It simplifies the composition of tasks.</p>
|
||||
"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Composition of tasks · Build Rig"/><meta property="og:type" content="website"/><meta property="og:url" content="https://kenotron.github.io/build-rigindex.html"/><meta property="og:description" content="<p>Once a project get to be a bit more complex, a build step might consist of multiple sub tasks. This can be achieved with composition. This is the main reason <code>build-rig</code> is made. It simplifies the composition of tasks.</p>
|
||||
"/><meta name="twitter:card" content="summary"/><link rel="shortcut icon" href="/build-rigimg/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><link rel="stylesheet" href="/build-rigcss/main.css"/></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/build-rig"><h2 class="headerTitle">Build Rig</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavGroupActive"><a href="/build-rigdocs/doc-start" target="_self">Documentation</a></li><li class=""><a href="/build-righelp" target="_self">Help</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container docsNavContainer" id="docsNav"><nav class="toc"><div class="toggleNav"><section class="navWrapper wrapper"><div class="navBreadcrumb wrapper"><div class="navToggle" id="navToggler"><i></i></div><h2><i>›</i><span>Documentation</span></h2><div class="tocToggler" id="tocToggler"><i class="icon-toc"></i></div></div><div class="navGroups"><div class="navGroup"><h3 class="navGroupCategoryTitle">Documentation</h3><ul><li class="navListItem"><a class="navItem" href="/build-rigdocs/doc-start">Getting Started</a></li><li class="navListItem navListItemActive"><a class="navItem" href="/build-rigdocs/composition">Composition of tasks</a></li><li class="navListItem"><a class="navItem" href="/build-rigdocs/logging">Logging</a></li><li class="navListItem"><a class="navItem" href="/build-rigdocs/args">Command line arguments</a></li></ul></div></div></section></div><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
createToggler('#navToggler', '#docsNav', 'docsSliderActive');
|
||||
createToggler('#tocToggler', 'body', 'tocActive');
|
||||
|
||||
const headings = document.querySelector('.toc-headings');
|
||||
headings && headings.addEventListener('click', function(event) {
|
||||
if (event.target.tagName === 'A') {
|
||||
document.body.classList.remove('tocActive');
|
||||
}
|
||||
}, false);
|
||||
|
||||
function createToggler(togglerSelector, targetSelector, className) {
|
||||
var toggler = document.querySelector(togglerSelector);
|
||||
var target = document.querySelector(targetSelector);
|
||||
|
||||
if (!toggler) {
|
||||
return;
|
||||
}
|
||||
|
||||
toggler.onclick = function(event) {
|
||||
event.preventDefault();
|
||||
|
||||
target.classList.toggle(className);
|
||||
};
|
||||
}
|
||||
});
|
||||
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/kenotron/build-rig/tree/master/packages/documentation/docscomposition.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Composition of tasks</h1></header><article><div><span><p>Once a project get to be a bit more complex, a build step might consist of multiple sub tasks. This can be achieved with composition. This is the main reason <code>build-rig</code> is made. It simplifies the composition of tasks.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="running-tasks-in-a-series"></a><a href="#running-tasks-in-a-series" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Running tasks in a series</h2>
|
||||
<pre><code class="hljs css language-js"><span class="hljs-comment">// rig.js</span>
|
||||
|
||||
<span class="hljs-keyword">const</span> { task, series } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'build-rig'</span>);
|
||||
|
||||
task(<span class="hljs-string">'clean'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) </span>{
|
||||
<span class="hljs-comment">// clean stuff</span>
|
||||
});
|
||||
|
||||
task(<span class="hljs-string">'babel'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) </span>{
|
||||
<span class="hljs-comment">// run babel over some files</span>
|
||||
});
|
||||
|
||||
task(<span class="hljs-string">'build'</span>, series(<span class="hljs-string">'clean'</span>, <span class="hljs-string">'babel'</span>));
|
||||
</code></pre>
|
||||
<p>When you trigger <code>rig build</code>, the <code>clean</code> task will run and complete before <code>babel</code> task is run.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="runny-tasks-in-parallel"></a><a href="#runny-tasks-in-parallel" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Runny tasks in parallel</h2>
|
||||
<p>To take advantage of multi-core CPUs on our machines, we can run several tasks in parallel. Simply use the <code>parallel()</code> function.</p>
|
||||
<pre><code class="hljs css language-js"><span class="hljs-comment">// rig.js</span>
|
||||
|
||||
<span class="hljs-keyword">const</span> { task, parallel } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'build-rig'</span>);
|
||||
|
||||
task(<span class="hljs-string">'babel'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) </span>{
|
||||
<span class="hljs-comment">// run babel babel over some files</span>
|
||||
});
|
||||
|
||||
task(<span class="hljs-string">'lint'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) </span>{
|
||||
<span class="hljs-comment">// run eslint over some files</span>
|
||||
});
|
||||
|
||||
task(<span class="hljs-string">'build'</span>, parallel(<span class="hljs-string">'babel'</span>, <span class="hljs-string">'lint'</span>));
|
||||
</code></pre>
|
||||
<h2><a class="anchor" aria-hidden="true" id="nesting-tasks-in-series-and-parallel"></a><a href="#nesting-tasks-in-series-and-parallel" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Nesting tasks in series and parallel</h2>
|
||||
<p>The most powerful feature of <code>build-rig</code> is its ability to compose tasks by nesting tasks in series and parallel. Let's combine the previous examples.</p>
|
||||
<pre><code class="hljs css language-js"><span class="hljs-comment">// rig.js</span>
|
||||
|
||||
<span class="hljs-keyword">const</span> { task, parallel, series } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'build-rig'</span>);
|
||||
|
||||
task(<span class="hljs-string">'babel'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) </span>{
|
||||
<span class="hljs-comment">// run babel babel over some files</span>
|
||||
});
|
||||
|
||||
task(<span class="hljs-string">'lint'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) </span>{
|
||||
<span class="hljs-comment">// run eslint over some files</span>
|
||||
});
|
||||
|
||||
task(<span class="hljs-string">'build'</span>, series(<span class="hljs-string">'clean'</span>, parallel(<span class="hljs-string">'babel'</span>, <span class="hljs-string">'lint'</span>)));
|
||||
</code></pre>
|
||||
<h2><a class="anchor" aria-hidden="true" id="next-steps"></a><a href="#next-steps" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Next Steps</h2>
|
||||
<p>Learn about <a href="/build-rigdocs/logging">logging</a></p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/build-rigdocs/doc-start"><span class="arrow-prev">← </span><span>Getting Started with Build</span></a><a class="docs-next button" href="/build-rigdocs/logging"><span>Logging</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#running-tasks-in-a-series">Running tasks in a series</a></li><li><a href="#runny-tasks-in-parallel">Runny tasks in parallel</a></li><li><a href="#nesting-tasks-in-series-and-parallel">Nesting tasks in series and parallel</a></li><li><a href="#next-steps">Next Steps</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="copyright">Copyright © 2018</section></footer></div></body></html>
|
||||
|
|
@ -0,0 +1,81 @@
|
|||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Composition of tasks · Build Rig</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<p>Once a project get to be a bit more complex, a build step might consist of multiple sub tasks. This can be achieved with composition. This is the main reason <code>build-rig</code> is made. It simplifies the composition of tasks.</p>
|
||||
"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Composition of tasks · Build Rig"/><meta property="og:type" content="website"/><meta property="og:url" content="https://kenotron.github.io/build-rigindex.html"/><meta property="og:description" content="<p>Once a project get to be a bit more complex, a build step might consist of multiple sub tasks. This can be achieved with composition. This is the main reason <code>build-rig</code> is made. It simplifies the composition of tasks.</p>
|
||||
"/><meta name="twitter:card" content="summary"/><link rel="shortcut icon" href="/build-rigimg/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><link rel="stylesheet" href="/build-rigcss/main.css"/></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/build-rig"><h2 class="headerTitle">Build Rig</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavGroupActive"><a href="/build-rigdocs/doc-start" target="_self">Documentation</a></li><li class=""><a href="/build-righelp" target="_self">Help</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container docsNavContainer" id="docsNav"><nav class="toc"><div class="toggleNav"><section class="navWrapper wrapper"><div class="navBreadcrumb wrapper"><div class="navToggle" id="navToggler"><i></i></div><h2><i>›</i><span>Documentation</span></h2><div class="tocToggler" id="tocToggler"><i class="icon-toc"></i></div></div><div class="navGroups"><div class="navGroup"><h3 class="navGroupCategoryTitle">Documentation</h3><ul><li class="navListItem"><a class="navItem" href="/build-rigdocs/doc-start">Getting Started</a></li><li class="navListItem navListItemActive"><a class="navItem" href="/build-rigdocs/composition">Composition of tasks</a></li><li class="navListItem"><a class="navItem" href="/build-rigdocs/logging">Logging</a></li><li class="navListItem"><a class="navItem" href="/build-rigdocs/args">Command line arguments</a></li></ul></div></div></section></div><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
createToggler('#navToggler', '#docsNav', 'docsSliderActive');
|
||||
createToggler('#tocToggler', 'body', 'tocActive');
|
||||
|
||||
const headings = document.querySelector('.toc-headings');
|
||||
headings && headings.addEventListener('click', function(event) {
|
||||
if (event.target.tagName === 'A') {
|
||||
document.body.classList.remove('tocActive');
|
||||
}
|
||||
}, false);
|
||||
|
||||
function createToggler(togglerSelector, targetSelector, className) {
|
||||
var toggler = document.querySelector(togglerSelector);
|
||||
var target = document.querySelector(targetSelector);
|
||||
|
||||
if (!toggler) {
|
||||
return;
|
||||
}
|
||||
|
||||
toggler.onclick = function(event) {
|
||||
event.preventDefault();
|
||||
|
||||
target.classList.toggle(className);
|
||||
};
|
||||
}
|
||||
});
|
||||
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/kenotron/build-rig/tree/master/packages/documentation/docscomposition.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Composition of tasks</h1></header><article><div><span><p>Once a project get to be a bit more complex, a build step might consist of multiple sub tasks. This can be achieved with composition. This is the main reason <code>build-rig</code> is made. It simplifies the composition of tasks.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="running-tasks-in-a-series"></a><a href="#running-tasks-in-a-series" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Running tasks in a series</h2>
|
||||
<pre><code class="hljs css language-js"><span class="hljs-comment">// rig.js</span>
|
||||
|
||||
<span class="hljs-keyword">const</span> { task, series } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'build-rig'</span>);
|
||||
|
||||
task(<span class="hljs-string">'clean'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) </span>{
|
||||
<span class="hljs-comment">// clean stuff</span>
|
||||
});
|
||||
|
||||
task(<span class="hljs-string">'babel'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) </span>{
|
||||
<span class="hljs-comment">// run babel over some files</span>
|
||||
});
|
||||
|
||||
task(<span class="hljs-string">'build'</span>, series(<span class="hljs-string">'clean'</span>, <span class="hljs-string">'babel'</span>));
|
||||
</code></pre>
|
||||
<p>When you trigger <code>rig build</code>, the <code>clean</code> task will run and complete before <code>babel</code> task is run.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="runny-tasks-in-parallel"></a><a href="#runny-tasks-in-parallel" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Runny tasks in parallel</h2>
|
||||
<p>To take advantage of multi-core CPUs on our machines, we can run several tasks in parallel. Simply use the <code>parallel()</code> function.</p>
|
||||
<pre><code class="hljs css language-js"><span class="hljs-comment">// rig.js</span>
|
||||
|
||||
<span class="hljs-keyword">const</span> { task, parallel } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'build-rig'</span>);
|
||||
|
||||
task(<span class="hljs-string">'babel'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) </span>{
|
||||
<span class="hljs-comment">// run babel babel over some files</span>
|
||||
});
|
||||
|
||||
task(<span class="hljs-string">'lint'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) </span>{
|
||||
<span class="hljs-comment">// run eslint over some files</span>
|
||||
});
|
||||
|
||||
task(<span class="hljs-string">'build'</span>, parallel(<span class="hljs-string">'babel'</span>, <span class="hljs-string">'lint'</span>));
|
||||
</code></pre>
|
||||
<h2><a class="anchor" aria-hidden="true" id="nesting-tasks-in-series-and-parallel"></a><a href="#nesting-tasks-in-series-and-parallel" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Nesting tasks in series and parallel</h2>
|
||||
<p>The most powerful feature of <code>build-rig</code> is its ability to compose tasks by nesting tasks in series and parallel. Let's combine the previous examples.</p>
|
||||
<pre><code class="hljs css language-js"><span class="hljs-comment">// rig.js</span>
|
||||
|
||||
<span class="hljs-keyword">const</span> { task, parallel, series } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'build-rig'</span>);
|
||||
|
||||
task(<span class="hljs-string">'babel'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) </span>{
|
||||
<span class="hljs-comment">// run babel babel over some files</span>
|
||||
});
|
||||
|
||||
task(<span class="hljs-string">'lint'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) </span>{
|
||||
<span class="hljs-comment">// run eslint over some files</span>
|
||||
});
|
||||
|
||||
task(<span class="hljs-string">'build'</span>, series(<span class="hljs-string">'clean'</span>, parallel(<span class="hljs-string">'babel'</span>, <span class="hljs-string">'lint'</span>)));
|
||||
</code></pre>
|
||||
<h2><a class="anchor" aria-hidden="true" id="next-steps"></a><a href="#next-steps" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Next Steps</h2>
|
||||
<p>Learn about <a href="/build-rigdocs/logging">logging</a></p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/build-rigdocs/doc-start"><span class="arrow-prev">← </span><span>Getting Started with Build</span></a><a class="docs-next button" href="/build-rigdocs/logging"><span>Logging</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#running-tasks-in-a-series">Running tasks in a series</a></li><li><a href="#runny-tasks-in-parallel">Runny tasks in parallel</a></li><li><a href="#nesting-tasks-in-series-and-parallel">Nesting tasks in series and parallel</a></li><li><a href="#next-steps">Next Steps</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="copyright">Copyright © 2018</section></footer></div></body></html>
|
||||
|
|
@ -0,0 +1,46 @@
|
|||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Getting Started with Build · Build Rig</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<p>Build Rig is a build task definition library. It stands on the shoulders of two excellent and well tested libraries: undertaker and yargs. To get started, place a <code>rig.js</code> file in the root of your project:</p>
|
||||
"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Getting Started with Build · Build Rig"/><meta property="og:type" content="website"/><meta property="og:url" content="https://kenotron.github.io/build-rigindex.html"/><meta property="og:description" content="<p>Build Rig is a build task definition library. It stands on the shoulders of two excellent and well tested libraries: undertaker and yargs. To get started, place a <code>rig.js</code> file in the root of your project:</p>
|
||||
"/><meta name="twitter:card" content="summary"/><link rel="shortcut icon" href="/build-rigimg/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><link rel="stylesheet" href="/build-rigcss/main.css"/></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/build-rig"><h2 class="headerTitle">Build Rig</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavGroupActive siteNavItemActive"><a href="/build-rigdocs/doc-start" target="_self">Documentation</a></li><li class=""><a href="/build-righelp" target="_self">Help</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container docsNavContainer" id="docsNav"><nav class="toc"><div class="toggleNav"><section class="navWrapper wrapper"><div class="navBreadcrumb wrapper"><div class="navToggle" id="navToggler"><i></i></div><h2><i>›</i><span>Documentation</span></h2><div class="tocToggler" id="tocToggler"><i class="icon-toc"></i></div></div><div class="navGroups"><div class="navGroup"><h3 class="navGroupCategoryTitle">Documentation</h3><ul><li class="navListItem navListItemActive"><a class="navItem" href="/build-rigdocs/doc-start">Getting Started</a></li><li class="navListItem"><a class="navItem" href="/build-rigdocs/composition">Composition of tasks</a></li><li class="navListItem"><a class="navItem" href="/build-rigdocs/logging">Logging</a></li><li class="navListItem"><a class="navItem" href="/build-rigdocs/args">Command line arguments</a></li></ul></div></div></section></div><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
createToggler('#navToggler', '#docsNav', 'docsSliderActive');
|
||||
createToggler('#tocToggler', 'body', 'tocActive');
|
||||
|
||||
const headings = document.querySelector('.toc-headings');
|
||||
headings && headings.addEventListener('click', function(event) {
|
||||
if (event.target.tagName === 'A') {
|
||||
document.body.classList.remove('tocActive');
|
||||
}
|
||||
}, false);
|
||||
|
||||
function createToggler(togglerSelector, targetSelector, className) {
|
||||
var toggler = document.querySelector(togglerSelector);
|
||||
var target = document.querySelector(targetSelector);
|
||||
|
||||
if (!toggler) {
|
||||
return;
|
||||
}
|
||||
|
||||
toggler.onclick = function(event) {
|
||||
event.preventDefault();
|
||||
|
||||
target.classList.toggle(className);
|
||||
};
|
||||
}
|
||||
});
|
||||
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/kenotron/build-rig/tree/master/packages/documentation/docsdoc-start.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Getting Started with Build</h1></header><article><div><span><p>Build Rig is a build task definition library. It stands on the shoulders of two excellent and well tested libraries: undertaker and yargs. To get started, place a <code>rig.js</code> file in the root of your project:</p>
|
||||
<pre><code class="hljs">touch rig<span class="hljs-selector-class">.js</span>
|
||||
</code></pre>
|
||||
<p>Place some task definitions inside this file:</p>
|
||||
<pre><code class="hljs css language-js"><span class="hljs-keyword">const</span> { task } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'build-rig'</span>);
|
||||
|
||||
task(<span class="hljs-string">'hello'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) </span>{
|
||||
<span class="hljs-keyword">this</span>.logger.info(<span class="hljs-string">'world'</span>);
|
||||
});
|
||||
</code></pre>
|
||||
<p>Then run it!</p>
|
||||
<pre><code class="hljs"><span class="hljs-quote">> npx rig hello</span>
|
||||
</code></pre>
|
||||
<p>That's all!</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="next-steps"></a><a href="#next-steps" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Next Steps</h2>
|
||||
<p>Learn about how to <a href="/build-rigdocs/composition">compose tasks into <em>rigs</em></a></p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/build-rigdocs/composition"><span>Composition of tasks</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#next-steps">Next Steps</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="copyright">Copyright © 2018</section></footer></div></body></html>
|
||||
|
|
@ -0,0 +1,46 @@
|
|||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Getting Started with Build · Build Rig</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<p>Build Rig is a build task definition library. It stands on the shoulders of two excellent and well tested libraries: undertaker and yargs. To get started, place a <code>rig.js</code> file in the root of your project:</p>
|
||||
"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Getting Started with Build · Build Rig"/><meta property="og:type" content="website"/><meta property="og:url" content="https://kenotron.github.io/build-rigindex.html"/><meta property="og:description" content="<p>Build Rig is a build task definition library. It stands on the shoulders of two excellent and well tested libraries: undertaker and yargs. To get started, place a <code>rig.js</code> file in the root of your project:</p>
|
||||
"/><meta name="twitter:card" content="summary"/><link rel="shortcut icon" href="/build-rigimg/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><link rel="stylesheet" href="/build-rigcss/main.css"/></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/build-rig"><h2 class="headerTitle">Build Rig</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavGroupActive siteNavItemActive"><a href="/build-rigdocs/doc-start" target="_self">Documentation</a></li><li class=""><a href="/build-righelp" target="_self">Help</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container docsNavContainer" id="docsNav"><nav class="toc"><div class="toggleNav"><section class="navWrapper wrapper"><div class="navBreadcrumb wrapper"><div class="navToggle" id="navToggler"><i></i></div><h2><i>›</i><span>Documentation</span></h2><div class="tocToggler" id="tocToggler"><i class="icon-toc"></i></div></div><div class="navGroups"><div class="navGroup"><h3 class="navGroupCategoryTitle">Documentation</h3><ul><li class="navListItem navListItemActive"><a class="navItem" href="/build-rigdocs/doc-start">Getting Started</a></li><li class="navListItem"><a class="navItem" href="/build-rigdocs/composition">Composition of tasks</a></li><li class="navListItem"><a class="navItem" href="/build-rigdocs/logging">Logging</a></li><li class="navListItem"><a class="navItem" href="/build-rigdocs/args">Command line arguments</a></li></ul></div></div></section></div><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
createToggler('#navToggler', '#docsNav', 'docsSliderActive');
|
||||
createToggler('#tocToggler', 'body', 'tocActive');
|
||||
|
||||
const headings = document.querySelector('.toc-headings');
|
||||
headings && headings.addEventListener('click', function(event) {
|
||||
if (event.target.tagName === 'A') {
|
||||
document.body.classList.remove('tocActive');
|
||||
}
|
||||
}, false);
|
||||
|
||||
function createToggler(togglerSelector, targetSelector, className) {
|
||||
var toggler = document.querySelector(togglerSelector);
|
||||
var target = document.querySelector(targetSelector);
|
||||
|
||||
if (!toggler) {
|
||||
return;
|
||||
}
|
||||
|
||||
toggler.onclick = function(event) {
|
||||
event.preventDefault();
|
||||
|
||||
target.classList.toggle(className);
|
||||
};
|
||||
}
|
||||
});
|
||||
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/kenotron/build-rig/tree/master/packages/documentation/docsdoc-start.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Getting Started with Build</h1></header><article><div><span><p>Build Rig is a build task definition library. It stands on the shoulders of two excellent and well tested libraries: undertaker and yargs. To get started, place a <code>rig.js</code> file in the root of your project:</p>
|
||||
<pre><code class="hljs">touch rig<span class="hljs-selector-class">.js</span>
|
||||
</code></pre>
|
||||
<p>Place some task definitions inside this file:</p>
|
||||
<pre><code class="hljs css language-js"><span class="hljs-keyword">const</span> { task } = <span class="hljs-built_in">require</span>(<span class="hljs-string">'build-rig'</span>);
|
||||
|
||||
task(<span class="hljs-string">'hello'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) </span>{
|
||||
<span class="hljs-keyword">this</span>.logger.info(<span class="hljs-string">'world'</span>);
|
||||
});
|
||||
</code></pre>
|
||||
<p>Then run it!</p>
|
||||
<pre><code class="hljs"><span class="hljs-quote">> npx rig hello</span>
|
||||
</code></pre>
|
||||
<p>That's all!</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="next-steps"></a><a href="#next-steps" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Next Steps</h2>
|
||||
<p>Learn about how to <a href="/build-rigdocs/composition">compose tasks into <em>rigs</em></a></p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/build-rigdocs/composition"><span>Composition of tasks</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#next-steps">Next Steps</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="copyright">Copyright © 2018</section></footer></div></body></html>
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Logging · Build Rig</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<p><code>build-rig</code> is simple, but it is opinionated. One of the built-in capabilities of <code>build-rig</code> is logging. We feel that this is an important enough of a feature to be available inside a task within its own context.</p>
|
||||
"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Logging · Build Rig"/><meta property="og:type" content="website"/><meta property="og:url" content="https://kenotron.github.io/build-rigindex.html"/><meta property="og:description" content="<p><code>build-rig</code> is simple, but it is opinionated. One of the built-in capabilities of <code>build-rig</code> is logging. We feel that this is an important enough of a feature to be available inside a task within its own context.</p>
|
||||
"/><meta name="twitter:card" content="summary"/><link rel="shortcut icon" href="/build-rigimg/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><link rel="stylesheet" href="/build-rigcss/main.css"/></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/build-rig"><h2 class="headerTitle">Build Rig</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavGroupActive"><a href="/build-rigdocs/doc-start" target="_self">Documentation</a></li><li class=""><a href="/build-righelp" target="_self">Help</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container docsNavContainer" id="docsNav"><nav class="toc"><div class="toggleNav"><section class="navWrapper wrapper"><div class="navBreadcrumb wrapper"><div class="navToggle" id="navToggler"><i></i></div><h2><i>›</i><span>Documentation</span></h2><div class="tocToggler" id="tocToggler"><i class="icon-toc"></i></div></div><div class="navGroups"><div class="navGroup"><h3 class="navGroupCategoryTitle">Documentation</h3><ul><li class="navListItem"><a class="navItem" href="/build-rigdocs/doc-start">Getting Started</a></li><li class="navListItem"><a class="navItem" href="/build-rigdocs/composition">Composition of tasks</a></li><li class="navListItem navListItemActive"><a class="navItem" href="/build-rigdocs/logging">Logging</a></li><li class="navListItem"><a class="navItem" href="/build-rigdocs/args">Command line arguments</a></li></ul></div></div></section></div><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
createToggler('#navToggler', '#docsNav', 'docsSliderActive');
|
||||
createToggler('#tocToggler', 'body', 'tocActive');
|
||||
|
||||
const headings = document.querySelector('.toc-headings');
|
||||
headings && headings.addEventListener('click', function(event) {
|
||||
if (event.target.tagName === 'A') {
|
||||
document.body.classList.remove('tocActive');
|
||||
}
|
||||
}, false);
|
||||
|
||||
function createToggler(togglerSelector, targetSelector, className) {
|
||||
var toggler = document.querySelector(togglerSelector);
|
||||
var target = document.querySelector(targetSelector);
|
||||
|
||||
if (!toggler) {
|
||||
return;
|
||||
}
|
||||
|
||||
toggler.onclick = function(event) {
|
||||
event.preventDefault();
|
||||
|
||||
target.classList.toggle(className);
|
||||
};
|
||||
}
|
||||
});
|
||||
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/kenotron/build-rig/tree/master/packages/documentation/docslogging.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Logging</h1></header><article><div><span><p><code>build-rig</code> is simple, but it is opinionated. One of the built-in capabilities of <code>build-rig</code> is logging. We feel that this is an important enough of a feature to be available inside a task within its own context.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="usage"></a><a href="#usage" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Usage</h2>
|
||||
<p>To log within the task, simply use the <code>logger</code> object off of <code>this</code> inside a task function.</p>
|
||||
<pre><code class="hljs css language-js">task(<span class="hljs-string">'needsLogging'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) </span>{
|
||||
<span class="hljs-keyword">this</span>.logger.info(<span class="hljs-string">'log something'</span>);
|
||||
});
|
||||
</code></pre>
|
||||
<h2><a class="anchor" aria-hidden="true" id="next-steps"></a><a href="#next-steps" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Next Steps</h2>
|
||||
<p>Learn about processing <a href="/build-rigdocs/args">arguments from command line</a></p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/build-rigdocs/composition"><span class="arrow-prev">← </span><span>Composition of tasks</span></a><a class="docs-next button" href="/build-rigdocs/args"><span>Command line arguments</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#usage">Usage</a></li><li><a href="#next-steps">Next Steps</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="copyright">Copyright © 2018</section></footer></div></body></html>
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Logging · Build Rig</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="<p><code>build-rig</code> is simple, but it is opinionated. One of the built-in capabilities of <code>build-rig</code> is logging. We feel that this is an important enough of a feature to be available inside a task within its own context.</p>
|
||||
"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Logging · Build Rig"/><meta property="og:type" content="website"/><meta property="og:url" content="https://kenotron.github.io/build-rigindex.html"/><meta property="og:description" content="<p><code>build-rig</code> is simple, but it is opinionated. One of the built-in capabilities of <code>build-rig</code> is logging. We feel that this is an important enough of a feature to be available inside a task within its own context.</p>
|
||||
"/><meta name="twitter:card" content="summary"/><link rel="shortcut icon" href="/build-rigimg/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><link rel="stylesheet" href="/build-rigcss/main.css"/></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/build-rig"><h2 class="headerTitle">Build Rig</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavGroupActive"><a href="/build-rigdocs/doc-start" target="_self">Documentation</a></li><li class=""><a href="/build-righelp" target="_self">Help</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container docsNavContainer" id="docsNav"><nav class="toc"><div class="toggleNav"><section class="navWrapper wrapper"><div class="navBreadcrumb wrapper"><div class="navToggle" id="navToggler"><i></i></div><h2><i>›</i><span>Documentation</span></h2><div class="tocToggler" id="tocToggler"><i class="icon-toc"></i></div></div><div class="navGroups"><div class="navGroup"><h3 class="navGroupCategoryTitle">Documentation</h3><ul><li class="navListItem"><a class="navItem" href="/build-rigdocs/doc-start">Getting Started</a></li><li class="navListItem"><a class="navItem" href="/build-rigdocs/composition">Composition of tasks</a></li><li class="navListItem navListItemActive"><a class="navItem" href="/build-rigdocs/logging">Logging</a></li><li class="navListItem"><a class="navItem" href="/build-rigdocs/args">Command line arguments</a></li></ul></div></div></section></div><script>
|
||||
document.addEventListener('DOMContentLoaded', function() {
|
||||
createToggler('#navToggler', '#docsNav', 'docsSliderActive');
|
||||
createToggler('#tocToggler', 'body', 'tocActive');
|
||||
|
||||
const headings = document.querySelector('.toc-headings');
|
||||
headings && headings.addEventListener('click', function(event) {
|
||||
if (event.target.tagName === 'A') {
|
||||
document.body.classList.remove('tocActive');
|
||||
}
|
||||
}, false);
|
||||
|
||||
function createToggler(togglerSelector, targetSelector, className) {
|
||||
var toggler = document.querySelector(togglerSelector);
|
||||
var target = document.querySelector(targetSelector);
|
||||
|
||||
if (!toggler) {
|
||||
return;
|
||||
}
|
||||
|
||||
toggler.onclick = function(event) {
|
||||
event.preventDefault();
|
||||
|
||||
target.classList.toggle(className);
|
||||
};
|
||||
}
|
||||
});
|
||||
</script></nav></div><div class="container mainContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/kenotron/build-rig/tree/master/packages/documentation/docslogging.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 class="postHeaderTitle">Logging</h1></header><article><div><span><p><code>build-rig</code> is simple, but it is opinionated. One of the built-in capabilities of <code>build-rig</code> is logging. We feel that this is an important enough of a feature to be available inside a task within its own context.</p>
|
||||
<h2><a class="anchor" aria-hidden="true" id="usage"></a><a href="#usage" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Usage</h2>
|
||||
<p>To log within the task, simply use the <code>logger</code> object off of <code>this</code> inside a task function.</p>
|
||||
<pre><code class="hljs css language-js">task(<span class="hljs-string">'needsLogging'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) </span>{
|
||||
<span class="hljs-keyword">this</span>.logger.info(<span class="hljs-string">'log something'</span>);
|
||||
});
|
||||
</code></pre>
|
||||
<h2><a class="anchor" aria-hidden="true" id="next-steps"></a><a href="#next-steps" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Next Steps</h2>
|
||||
<p>Learn about processing <a href="/build-rigdocs/args">arguments from command line</a></p>
|
||||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/build-rigdocs/composition"><span class="arrow-prev">← </span><span>Composition of tasks</span></a><a class="docs-next button" href="/build-rigdocs/args"><span>Command line arguments</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#usage">Usage</a></li><li><a href="#next-steps">Next Steps</a></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="copyright">Copyright © 2018</section></footer></div></body></html>
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Build Rig · Documentation on Build Rig</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="Documentation on Build Rig"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Build Rig · Documentation on Build Rig"/><meta property="og:type" content="website"/><meta property="og:url" content="https://kenotron.github.io/build-rigindex.html"/><meta property="og:description" content="Documentation on Build Rig"/><meta name="twitter:card" content="summary"/><link rel="shortcut icon" href="/build-rigimg/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><link rel="stylesheet" href="/build-rigcss/main.css"/></head><body><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/build-rig"><h2 class="headerTitle">Build Rig</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/build-rigdocs/doc-start" target="_self">Documentation</a></li><li class="siteNavItemActive"><a href="/build-righelp" target="_self">Help</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer documentContainer postContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1>Need help?</h1></header><p>This project is maintained by a dedicated group of people.</p><div class="gridBlock"><div class="blockElement threeByGridBlock"><div class="blockContent"><h2><div><span><p>Browse Docs</p>
|
||||
</span></div></h2><div><span><p>Learn more using the <a href="/build-rigdocs/en/doc1.html">documentation on this site.</a></p>
|
||||
</span></div></div></div><div class="blockElement threeByGridBlock"><div class="blockContent"><h2><div><span><p>Join the community</p>
|
||||
</span></div></h2><div><span><p>Ask questions about the documentation and project</p>
|
||||
</span></div></div></div><div class="blockElement threeByGridBlock"><div class="blockContent"><h2><div><span><p>Stay up to date</p>
|
||||
</span></div></h2><div><span><p>Find out what's new with this project</p>
|
||||
</span></div></div></div></div></div></div></div></div><footer class="nav-footer" id="footer"><section class="copyright">Copyright © 2018</section></footer></div></body></html>
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Build Rig · Documentation on Build Rig</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="Documentation on Build Rig"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Build Rig · Documentation on Build Rig"/><meta property="og:type" content="website"/><meta property="og:url" content="https://kenotron.github.io/build-rigindex.html"/><meta property="og:description" content="Documentation on Build Rig"/><meta name="twitter:card" content="summary"/><link rel="shortcut icon" href="/build-rigimg/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><link rel="stylesheet" href="/build-rigcss/main.css"/></head><body><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/build-rig"><h2 class="headerTitle">Build Rig</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/build-rigdocs/doc-start" target="_self">Documentation</a></li><li class="siteNavItemActive"><a href="/build-righelp" target="_self">Help</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer documentContainer postContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1>Need help?</h1></header><p>This project is maintained by a dedicated group of people.</p><div class="gridBlock"><div class="blockElement threeByGridBlock"><div class="blockContent"><h2><div><span><p>Browse Docs</p>
|
||||
</span></div></h2><div><span><p>Learn more using the <a href="/build-rigdocs/en/doc1.html">documentation on this site.</a></p>
|
||||
</span></div></div></div><div class="blockElement threeByGridBlock"><div class="blockContent"><h2><div><span><p>Join the community</p>
|
||||
</span></div></h2><div><span><p>Ask questions about the documentation and project</p>
|
||||
</span></div></div></div><div class="blockElement threeByGridBlock"><div class="blockContent"><h2><div><span><p>Stay up to date</p>
|
||||
</span></div></h2><div><span><p>Find out what's new with this project</p>
|
||||
</span></div></div></div></div></div></div></div></div><footer class="nav-footer" id="footer"><section class="copyright">Copyright © 2018</section></footer></div></body></html>
|
||||
|
|
@ -0,0 +1 @@
|
|||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Build Rig · Documentation on Build Rig</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="Documentation on Build Rig"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Build Rig · Documentation on Build Rig"/><meta property="og:type" content="website"/><meta property="og:url" content="https://kenotron.github.io/build-rigindex.html"/><meta property="og:description" content="Documentation on Build Rig"/><meta name="twitter:card" content="summary"/><link rel="shortcut icon" href="/build-rigimg/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><link rel="stylesheet" href="/build-rigcss/main.css"/></head><body><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/build-rig"><h2 class="headerTitle">Build Rig</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/build-rigdocs/doc-start" target="_self">Documentation</a></li><li class=""><a href="/build-righelp" target="_self">Help</a></li></ul></nav></div></header></div></div><div class="navPusher"><div><div class="homeContainer"><div class="homeSplashFade"><div class="wrapper homeWrapper"><div class="inner"><h2 class="projectTitle">Build Rig<small>Documentation on Build Rig</small></h2><div class="section promoSection"><div class="promoRow"><div class="pluginRowBlock"><div class="pluginWrapper buttonWrapper"><a class="button" href="/build-rigdocs/en/doc-start.html" target="_self">Let's Get Started!</a></div></div></div></div></div></div></div></div></div><footer class="nav-footer" id="footer"><section class="copyright">Copyright © 2018</section></footer></div></body></html>
|
||||
|
|
@ -0,0 +1 @@
|
|||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Build Rig · Documentation on Build Rig</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="Documentation on Build Rig"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Build Rig · Documentation on Build Rig"/><meta property="og:type" content="website"/><meta property="og:url" content="https://kenotron.github.io/build-rigindex.html"/><meta property="og:description" content="Documentation on Build Rig"/><meta name="twitter:card" content="summary"/><link rel="shortcut icon" href="/build-rigimg/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><link rel="stylesheet" href="/build-rigcss/main.css"/></head><body><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/build-rig"><h2 class="headerTitle">Build Rig</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/build-rigdocs/doc-start" target="_self">Documentation</a></li><li class=""><a href="/build-righelp" target="_self">Help</a></li></ul></nav></div></header></div></div><div class="navPusher"><footer class="nav-footer" id="footer"><section class="copyright">Copyright © 2018</section></footer></div></body></html>
|
||||
|
|
@ -0,0 +1 @@
|
|||
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Build Rig · Documentation on Build Rig</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="Documentation on Build Rig"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Build Rig · Documentation on Build Rig"/><meta property="og:type" content="website"/><meta property="og:url" content="https://kenotron.github.io/build-rigindex.html"/><meta property="og:description" content="Documentation on Build Rig"/><meta name="twitter:card" content="summary"/><link rel="shortcut icon" href="/build-rigimg/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><link rel="stylesheet" href="/build-rigcss/main.css"/></head><body><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/build-rig"><h2 class="headerTitle">Build Rig</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/build-rigdocs/doc-start" target="_self">Documentation</a></li><li class=""><a href="/build-righelp" target="_self">Help</a></li></ul></nav></div></header></div></div><div class="navPusher"><footer class="nav-footer" id="footer"><section class="copyright">Copyright © 2018</section></footer></div></body></html>
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
<!DOCTYPE html><html lang=""><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Build Rig · Documentation on Build Rig</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="Documentation on Build Rig"/><meta property="og:title" content="Build Rig · Documentation on Build Rig"/><meta property="og:type" content="website"/><meta property="og:url" content="https://kenotron.github.io/build-rigindex.html"/><meta property="og:description" content="Documentation on Build Rig"/><meta name="twitter:card" content="summary"/><link rel="shortcut icon" href="/build-rigimg/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><link rel="stylesheet" href="/build-rigcss/main.css"/></head><body><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/build-rig"><h2 class="headerTitle">Build Rig</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/build-rigdocs/doc-start" target="_self">Documentation</a></li><li class="siteNavItemActive"><a href="/build-righelp" target="_self">Help</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer documentContainer postContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1>Need help?</h1></header><p>This project is maintained by a dedicated group of people.</p><div class="gridBlock"><div class="blockElement threeByGridBlock"><div class="blockContent"><h2><div><span><p>Browse Docs</p>
|
||||
</span></div></h2><div><span><p>Learn more using the <a href="/build-rigdocs/doc1.html">documentation on this site.</a></p>
|
||||
</span></div></div></div><div class="blockElement threeByGridBlock"><div class="blockContent"><h2><div><span><p>Join the community</p>
|
||||
</span></div></h2><div><span><p>Ask questions about the documentation and project</p>
|
||||
</span></div></div></div><div class="blockElement threeByGridBlock"><div class="blockContent"><h2><div><span><p>Stay up to date</p>
|
||||
</span></div></h2><div><span><p>Find out what's new with this project</p>
|
||||
</span></div></div></div></div></div></div></div></div><footer class="nav-footer" id="footer"><section class="copyright">Copyright © 2018</section></footer></div></body></html>
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
<!DOCTYPE html><html lang=""><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Build Rig · Documentation on Build Rig</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="Documentation on Build Rig"/><meta property="og:title" content="Build Rig · Documentation on Build Rig"/><meta property="og:type" content="website"/><meta property="og:url" content="https://kenotron.github.io/build-rigindex.html"/><meta property="og:description" content="Documentation on Build Rig"/><meta name="twitter:card" content="summary"/><link rel="shortcut icon" href="/build-rigimg/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><link rel="stylesheet" href="/build-rigcss/main.css"/></head><body><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/build-rig"><h2 class="headerTitle">Build Rig</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/build-rigdocs/doc-start" target="_self">Documentation</a></li><li class="siteNavItemActive"><a href="/build-righelp" target="_self">Help</a></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer documentContainer postContainer"><div class="wrapper"><div class="post"><header class="postHeader"><h1>Need help?</h1></header><p>This project is maintained by a dedicated group of people.</p><div class="gridBlock"><div class="blockElement threeByGridBlock"><div class="blockContent"><h2><div><span><p>Browse Docs</p>
|
||||
</span></div></h2><div><span><p>Learn more using the <a href="/build-rigdocs/doc1.html">documentation on this site.</a></p>
|
||||
</span></div></div></div><div class="blockElement threeByGridBlock"><div class="blockContent"><h2><div><span><p>Join the community</p>
|
||||
</span></div></h2><div><span><p>Ask questions about the documentation and project</p>
|
||||
</span></div></div></div><div class="blockElement threeByGridBlock"><div class="blockContent"><h2><div><span><p>Stay up to date</p>
|
||||
</span></div></h2><div><span><p>Find out what's new with this project</p>
|
||||
</span></div></div></div></div></div></div></div></div><footer class="nav-footer" id="footer"><section class="copyright">Copyright © 2018</section></footer></div></body></html>
|
||||
Различия файлов скрыты, потому что одна или несколько строк слишком длинны
|
После Ширина: | Высота: | Размер: 43 KiB |
Двоичный файл не отображается.
|
После Ширина: | Высота: | Размер: 926 B |
Двоичный файл не отображается.
|
После Ширина: | Высота: | Размер: 9.4 KiB |
|
|
@ -0,0 +1,3 @@
|
|||
<svg class="language {{include.class}}" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20">
|
||||
<path fill="#ffffff" d="M19.753 10.909c-.624-1.707-2.366-2.726-4.661-2.726-.09 0-.176.002-.262.006l-.016-2.063 3.525-.607c.115-.019.133-.119.109-.231-.023-.111-.167-.883-.188-.976-.027-.131-.102-.127-.207-.109-.104.018-3.25.461-3.25.461l-.013-2.078c-.001-.125-.069-.158-.194-.156l-1.025.016c-.105.002-.164.049-.162.148l.033 2.307s-3.061.527-3.144.543c-.084.014-.17.053-.151.143.019.09.19 1.094.208 1.172.018.08.072.129.188.107l2.924-.504.035 2.018c-1.077.281-1.801.824-2.256 1.303-.768.807-1.207 1.887-1.207 2.963 0 1.586.971 2.529 2.328 2.695 3.162.387 5.119-3.06 5.769-4.715 1.097 1.506.256 4.354-2.094 5.98-.043.029-.098.129-.033.207l.619.756c.08.096.206.059.256.023 2.51-1.73 3.661-4.515 2.869-6.683zm-7.386 3.188c-.966-.121-.944-.914-.944-1.453 0-.773.327-1.58.876-2.156a3.21 3.21 0 0 1 1.229-.799l.082 4.277a2.773 2.773 0 0 1-1.243.131zm2.427-.553l.046-4.109c.084-.004.166-.01.252-.01.773 0 1.494.145 1.885.361.391.217-1.023 2.713-2.183 3.758zm-8.95-7.668a.196.196 0 0 0-.196-.145h-1.95a.194.194 0 0 0-.194.144L.008 16.916c-.017.051-.011.076.062.076h1.733c.075 0 .099-.023.114-.072l1.008-3.318h3.496l1.008 3.318c.016.049.039.072.113.072h1.734c.072 0 .078-.025.062-.076-.014-.05-3.083-9.741-3.494-11.04zm-2.618 6.318l1.447-5.25 1.447 5.25H3.226z"/>
|
||||
</svg>
|
||||
|
После Ширина: | Высота: | Размер: 1.3 KiB |
Двоичный файл не отображается.
|
После Ширина: | Высота: | Размер: 4.3 KiB |
|
|
@ -0,0 +1 @@
|
|||
<!DOCTYPE html><html lang=""><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Build Rig · Documentation on Build Rig</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="Documentation on Build Rig"/><meta property="og:title" content="Build Rig · Documentation on Build Rig"/><meta property="og:type" content="website"/><meta property="og:url" content="https://kenotron.github.io/build-rigindex.html"/><meta property="og:description" content="Documentation on Build Rig"/><meta name="twitter:card" content="summary"/><link rel="shortcut icon" href="/build-rigimg/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><link rel="stylesheet" href="/build-rigcss/main.css"/></head><body><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/build-rig"><h2 class="headerTitle">Build Rig</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/build-rigdocs/doc-start" target="_self">Documentation</a></li><li class=""><a href="/build-righelp" target="_self">Help</a></li></ul></nav></div></header></div></div><div class="navPusher"><div><div class="homeContainer"><div class="homeSplashFade"><div class="wrapper homeWrapper"><div class="inner"><h2 class="projectTitle">Build Rig<small>Documentation on Build Rig</small></h2><div class="section promoSection"><div class="promoRow"><div class="pluginRowBlock"><div class="pluginWrapper buttonWrapper"><a class="button" href="/build-rigdocs/doc-start.html" target="_self">Let's Get Started!</a></div></div></div></div></div></div></div></div></div><footer class="nav-footer" id="footer"><section class="copyright">Copyright © 2018</section></footer></div></body></html>
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:news="http://www.google.com/schemas/sitemap-news/0.9" xmlns:xhtml="http://www.w3.org/1999/xhtml" xmlns:mobile="http://www.google.com/schemas/sitemap-mobile/1.0" xmlns:image="http://www.google.com/schemas/sitemap-image/1.1" xmlns:video="http://www.google.com/schemas/sitemap-video/1.1">
|
||||
<url> <loc>https://kenotron.github.io/build-rig/help</loc> <changefreq>weekly</changefreq> <priority>0.5</priority> <xhtml:link rel="alternate" hreflang="en" href="https://kenotron.github.io/build-rig/en/help" /> </url>
|
||||
<url> <loc>https://kenotron.github.io/build-rig/index</loc> <changefreq>weekly</changefreq> <priority>0.5</priority> <xhtml:link rel="alternate" hreflang="en" href="https://kenotron.github.io/build-rig/en/index" /> </url>
|
||||
<url> <loc>https://kenotron.github.io/build-rig/users</loc> <changefreq>weekly</changefreq> <priority>0.5</priority> <xhtml:link rel="alternate" hreflang="en" href="https://kenotron.github.io/build-rig/en/users" /> </url>
|
||||
<url> <loc>https://kenotron.github.io/build-rig/docs/args</loc> <changefreq>hourly</changefreq> <priority>1.0</priority> <xhtml:link rel="alternate" hreflang="en" href="https://kenotron.github.io/build-rig/docs/args" /> </url>
|
||||
<url> <loc>https://kenotron.github.io/build-rig/docs/composition</loc> <changefreq>hourly</changefreq> <priority>1.0</priority> <xhtml:link rel="alternate" hreflang="en" href="https://kenotron.github.io/build-rig/docs/composition" /> </url>
|
||||
<url> <loc>https://kenotron.github.io/build-rig/docs/doc-start</loc> <changefreq>hourly</changefreq> <priority>1.0</priority> <xhtml:link rel="alternate" hreflang="en" href="https://kenotron.github.io/build-rig/docs/doc-start" /> </url>
|
||||
<url> <loc>https://kenotron.github.io/build-rig/docs/logging</loc> <changefreq>hourly</changefreq> <priority>1.0</priority> <xhtml:link rel="alternate" hreflang="en" href="https://kenotron.github.io/build-rig/docs/logging" /> </url>
|
||||
</urlset>
|
||||
|
|
@ -0,0 +1 @@
|
|||
<!DOCTYPE html><html lang=""><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Build Rig · Documentation on Build Rig</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="Documentation on Build Rig"/><meta property="og:title" content="Build Rig · Documentation on Build Rig"/><meta property="og:type" content="website"/><meta property="og:url" content="https://kenotron.github.io/build-rigindex.html"/><meta property="og:description" content="Documentation on Build Rig"/><meta name="twitter:card" content="summary"/><link rel="shortcut icon" href="/build-rigimg/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><link rel="stylesheet" href="/build-rigcss/main.css"/></head><body><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/build-rig"><h2 class="headerTitle">Build Rig</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/build-rigdocs/doc-start" target="_self">Documentation</a></li><li class=""><a href="/build-righelp" target="_self">Help</a></li></ul></nav></div></header></div></div><div class="navPusher"><footer class="nav-footer" id="footer"><section class="copyright">Copyright © 2018</section></footer></div></body></html>
|
||||
|
|
@ -0,0 +1 @@
|
|||
<!DOCTYPE html><html lang=""><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Build Rig · Documentation on Build Rig</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="Documentation on Build Rig"/><meta property="og:title" content="Build Rig · Documentation on Build Rig"/><meta property="og:type" content="website"/><meta property="og:url" content="https://kenotron.github.io/build-rigindex.html"/><meta property="og:description" content="Documentation on Build Rig"/><meta name="twitter:card" content="summary"/><link rel="shortcut icon" href="/build-rigimg/favicon.png"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><link rel="stylesheet" href="/build-rigcss/main.css"/></head><body><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/build-rig"><h2 class="headerTitle">Build Rig</h2></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/build-rigdocs/doc-start" target="_self">Documentation</a></li><li class=""><a href="/build-righelp" target="_self">Help</a></li></ul></nav></div></header></div></div><div class="navPusher"><footer class="nav-footer" id="footer"><section class="copyright">Copyright © 2018</section></footer></div></body></html>
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
---
|
||||
id: args
|
||||
title: Command line arguments
|
||||
sidebar_label: Command line arguments
|
||||
---
|
||||
|
||||
`build-rig` uses the best pirate themed command line argument library ever: `yargs`, matey! So, rigs get documented pretty much automatically. However, tasks can customize the arguments that are accepted. `build-rig` exposes these via `this.argv` inside a task function.
|
||||
|
||||
## Reading arguments
|
||||
|
||||
To access the arguments passed in from command line, use the `this.argv` object provided by `yargs`.
|
||||
|
||||
```js
|
||||
task('pillageMeArgs', function() {
|
||||
this.logger.info('a bunch of aarrrrrrgs', this.argv);
|
||||
});
|
||||
```
|
||||
|
||||
## Describe the task with Yargs command module
|
||||
|
||||
```js
|
||||
task('blimey', { describe: 'An exclamation of surprise.', builder: yargs => yargs.option('name') }, function() {
|
||||
this.logger.info(`blimey! ${this.argv.name}`);
|
||||
});
|
||||
```
|
||||
|
||||
If you describe the task in this fashion, you can get a list of tasks with descriptions like this:
|
||||
|
||||
```
|
||||
rig --help
|
||||
rig blimey --help
|
||||
```
|
||||
|
|
@ -1,11 +1,9 @@
|
|||
---
|
||||
id: composition
|
||||
title: Composition of Tasks
|
||||
sidebar_label: Composition of Tasks
|
||||
title: Composition of tasks
|
||||
sidebar_label: Composition of tasks
|
||||
---
|
||||
|
||||
# Composition of Tasks
|
||||
|
||||
Once a project get to be a bit more complex, a build step might consist of multiple sub tasks. This can be achieved with composition. This is the main reason `build-rig` is made. It simplifies the composition of tasks.
|
||||
|
||||
## Running tasks in a series
|
||||
|
|
@ -70,4 +68,4 @@ task('build', series('clean', parallel('babel', 'lint')));
|
|||
|
||||
## Next Steps
|
||||
|
||||
Learn about Logging
|
||||
Learn about [logging](logging.md)
|
||||
|
|
|
|||
|
|
@ -4,8 +4,6 @@ title: Getting Started with Build
|
|||
sidebar_label: Getting Started
|
||||
---
|
||||
|
||||
# Getting Started
|
||||
|
||||
Build Rig is a build task definition library. It stands on the shoulders of two excellent and well tested libraries: undertaker and yargs. To get started, place a `rig.js` file in the root of your project:
|
||||
|
||||
```
|
||||
|
|
@ -32,4 +30,4 @@ That's all!
|
|||
|
||||
## Next Steps
|
||||
|
||||
Learn about how to compose tasks into _rigs_
|
||||
Learn about how to [compose tasks into _rigs_](composition.md)
|
||||
|
|
|
|||
|
|
@ -0,0 +1,21 @@
|
|||
---
|
||||
id: logging
|
||||
title: Logging
|
||||
sidebar_label: Logging
|
||||
---
|
||||
|
||||
`build-rig` is simple, but it is opinionated. One of the built-in capabilities of `build-rig` is logging. We feel that this is an important enough of a feature to be available inside a task within its own context.
|
||||
|
||||
## Usage
|
||||
|
||||
To log within the task, simply use the `logger` object off of `this` inside a task function.
|
||||
|
||||
```js
|
||||
task('needsLogging', function() {
|
||||
this.logger.info('log something');
|
||||
});
|
||||
```
|
||||
|
||||
## Next Steps
|
||||
|
||||
Learn about processing [arguments from command line](args.md)
|
||||
|
|
@ -21,16 +21,6 @@ class Footer extends React.Component {
|
|||
render() {
|
||||
return (
|
||||
<footer className="nav-footer" id="footer">
|
||||
<section className="sitemap">
|
||||
<div>
|
||||
<h5>Docs</h5>
|
||||
</div>
|
||||
<div>
|
||||
<h5>Community</h5>
|
||||
</div>
|
||||
<div />
|
||||
</section>
|
||||
|
||||
<section className="copyright">{this.props.config.copyright}</section>
|
||||
</footer>
|
||||
);
|
||||
|
|
|
|||
|
|
@ -5,13 +5,21 @@
|
|||
"previous": "Previous",
|
||||
"tagline": "Documentation on Build Rig",
|
||||
"docs": {
|
||||
"args": {
|
||||
"title": "Command line arguments",
|
||||
"sidebar_label": "Command line arguments"
|
||||
},
|
||||
"composition": {
|
||||
"title": "Composition of Tasks",
|
||||
"sidebar_label": "Composition of Tasks"
|
||||
"title": "Composition of tasks",
|
||||
"sidebar_label": "Composition of tasks"
|
||||
},
|
||||
"doc-start": {
|
||||
"title": "Getting Started with Build",
|
||||
"sidebar_label": "Getting Started"
|
||||
},
|
||||
"logging": {
|
||||
"title": "Logging",
|
||||
"sidebar_label": "Logging"
|
||||
}
|
||||
},
|
||||
"links": {
|
||||
|
|
@ -19,7 +27,7 @@
|
|||
"Help": "Help"
|
||||
},
|
||||
"categories": {
|
||||
"Create SDX App": "Create SDX App"
|
||||
"Documentation": "Documentation"
|
||||
}
|
||||
},
|
||||
"pages-strings": {
|
||||
|
|
|
|||
|
|
@ -4,9 +4,7 @@
|
|||
"scripts": {
|
||||
"examples": "docusaurus-examples",
|
||||
"start": "docusaurus-start",
|
||||
"build": "docusaurus-build",
|
||||
"publish-gh-pages": "docusaurus-publish",
|
||||
"write-translations": "docusaurus-write-translations",
|
||||
"build": "docusaurus-build && cpx \"build/build-rig/**/*\" ../../../docs",
|
||||
"version": "docusaurus-version",
|
||||
"rename-version": "docusaurus-rename-version"
|
||||
},
|
||||
|
|
@ -26,6 +24,7 @@
|
|||
"@babel/register": "^7.0.0",
|
||||
"@babel/traverse": "^7.0.0",
|
||||
"@babel/types": "^7.1.2",
|
||||
"cpx": "^1.5.0",
|
||||
"docusaurus": "^1.5.1"
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -62,8 +62,7 @@ class HomeSplash extends React.Component {
|
|||
<div className="inner">
|
||||
<ProjectTitle />
|
||||
<PromoSection>
|
||||
<Button href={docUrl('doc-start.html', language)}>Getting Started</Button>
|
||||
<Button href={docUrl('notes.html', language)}>Notes</Button>
|
||||
<Button href={docUrl('doc-start.html', language)}>Let's Get Started!</Button>
|
||||
</PromoSection>
|
||||
</div>
|
||||
</SplashContainer>
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
{
|
||||
"docs": {
|
||||
"Create SDX App": ["doc-start", "notes"]
|
||||
"Documentation": ["doc-start", "composition", "logging", "args"]
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -23,10 +23,10 @@ const users = [
|
|||
const siteConfig = {
|
||||
title: 'Build Rig', // Title for your website.
|
||||
tagline: 'Documentation on Build Rig',
|
||||
url: 'https://sdx-cli.azurewebsites.net', // Your website URL
|
||||
baseUrl: '/', // Base URL for your project */
|
||||
url: 'https://kenotron.github.io', // Your website URL
|
||||
baseUrl: '/build-rig', // Base URL for your project */
|
||||
projectName: 'build-rig',
|
||||
organizationName: 'microsoft',
|
||||
organizationName: 'kenotron',
|
||||
|
||||
// For no header links in the top nav bar -> headerLinks: [],
|
||||
headerLinks: [{ doc: 'doc-start', label: 'Documentation' }, { page: 'help', label: 'Help' }],
|
||||
|
|
@ -45,22 +45,8 @@ const siteConfig = {
|
|||
secondaryColor: '#205C3B'
|
||||
},
|
||||
|
||||
/* Custom fonts for website */
|
||||
/*
|
||||
fonts: {
|
||||
myFont: [
|
||||
"Times New Roman",
|
||||
"Serif"
|
||||
],
|
||||
myOtherFont: [
|
||||
"-apple-system",
|
||||
"system-ui"
|
||||
]
|
||||
},
|
||||
*/
|
||||
|
||||
// This copyright info is used in /core/Footer.js and blog RSS/Atom feeds.
|
||||
copyright: `Copyright © ${new Date().getFullYear()} Microsoft`,
|
||||
copyright: `Copyright © ${new Date().getFullYear()}`,
|
||||
|
||||
highlight: {
|
||||
// Highlight.js theme to use for syntax highlighting in code blocks.
|
||||
|
|
@ -87,7 +73,7 @@ const siteConfig = {
|
|||
|
||||
// You may provide arbitrary config keys to be used as needed by your
|
||||
// template. For example, if you need your repo's URL...
|
||||
editUrl: 'https://uifabric.visualstudio.com/UI%20Fabric/_git/sdx-cli?version=GBmaster&path=%2Fpackages%2Fdocumentation%2Fdocs%2F'
|
||||
editUrl: 'https://github.com/kenotron/build-rig/tree/master/packages/documentation/docs'
|
||||
};
|
||||
|
||||
module.exports = siteConfig;
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче