doc(plugins/code): update

This commit is contained in:
lowlighter
2022-01-15 21:19:37 -05:00
parent c3285f4283
commit 4a8f377685
2 changed files with 56 additions and 36 deletions

View File

@@ -1,5 +1,13 @@
name: "♐ Code snippet of the day"
category: github
description: |
This plugin displays a random code snippet from your recent activity history.
> ⚠️ When improperly configured, this plugin could display private code.
> If you work with sensitive data or company code, it is advised to keep this plugin disabled.
> Use at your own risk, *metrics* and its authors cannot be held responsible for any resulting code leaks.
examples:
default: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.code.svg
index: 12
supports:
- user
@@ -8,49 +16,45 @@ scopes:
- public_access
inputs:
# Enable or disable plugin
plugin_code:
description: Display a random code snippet from recent activity
description: Enable code plugin
type: boolean
default: no
# Maximum number of lines that a code snippet can contain
plugin_code_lines:
description: Maximum number of line that a code snippet can contain
description: Display limit for code snippets
type: number
default: 12
# Number of activity events to load
# A high number will consume more requests
plugin_code_load:
description: Number of events to load
description: Events to load
type: number
default: 100
min: 100
max: 1000
# Set events visibility (use this to restrict events when using a "repo" token)
plugin_code_visibility:
description: Set events visibility
description: |
Events visibility
Lets you hide private activity when using a `repo` scope token
type: string
default: public
values:
- public
- all
# List of repositories that will be skipped
plugin_code_skipped:
description: Repositories to skip
description: Skipped repositories
type: array
format: comma-separated
default: ""
example: my-repo-1, my-repo-2, owner/repo-3, ...
inherits: repositories_skipped
# Restrict code snippet languages
# These are guessed through linguist
plugin_code_languages:
description: Restrict code snippet languages
extras: yes
description: Restrict display to specific languages
type: array
format: comma-separated
default: ""