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

docs(plugins): minor short description changes

Browse Source
This commit is contained in:
lowlighter
2022-01-18 12:43:17 -05:00
parent 2c8c691f53
commit 0d25bf7689
7 changed files with 17 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
source/plugins/base/README.md
View File

@@ -137,8 +137,8 @@ Broad affiliation will result in less representative metrics.</p>
</tr> </tr>
<tr> <tr>
<td nowrap="nowrap"><code>commits_authoring</code></td> <td nowrap="nowrap"><code>commits_authoring</code></td>
<td rowspan="2"><p>Name, username, email addresses that has been used for authoring commits</p> <td rowspan="2"><p>Identifiers that has been used for authoring commits</p>
<p>This setting can be used to detect commits ownerships in some plugin</p> <p>Specify names, surnames, username, email addresses that has been used in the past that can be used to detect commits ownerships in some plugins</p>
<img width="900" height="1" alt=""></td> <img width="900" height="1" alt=""></td>
</tr> </tr>
<tr> <tr>

4
source/plugins/base/metadata.yml
View File

@@ -96,9 +96,9 @@ inputs:
commits_authoring: commits_authoring:
description: | description: |
Name, username, email addresses that has been used for authoring commits Identifiers that has been used for authoring commits
This setting can be used to detect commits ownerships in some plugin Specify names, surnames, username, email addresses that has been used in the past that can be used to detect commits ownerships in some plugins
type: array type: array
format: comma-seperated format: comma-seperated
default: .user.login default: .user.login

2
source/plugins/licenses/README.md
View File

@@ -83,7 +83,7 @@ Dependencies will be analyzed by [GitHub licensed](https://github.com/github/lic
</tr> </tr>
<tr> <tr>
<td nowrap="nowrap"><code>plugin_licenses_legal</code></td> <td nowrap="nowrap"><code>plugin_licenses_legal</code></td>
<td rowspan="2"><p>Display permissions, limitations and conditions about used licenses</p> <td rowspan="2"><p>Display permissions, limitations and conditions about licenses</p>
<img width="900" height="1" alt=""></td> <img width="900" height="1" alt=""></td>
</tr> </tr>
<tr> <tr>

2
source/plugins/licenses/metadata.yml
View File

@@ -29,6 +29,6 @@ inputs:
default: no default: no
plugin_licenses_legal: plugin_licenses_legal:
description: Display permissions, limitations and conditions about used licenses description: Display permissions, limitations and conditions about licenses
type: boolean type: boolean
default: yes default: yes

8
source/plugins/starlists/README.md
View File

@@ -81,7 +81,8 @@
</tr> </tr>
<tr> <tr>
<td nowrap="nowrap"><code>plugin_starlists_ignored</code></td> <td nowrap="nowrap"><code>plugin_starlists_ignored</code></td>
<td rowspan="2"><p>Skipped star lists (case insensitive, emojis insensitive)</p> <td rowspan="2"><p>Skipped star lists</p>
<p>This is case and emojis insensitive</p>
<img width="900" height="1" alt=""></td> <img width="900" height="1" alt=""></td>
</tr> </tr>
<tr> <tr>
@@ -92,8 +93,9 @@
</tr> </tr>
<tr> <tr>
<td nowrap="nowrap"><code>plugin_starlists_only</code></td> <td nowrap="nowrap"><code>plugin_starlists_only</code></td>
<td rowspan="2"><p>Restrict display to specified star lists (case insensitive, emojis insensitive)</p> <td rowspan="2"><p>Restrict display to specified star lists</p>
<p>This option is equivalent to <code>plugin_starlists_ignored</code> with all star lists but the ones listed in this option</p> <p>This is case and emojis insensitive.
This option is equivalent to <code>plugin_starlists_ignored</code> with all star lists but the ones listed in this option</p>
<img width="900" height="1" alt=""></td> <img width="900" height="1" alt=""></td>
</tr> </tr>
<tr> <tr>

1
source/plugins/starlists/index.mjs
View File

@@ -30,7 +30,6 @@ export default async function({login, q, imports, data, account}, {enabled = fal
)) ))
const count = lists.length const count = lists.length
console.debug(`metrics/compute/${login}/plugins > starlists > found [${lists.map(({name}) => name)}]`) console.debug(`metrics/compute/${login}/plugins > starlists > found [${lists.map(({name}) => name)}]`)
console.log(">>>>> DEBUG", lists.map(({name}) => name), lists.map(({name}) => imports.stripemojis(name ?? "").trim().toLocaleLowerCase()), only, ignored)
lists = lists lists = lists
.filter(({name}) => { .filter(({name}) => {
name = imports.stripemojis(name ?? "").trim().toLocaleLowerCase() name = imports.stripemojis(name ?? "").trim().toLocaleLowerCase()

8
source/plugins/starlists/metadata.yml
View File

@@ -34,7 +34,10 @@ inputs:
default: yes default: yes
plugin_starlists_ignored: plugin_starlists_ignored:
description: Skipped star lists (case insensitive, emojis insensitive) description: |
Skipped star lists
This is case and emojis insensitive
type: array type: array
format: comma-separated format: comma-separated
default: "" default: ""
@@ -42,8 +45,9 @@ inputs:
plugin_starlists_only: plugin_starlists_only:
description: | description: |
Restrict display to specified star lists (case insensitive, emojis insensitive) Restrict display to specified star lists
This is case and emojis insensitive.
This option is equivalent to `plugin_starlists_ignored` with all star lists but the ones listed in this option This option is equivalent to `plugin_starlists_ignored` with all star lists but the ones listed in this option
type: array type: array
format: comma-separated format: comma-separated