Skip to content

Commit

Permalink
v1.2.5 docs: Add label parameter to Command Help section (#33) f464953
Browse files Browse the repository at this point in the history
  • Loading branch information
jaywcjlove committed Dec 28, 2023
1 parent e346da0 commit 43b420e
Show file tree
Hide file tree
Showing 9 changed files with 26 additions and 22 deletions.
4 changes: 3 additions & 1 deletion CONTRIBUTORS.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions badges-classic.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions badges.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 10 additions & 8 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -196,14 +196,15 @@ <h2 id="command-help"><a aria-hidden="true" tabindex="-1" href="#command-help" c
</span><span class="code-line line-number" line="9"> <span class="token parameter variable">--style</span> Badges style: flat, flat-square.
</span><span class="code-line line-number" line="10"> <span class="token parameter variable">--type</span> Coverage type: lines, statements, functions, branches.
</span><span class="code-line line-number" line="11"> <span class="token parameter variable">--icon</span> Path to icon <span class="token function">file</span>
</span><span class="code-line line-number" line="12">
</span><span class="code-line line-number" line="13">Example:
</span><span class="code-line line-number" line="14">
</span><span class="code-line line-number" line="15"> <span class="token function">npm</span> coverage-badges-cli <span class="token parameter variable">--output</span> coverage/badges.svg
</span><span class="code-line line-number" line="16"> <span class="token function">npm</span> coverage-badges-cli <span class="token parameter variable">--style</span> plastic
</span><span class="code-line line-number" line="17"> <span class="token function">npm</span> coverage-badges-cli <span class="token parameter variable">--source</span> coverage/coverage-summary.json
</span><span class="code-line line-number" line="18"> <span class="token function">npm</span> coverage-badges-cli <span class="token parameter variable">--type</span> lines
</span><span class="code-line line-number" line="19"> <span class="token function">npm</span> coverage-badges-cli <span class="token parameter variable">--icon</span> my-icon.svg
</span><span class="code-line line-number" line="12"> <span class="token parameter variable">--label</span> The left label of the badge, usually static <span class="token punctuation">(</span>default <span class="token variable"><span class="token variable">`</span>coverage<span class="token variable">`</span></span><span class="token punctuation">)</span>.
</span><span class="code-line line-number" line="13">
</span><span class="code-line line-number" line="14">Example:
</span><span class="code-line line-number" line="15">
</span><span class="code-line line-number" line="16"> <span class="token function">npm</span> coverage-badges-cli <span class="token parameter variable">--output</span> coverage/badges.svg
</span><span class="code-line line-number" line="17"> <span class="token function">npm</span> coverage-badges-cli <span class="token parameter variable">--style</span> plastic
</span><span class="code-line line-number" line="18"> <span class="token function">npm</span> coverage-badges-cli <span class="token parameter variable">--source</span> coverage/coverage-summary.json
</span><span class="code-line line-number" line="19"> <span class="token function">npm</span> coverage-badges-cli <span class="token parameter variable">--type</span> lines
</span><span class="code-line line-number" line="20"> <span class="token function">npm</span> coverage-badges-cli <span class="token parameter variable">--icon</span> my-icon.svg
</span></code><input type="hidden" value="Usage: coverage-badges [options] [--help|h]
Options:
Expand All @@ -215,6 +216,7 @@ <h2 id="command-help"><a aria-hidden="true" tabindex="-1" href="#command-help" c
--style Badges style: flat, flat-square.
--type Coverage type: lines, statements, functions, branches.
--icon Path to icon file
--label The left label of the badge, usually static (default &#x60;coverage&#x60;).
Example:
Expand Down
2 changes: 1 addition & 1 deletion lcov-report/action.ts.html
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ <h1><a href="index.html">All files</a> action.ts</h1>
<div class='footer quiet pad2 space-top1 center small'>
Code coverage generated by
<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
at 2023-12-13T02:41:56.910Z
at 2023-12-28T22:04:17.821Z
</div>
<script src="prettify.js"></script>
<script>
Expand Down
2 changes: 1 addition & 1 deletion lcov-report/badges.ts.html
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ <h1><a href="index.html">All files</a> badges.ts</h1>
<div class='footer quiet pad2 space-top1 center small'>
Code coverage generated by
<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
at 2023-12-13T02:41:56.910Z
at 2023-12-28T22:04:17.821Z
</div>
<script src="prettify.js"></script>
<script>
Expand Down
2 changes: 1 addition & 1 deletion lcov-report/create.ts.html
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ <h1><a href="index.html">All files</a> create.ts</h1>
<div class='footer quiet pad2 space-top1 center small'>
Code coverage generated by
<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
at 2023-12-13T02:41:56.910Z
at 2023-12-28T22:04:17.821Z
</div>
<script src="prettify.js"></script>
<script>
Expand Down
2 changes: 1 addition & 1 deletion lcov-report/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ <h1>All files</h1>
<div class='footer quiet pad2 space-top1 center small'>
Code coverage generated by
<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
at 2023-12-13T02:41:56.910Z
at 2023-12-28T22:04:17.821Z
</div>
<script src="prettify.js"></script>
<script>
Expand Down
2 changes: 1 addition & 1 deletion lcov-report/index.ts.html
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ <h1><a href="index.html">All files</a> index.ts</h1>
<div class='footer quiet pad2 space-top1 center small'>
Code coverage generated by
<a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
at 2023-12-13T02:41:56.910Z
at 2023-12-28T22:04:17.821Z
</div>
<script src="prettify.js"></script>
<script>
Expand Down

0 comments on commit 43b420e

Please sign in to comment.