sudacode/metrics
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

doc(plugins/lines): update

Browse Source
This commit is contained in:
lowlighter
2022-01-15 20:18:14 -05:00
parent 42798eddca
commit e29de7bf4c
2 changed files with 30 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
source/plugins/lines/README.md
View File

@@ -1,15 +1,28 @@
### 👨‍💻 Lines of code changed
The *lines* of code plugin displays the number of lines of code you have added and removed across all of your repositories.
<!--header-->
<table>
<td align="center">
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.lines.svg">
<tr><th colspan="2"><h3>👨‍💻 Lines of code changed</h3></th></tr>
<tr><td colspan="2" align="center"><p>This plugin displays the number of lines of code you have added and removed across all of your repositories.</p>
</td></tr>
<tr>
<th rowspan="3">Supported features<br><sub><a href="metadata.yml">→ Full specification</a></sub></th>
<td><a href="/source/templates/classic"><code>📗 Classic template</code></a> <a href="/source/templates/repository"><code>📘 Repository template</code></a> <a href="/source/templates/terminal"><code>📙 Terminal template</code></a></td>
</tr>
<tr>
<td><code>👤 Users</code> <code>👥 Organizations</code> <code>📓 Repositories</code></td>
</tr>
<tr>
<td><code>🔑 (scopeless)</code> <code>read:org (optional)</code> <code>read:user (optional)</code> <code>repo (optional)</code></td>
</tr>
<tr>
<td colspan="2" align="center">
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.lines.svg" alt=""></img>
<img width="900" height="1" alt="">
</td>
</tr>
</table>
<!--/header-->
#### ➡️ Available options
## ➡️ Available options
<!--options-->
<table>
@@ -18,7 +31,7 @@ The *lines* of code plugin displays the number of lines of code you have added a
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_lines</code></td>
<td rowspan="2"><p>Display lines of code metrics</p>
<td rowspan="2"><p>Enable lines plugin</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
@@ -28,7 +41,7 @@ The *lines* of code plugin displays the number of lines of code you have added a
</tr>
<tr>
<td nowrap="nowrap"><code>plugin_lines_skipped</code></td>
<td rowspan="2"><p>Repositories to skip</p>
<td rowspan="2"><p>Skipped repositories</p>
<img width="900" height="1" alt=""></td>
</tr>
<tr>
@@ -40,9 +53,7 @@ The *lines* of code plugin displays the number of lines of code you have added a
</table>
<!--/options-->
*[→ Full specification](metadata.yml)*
#### ℹ️ Examples workflows
## ℹ️ Examples workflows
<!--examples-->
```yaml

9
source/plugins/lines/metadata.yml
View File

@@ -1,5 +1,8 @@
name: "👨‍💻 Lines of code changed"
category: github
description: This plugin displays the number of lines of code you have added and removed across all of your repositories.
examples:
default: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.lines.svg
index: 18
supports:
- user
@@ -9,15 +12,13 @@ scopes:
- public_access
inputs:
# Enable or disable plugin
plugin_lines:
description: Display lines of code metrics
description: Enable lines plugin
type: boolean
default: no
# List of repositories that will be skipped
plugin_lines_skipped:
description: Repositories to skip
description: Skipped repositories
type: array
format: comma-separated
default: ""