[ci skip] Updates
This commit is contained in:
@@ -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/c104ad2/src/cli/tasks.ts#L14">cli/tasks.ts:14</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4b22ba1/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/c104ad2/src/cli/tasks.ts#L15">cli/tasks.ts:15</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4b22ba1/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/c104ad2/src/cli/tasks.ts#L16">cli/tasks.ts:16</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4b22ba1/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/c104ad2/src/cli/utils.ts#L8">cli/utils.ts:8</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4b22ba1/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/c104ad2/src/cli/utils.ts#L9">cli/utils.ts:9</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4b22ba1/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/c104ad2/src/cli/tasks.ts#L170">cli/tasks.ts:170</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4b22ba1/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/c104ad2/src/cli/utils.ts#L37">cli/utils.ts:37</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4b22ba1/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/c104ad2/src/cli/utils.ts#L12">cli/utils.ts:12</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4b22ba1/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/c104ad2/src/cli/utils.ts#L41">cli/utils.ts:41</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4b22ba1/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/c104ad2/src/cli/utils.ts#L52">cli/utils.ts:52</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4b22ba1/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/c104ad2/src/cli/utils.ts#L29">cli/utils.ts:29</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4b22ba1/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/c104ad2/src/cli/utils.ts#L34">cli/utils.ts:34</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4b22ba1/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/c104ad2/src/cli/tasks.ts#L192">cli/tasks.ts:192</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4b22ba1/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/c104ad2/src/lib/async.ts#L20">lib/async.ts:20</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4b22ba1/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/c104ad2/src/cli/args.ts#L6">cli/args.ts:6</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4b22ba1/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/c104ad2/src/cli/tasks.ts#L21">cli/tasks.ts:21</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4b22ba1/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/c104ad2/src/lib/number.ts#L22">lib/number.ts:22</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4b22ba1/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/c104ad2/src/cli/tasks.ts#L76">cli/tasks.ts:76</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4b22ba1/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/c104ad2/src/cli/utils.ts#L71">cli/utils.ts:71</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4b22ba1/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/c104ad2/src/cli/tasks.ts#L156">cli/tasks.ts:156</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4b22ba1/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/c104ad2/src/cli/tasks.ts#L88">cli/tasks.ts:88</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4b22ba1/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/c104ad2/src/cli/utils.ts#L57">cli/utils.ts:57</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4b22ba1/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/c104ad2/src/cli/tasks.ts#L108">cli/tasks.ts:108</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4b22ba1/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/c104ad2/src/cli/inquire.ts#L5">cli/inquire.ts:5</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4b22ba1/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/c104ad2/src/cli/tasks.ts#L130">cli/tasks.ts:130</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4b22ba1/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/c104ad2/src/cli/utils.ts#L100">cli/utils.ts:100</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4b22ba1/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/c104ad2/src/lib/number.ts#L46">lib/number.ts:46</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4b22ba1/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/c104ad2/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/4b22ba1/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/c104ad2/src/lib/hash.ts#L21">lib/hash.ts:21</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4b22ba1/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/c104ad2/src/lib/hash.ts#L39">lib/hash.ts:39</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4b22ba1/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/c104ad2/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/4b22ba1/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/c104ad2/src/cli/utils.ts#L63">cli/utils.ts:63</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4b22ba1/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/c104ad2/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/4b22ba1/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/c104ad2/src/cli/tasks.ts#L187">cli/tasks.ts:187</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4b22ba1/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/c104ad2/src/cli/tasks.ts#L188">cli/tasks.ts:188</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4b22ba1/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/c104ad2/src/cli/tasks.ts#L189">cli/tasks.ts:189</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4b22ba1/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/c104ad2/src/cli/tasks.ts#L190">cli/tasks.ts:190</a></li>
|
||||
<li>Defined in <a href="https://github.com/bitjson/typescript-starter/blob/4b22ba1/src/cli/tasks.ts#L190">cli/tasks.ts:190</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
||||
32
index.html
32
index.html
@@ -78,7 +78,7 @@
|
||||
<h2>Start Now</h2>
|
||||
</a>
|
||||
<p>Run one simple command to install and use the interactive project generator. You'll need <a href="https://nodejs.org/">Node</a> <code>v10</code> or later.</p>
|
||||
<pre><code class="language-bash">npx typescript-starter</code></pre>
|
||||
<pre><code class="language-sh">npx typescript-starter</code></pre>
|
||||
<p>The interactive CLI will help you create and configure your project automatically.</p>
|
||||
<blockquote>
|
||||
<p>Since this repo includes <a href="./src/cli">the CLI and it's tests</a>, you'll only need to fork or clone this project if you want to contribute. If you find this project useful, please consider <a href="https://github.com/bitjson/typescript-starter/stargazers">leaving a star</a> so others can find it. Thanks!</p>
|
||||
@@ -117,10 +117,12 @@
|
||||
<a href="#development-zen" id="development-zen" style="color: inherit; text-decoration: none;">
|
||||
<h2>Development zen</h2>
|
||||
</a>
|
||||
<p>To start working, run the <code>watch</code> task using <a href="https://docs.npmjs.com/getting-started/what-is-npm"><code>npm</code></a> or <a href="https://yarnpkg.com/"><code>yarn</code></a>.</p>
|
||||
<pre><code class="language-bash">npm run watch</code></pre>
|
||||
<p>This starter includes a watch task which makes development faster and more interactive. It's particularly helpful for <a href="https://en.wikipedia.org/wiki/Test-driven_development">TDD</a>/<a href="https://en.wikipedia.org/wiki/Behavior-driven_development">BDD</a> workflows.</p>
|
||||
<p>The watch task will build and watch the entire project for changes (to both the library source files and test source files). As you develop, you can add tests for new functionality – which will initially fail – before developing the new functionality. Each time you save, any changes will be rebuilt and retested.</p>
|
||||
<p>To start working, run the <code>watch:build</code> task using <a href="https://docs.npmjs.com/getting-started/what-is-npm"><code>npm</code></a> or <a href="https://yarnpkg.com/"><code>yarn</code></a>.</p>
|
||||
<pre><code class="language-sh">npm run watch:build</code></pre>
|
||||
<p>In another terminal tab/window, run the <code>watch:test</code> task:</p>
|
||||
<pre><code class="language-sh">npm run watch:<span class="hljs-built_in">test</span></code></pre>
|
||||
<p>These watch tasks make development much faster and more interactive. They're particularly helpful for <a href="https://en.wikipedia.org/wiki/Test-driven_development">TDD</a>/<a href="https://en.wikipedia.org/wiki/Behavior-driven_development">BDD</a> workflows.</p>
|
||||
<p>These watch tasks will build and watch the entire project for changes (to both the library source files and test source files). As you develop, you can add tests for new functionality – which will initially fail – before developing the new functionality. Each time you save, any changes will be rebuilt and retested.</p>
|
||||
<p align="center">
|
||||
<!-- PR request: capture the magic of using a test-running watch task for development -->
|
||||
<img alt="typescript-starter's watch task" src="https://user-images.githubusercontent.com/904007/37270842-c05f5192-25a6-11e8-83bb-1981ae48e38e.png">
|
||||
@@ -135,12 +137,12 @@
|
||||
<h2>Auto-fix and format project</h2>
|
||||
</a>
|
||||
<p>To automatically fix <code>eslint</code> and <code>prettier</code> formatting issues, run:</p>
|
||||
<pre><code>npm <span class="hljs-keyword">run</span><span class="bash"> fix</span></code></pre>
|
||||
<pre><code class="language-sh">npm run fix</code></pre>
|
||||
<a href="#view-test-coverage" id="view-test-coverage" style="color: inherit; text-decoration: none;">
|
||||
<h2>View test coverage</h2>
|
||||
</a>
|
||||
<p>To generate and view test coverage, run:</p>
|
||||
<pre><code class="language-bash">npm run cov</code></pre>
|
||||
<pre><code class="language-sh">npm run cov</code></pre>
|
||||
<p>This will create an HTML report of test coverage – source-mapped back to Typescript – and open it in your default browser.</p>
|
||||
<p align="center">
|
||||
<img height="600" alt="source-mapped typescript test coverage example" src="https://cloud.githubusercontent.com/assets/904007/22909301/5164c83a-f221-11e6-9d7c-72c924fde450.png">
|
||||
@@ -149,34 +151,34 @@
|
||||
<h2>Generate your API docs</h2>
|
||||
</a>
|
||||
<p>The src folder is analyzed and documentation is automatically generated using <a href="https://github.com/TypeStrong/typedoc">TypeDoc</a>.</p>
|
||||
<pre><code class="language-bash">npm run doc</code></pre>
|
||||
<pre><code class="language-sh">npm run doc</code></pre>
|
||||
<p>This command generates API documentation for your library in HTML format and opens it in a browser.</p>
|
||||
<p>Since types are tracked by Typescript, there's no need to indicate types in JSDoc format. For more information, see the <a href="http://typedoc.org/guides/doccomments/">TypeDoc documentation</a>.</p>
|
||||
<p>To generate and publish your documentation to <a href="https://pages.github.com/">GitHub Pages</a> use the following command:</p>
|
||||
<pre><code class="language-bash">npm run doc:publish</code></pre>
|
||||
<pre><code class="language-sh">npm run doc:publish</code></pre>
|
||||
<p>Once published, your documentation should be available at the proper GitHub Pages URL for your repo. See <a href="https://bitjson.github.io/typescript-starter/"><code>typescript-starter</code>'s GitHub Pages</a> for an example.</p>
|
||||
<p align="center">
|
||||
<img height="500" alt="TypeDoc documentation example" src="https://cloud.githubusercontent.com/assets/904007/22909419/085b9e38-f222-11e6-996e-c7a86390478c.png">
|
||||
</p>
|
||||
<p>For more advanced documentation generation, you can provide your own <a href="http://typedoc.org/guides/themes/">TypeDoc theme</a>, or <a href="https://blog.cloudflare.com/generating-documentation-for-typescript-projects/">build your own documentation</a> using the JSON TypeDoc export:</p>
|
||||
<pre><code class="language-bash">npm run doc:json</code></pre>
|
||||
<pre><code class="language-sh">npm run doc:json</code></pre>
|
||||
<a href="#bump-version-update-changelog-commit-amp-tag-release" id="bump-version-update-changelog-commit-amp-tag-release" style="color: inherit; text-decoration: none;">
|
||||
<h2>Bump version, update changelog, commit, & tag release</h2>
|
||||
</a>
|
||||
<p>It's recommended that you install <a href="https://github.com/commitizen/cz-cli"><code>commitizen</code></a> to make commits to your project.</p>
|
||||
<pre><code class="language-bash">npm install -g commitizen
|
||||
<pre><code class="language-sh">npm install -g commitizen
|
||||
|
||||
<span class="hljs-comment"># commit your changes:</span>
|
||||
git cz</code></pre>
|
||||
<p>This project is tooled for <a href="https://github.com/conventional-changelog/conventional-changelog">conventional changelog</a> to make managing releases easier. See the <a href="https://github.com/conventional-changelog/standard-version">standard-version</a> documentation for more information on the workflow, or <a href="CHANGELOG.md"><code>CHANGELOG.md</code></a> for an example.</p>
|
||||
<pre><code class="language-bash"><span class="hljs-comment"># bump package.json version, update CHANGELOG.md, git tag the release</span>
|
||||
<pre><code class="language-sh"><span class="hljs-comment"># bump package.json version, update CHANGELOG.md, git tag the release</span>
|
||||
npm run version</code></pre>
|
||||
<p>You may find a tool like <a href="https://github.com/bitjson/wip"><strong><code>wip</code></strong></a> helpful for managing work in progress before you're ready to create a meaningful commit.</p>
|
||||
<a href="#one-step-publish-preparation-script" id="one-step-publish-preparation-script" style="color: inherit; text-decoration: none;">
|
||||
<h2>One-step publish preparation script</h2>
|
||||
</a>
|
||||
<p>Bringing together many of the steps above, this repo includes a one-step release preparation command.</p>
|
||||
<pre><code class="language-bash"><span class="hljs-comment"># Prepare a standard release:</span>
|
||||
<pre><code class="language-sh"><span class="hljs-comment"># Prepare a standard release:</span>
|
||||
npm run prepare-release</code></pre>
|
||||
<p>This command runs the following tasks:</p>
|
||||
<ul>
|
||||
@@ -187,10 +189,10 @@ npm run prepare-release</code></pre>
|
||||
<li><code>version</code>: bump package.json version, update CHANGELOG.md, and git tag the release</li>
|
||||
</ul>
|
||||
<p>When the script finishes, it will log the final command needed to push the release commit to the repo and publish the package on the <code>npm</code> registry:</p>
|
||||
<pre><code class="language-bash">git push --follow-tags origin master; npm publish</code></pre>
|
||||
<pre><code class="language-sh">git push --follow-tags origin master; npm publish</code></pre>
|
||||
<p>Look over the release if you'd like, then execute the command to publish everything.</p>
|
||||
<p>You can also prepare a non-standard release:</p>
|
||||
<pre><code class="language-bash"><span class="hljs-comment"># Or a non-standard release:</span>
|
||||
<pre><code class="language-sh"><span class="hljs-comment"># Or a non-standard release:</span>
|
||||
|
||||
<span class="hljs-comment"># Reset the repo to the latest commit and build everything</span>
|
||||
npm run hard-reset && npm run <span class="hljs-built_in">test</span> && npm run cov:check && npm run doc:html
|
||||
|
||||
Reference in New Issue
Block a user