metrics/source/plugins/languages/metadata.yml at master · StartForKiller/metrics · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
name: 🈷️ Languages activity
category: github
description: |
  This plugin can display which languages you use across all repositories you contributed to.
examples:
  +indepth analysis (clone and analyze repositories): https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.languages.indepth.svg
  +recently used (analyze recent activity events): https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.languages.recent.svg
  default algorithm: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.languages.svg
  default algorithm (with details): https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.languages.details.svg
index: 1
supports:
  - user
  - organization
  - repository
scopes:
  - public_access
inputs:

  plugin_languages:
    description: |
      Enable languages plugin
    type: boolean
    default: no

  plugin_languages_ignored:
    description: |
      Ignored languages
    type: array
    format: comma-separated
    default: ""
    example: html, css, ...

  plugin_languages_skipped:
    description: |
      Skipped repositories
    type: array
    format: comma-separated
    default: ""
    example: my-repo-1, my-repo-2, owner/repo-3, ...
    inherits: repositories_skipped

  plugin_languages_limit:
    description: |
      Display limit
    type: number
    default: 8
    min: 0
    max: 8
    zero: disable

  plugin_languages_threshold:
    description: |
      Display threshold (percentage)
    type: string
    default: 0%

  plugin_languages_other:
    description: |
      Group unknown, ignored and over-limit languages into "Other" category

      If this option is enabled, "Other" category will not be subject to [`plugin_languages_threshold`](/source/plugins/languages/README.md#plugin_languages_threshold).
      It will be automatically hidden if empty.
    type: boolean
    default: no

  plugin_languages_colors:
    description: |
      Custom languages colors
    type: array
    format: comma-separated
    default: github
    example: javascript:red, 0:blue, 1:#ff00aa

  plugin_languages_aliases:
    description: |
      Custom languages names
    type: string
    default: ""
    example: javascript:JS typescript:TS

  plugin_languages_sections:
    description: |
      Displayed sections

      Note that `recently-used` is only available when [`plugin_languages_indepth`](/source/plugins/languages/README.md#plugin_languages_indepth) is enabled
    type: array
    format: comma-separated
    default: most-used
    example: most-used, recently-used
    values:
      - most-used
      - recently-used

  plugin_languages_details:
    description: |
      Additional details

      Note that `lines` is only available when [`plugin_languages_indepth`](/source/plugins/languages/README.md#plugin_languages_indepth) is enabled
    type: array
    format: comma-separated
    values:
      - bytes-size
      - percentage
      - lines
    default: ""
    example: bytes-size, percentage

  plugin_languages_indepth:
    description: |
      Indepth mode

      > ⚠️ read documentation first
    type: boolean
    default: false
    extras:
      - metrics.cpu.overuse
      - metrics.run.tempdir
      - metrics.run.git

  plugin_languages_analysis_timeout:
    description: |
      Indepth mode - Analysis timeout
    type: number
    default: 15
    min: 1
    max: 30

  plugin_languages_categories:
    description: |
      Indepth mode - Displayed categories (most-used section)
    type: array
    format: comma-separated
    values:
      - data
      - markup
      - programming
      - prose
    default: markup, programming

  plugin_languages_recent_categories:
    description: |
      Indepth mode - Displayed categories (recently-used section)
    type: array
    format: comma-separated
    values:
      - data
      - markup
      - programming
      - prose
    default: markup, programming

  plugin_languages_recent_load:
    description: |
      Events to load (recently-used section)
    type: number
    default: 300
    min: 100
    max: 1000

  plugin_languages_recent_days:
    description: |
      Events maximum age (day, recently-used section)
    type: number
    default: 14
    min: 0
    max: 365
    zero: disable