[ci skip] Updates
This commit is contained in:
Jason Dreyzehner
@@ -89,7 +89,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">email<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "YOUR_EMAIL"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/cli/tasks.ts#L14">cli/tasks.ts:14</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/cli/tasks.ts#L14">cli/tasks.ts:14</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -99,7 +99,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "YOUR_NAME"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/cli/tasks.ts#L15">cli/tasks.ts:15</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/cli/tasks.ts#L15">cli/tasks.ts:15</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -109,7 +109,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">username<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "YOUR_GITHUB_USER_NAME"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/cli/tasks.ts#L16">cli/tasks.ts:16</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/cli/tasks.ts#L16">cli/tasks.ts:16</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
||||
@@ -88,7 +88,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">Npm<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "npm"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/cli/utils.ts#L8">cli/utils.ts:8</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/cli/utils.ts#L8">cli/utils.ts:8</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -98,7 +98,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">Yarn<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "yarn"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/cli/utils.ts#L9">cli/utils.ts:9</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/cli/utils.ts#L9">cli/utils.ts:9</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
||||
64
globals.html
64
globals.html
@@ -129,7 +129,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">Tasks<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>cloneRepo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>repoInfo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>branch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>repo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span>, workingDirectory<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, dir<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span>commitHash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>gitHistoryDir<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>initialCommit<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>hash<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, projectDir<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span>install<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span>runner<span class="tsd-signature-symbol">: </span><a href="enums/runner.html" class="tsd-signature-type">Runner</a>, projectDir<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> }</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/cli/tasks.ts#L170">cli/tasks.ts:170</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/cli/tasks.ts#L170">cli/tasks.ts:170</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
@@ -230,7 +230,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">Typescript<wbr>Starter<wbr>Args<wbr>Options<span class="tsd-signature-symbol">:</span> <a href="globals.html#typescriptstarteruseroptions" class="tsd-signature-type">TypescriptStarterUserOptions</a><span class="tsd-signature-symbol"> | </span><a href="globals.html#typescriptstarterrequiredconfig" class="tsd-signature-type">TypescriptStarterRequiredConfig</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/cli/utils.ts#L37">cli/utils.ts:37</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/cli/utils.ts#L37">cli/utils.ts:37</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -240,7 +240,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">Typescript<wbr>StarterCLIOptions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>appveyor<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>circleci<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>cspell<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>description<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>domDefinitions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>editorconfig<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>functional<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>install<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>nodeDefinitions<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>projectName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>runner<span class="tsd-signature-symbol">: </span><a href="enums/runner.html" class="tsd-signature-type">Runner</a><span class="tsd-signature-symbol">; </span>strict<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>travis<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>vscode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> }</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/cli/utils.ts#L12">cli/utils.ts:12</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/cli/utils.ts#L12">cli/utils.ts:12</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
@@ -297,7 +297,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">Typescript<wbr>Starter<wbr>Inferred<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>email<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>fullName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>githubUsername<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>repoInfo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span>branch<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>repo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span><span class="tsd-signature-symbol">; </span>workingDirectory<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/cli/utils.ts#L41">cli/utils.ts:41</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/cli/utils.ts#L41">cli/utils.ts:41</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
@@ -335,7 +335,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">Typescript<wbr>Starter<wbr>Options<span class="tsd-signature-symbol">:</span> <a href="globals.html#typescriptstarterclioptions" class="tsd-signature-type">TypescriptStarterCLIOptions</a><span class="tsd-signature-symbol"> & </span><a href="globals.html#typescriptstarterinferredoptions" class="tsd-signature-type">TypescriptStarterInferredOptions</a><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{}</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/cli/utils.ts#L52">cli/utils.ts:52</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/cli/utils.ts#L52">cli/utils.ts:52</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -345,7 +345,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">Typescript<wbr>Starter<wbr>Required<wbr>Config<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>install<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span>starterVersion<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/cli/utils.ts#L29">cli/utils.ts:29</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/cli/utils.ts#L29">cli/utils.ts:29</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
@@ -366,7 +366,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">Typescript<wbr>Starter<wbr>User<wbr>Options<span class="tsd-signature-symbol">:</span> <a href="globals.html#typescriptstarterclioptions" class="tsd-signature-type">TypescriptStarterCLIOptions</a><span class="tsd-signature-symbol"> & </span><a href="globals.html#typescriptstarterrequiredconfig" class="tsd-signature-type">TypescriptStarterRequiredConfig</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/cli/utils.ts#L34">cli/utils.ts:34</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/cli/utils.ts#L34">cli/utils.ts:34</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -383,7 +383,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/cli/tasks.ts#L192">cli/tasks.ts:192</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/cli/tasks.ts#L192">cli/tasks.ts:192</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -406,7 +406,7 @@
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/lib/async.ts#L20">lib/async.ts:20</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/lib/async.ts#L20">lib/async.ts:20</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -441,7 +441,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/cli/args.ts#L6">cli/args.ts:6</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/cli/args.ts#L6">cli/args.ts:6</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="globals.html#typescriptstarterargsoptions" class="tsd-signature-type">TypescriptStarterArgsOptions</a><span class="tsd-signature-symbol">></span></h4>
|
||||
@@ -458,7 +458,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/cli/tasks.ts#L21">cli/tasks.ts:21</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/cli/tasks.ts#L21">cli/tasks.ts:21</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -484,7 +484,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/lib/number.ts#L22">lib/number.ts:22</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/lib/number.ts#L22">lib/number.ts:22</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -535,7 +535,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/cli/tasks.ts#L76">cli/tasks.ts:76</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/cli/tasks.ts#L76">cli/tasks.ts:76</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -558,7 +558,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/cli/utils.ts#L71">cli/utils.ts:71</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/cli/utils.ts#L71">cli/utils.ts:71</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -581,7 +581,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/cli/tasks.ts#L156">cli/tasks.ts:156</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/cli/tasks.ts#L156">cli/tasks.ts:156</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -625,7 +625,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/cli/tasks.ts#L88">cli/tasks.ts:88</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/cli/tasks.ts#L88">cli/tasks.ts:88</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -648,7 +648,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/cli/utils.ts#L57">cli/utils.ts:57</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/cli/utils.ts#L57">cli/utils.ts:57</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -671,7 +671,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/cli/tasks.ts#L108">cli/tasks.ts:108</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/cli/tasks.ts#L108">cli/tasks.ts:108</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -694,7 +694,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/cli/inquire.ts#L5">cli/inquire.ts:5</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/cli/inquire.ts#L5">cli/inquire.ts:5</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="globals.html#typescriptstarterclioptions" class="tsd-signature-type">TypescriptStarterCLIOptions</a><span class="tsd-signature-symbol">></span></h4>
|
||||
@@ -711,7 +711,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/cli/tasks.ts#L130">cli/tasks.ts:130</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/cli/tasks.ts#L130">cli/tasks.ts:130</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -734,7 +734,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/cli/utils.ts#L100">cli/utils.ts:100</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/cli/utils.ts#L100">cli/utils.ts:100</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -763,7 +763,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/lib/number.ts#L46">lib/number.ts:46</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/lib/number.ts#L46">lib/number.ts:46</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -817,7 +817,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/cli/typescript-starter.ts#L12">cli/typescript-starter.ts:12</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/cli/typescript-starter.ts#L12">cli/typescript-starter.ts:12</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -840,7 +840,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/lib/hash.ts#L21">lib/hash.ts:21</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/lib/hash.ts#L21">lib/hash.ts:21</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -883,7 +883,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/lib/hash.ts#L39">lib/hash.ts:39</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/lib/hash.ts#L39">lib/hash.ts:39</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
@@ -924,7 +924,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/cli/typescript-starter.ts#L22">cli/typescript-starter.ts:22</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/cli/typescript-starter.ts#L22">cli/typescript-starter.ts:22</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -1017,7 +1017,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/cli/utils.ts#L63">cli/utils.ts:63</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/cli/utils.ts#L63">cli/utils.ts:63</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -1040,7 +1040,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/cli/typescript-starter.ts#L15">cli/typescript-starter.ts:15</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/cli/typescript-starter.ts#L15">cli/typescript-starter.ts:15</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
@@ -1065,7 +1065,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<div class="tsd-signature tsd-kind-icon">Live<wbr>Tasks<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/cli/tasks.ts#L187">cli/tasks.ts:187</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/cli/tasks.ts#L187">cli/tasks.ts:187</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
|
||||
@@ -1074,7 +1074,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<div class="tsd-signature tsd-kind-icon">clone<wbr>Repo<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">(Anonymous function)</span><span class="tsd-signature-symbol"> = cloneRepo(execa)</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/cli/tasks.ts#L188">cli/tasks.ts:188</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/cli/tasks.ts#L188">cli/tasks.ts:188</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -1084,7 +1084,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<div class="tsd-signature tsd-kind-icon">initial<wbr>Commit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">(Anonymous function)</span><span class="tsd-signature-symbol"> = initialCommit(execa)</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/cli/tasks.ts#L189">cli/tasks.ts:189</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/cli/tasks.ts#L189">cli/tasks.ts:189</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -1094,7 +1094,7 @@ asyncABC().then(<span class="hljs-built_in">console</span>.log);
|
||||
<div class="tsd-signature tsd-kind-icon">install<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">(Anonymous function)</span><span class="tsd-signature-symbol"> = install(execa)</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/b6875c2/src/cli/tasks.ts#L190">cli/tasks.ts:190</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/c16e858/src/cli/tasks.ts#L190">cli/tasks.ts:190</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
||||
14
index.html
14
index.html
@@ -287,6 +287,9 @@ npm run doc:publish</code></pre>
|
||||
<span class="hljs-attr">npm</span> <span class="hljs-string">install</span>
|
||||
<span class="hljs-attr">npm</span> <span class="hljs-string">test</span>
|
||||
<span class="hljs-attr">npm</span> <span class="hljs-string">link</span></code></pre>
|
||||
<a href="#manual-testing" id="manual-testing" style="color: inherit; text-decoration: none;">
|
||||
<h3>Manual testing</h3>
|
||||
</a>
|
||||
<p>To manually test the CLI, you can use the <code>TYPESCRIPT_STARTER_REPO_URL</code> environment variable to test a clone from your local repo. Run <code>npm run build:main -- -w</code> as you're developing, then in a different testing directory:</p>
|
||||
<pre><code><span class="hljs-built_in">mkdir</span> typescript-starter-testing
|
||||
<span class="hljs-built_in">cd</span> typescript-starter-testing
|
||||
@@ -294,7 +297,18 @@ TYPESCRIPT_STARTER_REPO_URL='/local/<span class="hljs-built_in">path</span>
|
||||
<p>You can also set <code>TYPESCRIPT_STARTER_REPO_URL</code> to any valid Git URL, such as your fork of this repo:</p>
|
||||
<pre><code><span class="hljs-attr">TYPESCRIPT_STARTER_REPO_URL</span>=<span class="hljs-string">'https://github.com/YOUR_USERNAME/typescript-starter.git'</span> typescript-starter</code></pre>
|
||||
<p>If <code>TYPESCRIPT_STARTER_REPO_BRANCH</code> is not provided, it will default to <code>master</code>.</p>
|
||||
<a href="#debug-in-vs-code" id="debug-in-vs-code" style="color: inherit; text-decoration: none;">
|
||||
<h3>Debug in VS Code</h3>
|
||||
</a>
|
||||
<p>If you're using <a href="https://code.visualstudio.com/">VS Code</a>, the <code>Debug CLI</code> launch configuration also allows you to immediately build and step through execution of the CLI.</p>
|
||||
<a href="#integration-test-result-diffs" id="integration-test-result-diffs" style="color: inherit; text-decoration: none;">
|
||||
<h3>Integration Test Result Diffs</h3>
|
||||
</a>
|
||||
<p>You can compare the integration test results before and after a change by running <code>check-cli</code> before and after applying your changes:</p>
|
||||
<pre><code class="language-sh">npm run check-cli</code></pre>
|
||||
<p>Each time you run <code>check-cli</code>, the test results will be committed to the <code>diff</code> directory, allowing you to easily review the differences with <code>git diff HEAD</code> or an interactive Git client like <a href="https://desktop.github.com/">GitHub for Desktop</a> or <a href="https://www.sourcetreeapp.com/">SourceTree</a>.</p>
|
||||
<p>If you already have changes in the working directory, try:</p>
|
||||
<pre><code class="language-sh">git stash && npm run check-cli && git stash pop && npm run check-cli</code></pre>
|
||||
</details>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user