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

docs: remove cost, document missing options and improve docs (#653)

Browse Source
This commit is contained in:
Simon Lecoq
2021-11-04 19:33:29 -04:00
committed by GitHub
parent e147d2ac32
commit a291e35774
56 changed files with 82 additions and 87 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -52,16 +52,18 @@ For better results, it's advised to add either your surnames and eventually no-r
plugin_languages: yes
plugin_languages_ignored: html, css # List of languages to ignore
plugin_languages_skipped: my-test-repo # List of repositories to skip
plugin_languages_limit: 8 # Display up to 8 languages
plugin_languages_sections: most-used, recently-used # Display most used and recently used
plugin_languages_colors: "0:orange, javascript:#ff0000, ..." # Make most used languages orange and JavaScript red
plugin_languages_aliases: "JavaScript:JS, TypeScript:TS, ..." # Customize languages names with aliases
plugin_languages_details: bytes-size, percentage # Additionally display total bytes size and percentage
plugin_languages_threshold: 2% # Hides all languages less than 2%
plugin_languages_limit: 8 # Display up to 8 languages
plugin_languages_sections: most-used, recently-used # Display most used and recently used languages stats
languages stats
plugin_languages_indepth: no # Get indepth stats (see documentation before enabling)
plugin_languages_analysis_timeout: 15 # Set maximum time for indepth analysis
plugin_languages_categories: programming # Display only languages that match these categories in most-used section
plugin_languages_recent_categories: markup, programming, data # Display only languages that match these categories in recently-used section
plugin_languages_recent_load: 500 # Load up to 500 events to compute recently used stats
plugin_languages_recent_days: 7 # Limit recently used stats to last week
commits_authoring: lowlighter@users.noreply.github.com # Surnames or email addresses used to identify your commits
commits_authoring: octocat@users.noreply.github.com # Surnames or email addresses used to identify your commits
```

3
source/plugins/languages/metadata.yml
View File

@@ -1,5 +1,4 @@
name: "🈷️ Most used languages"
cost: 0 API request (1 per 100 events fetched when using recently-used section)
category: github
index: 1
supports:
@@ -28,7 +27,7 @@ inputs:
type: array
format: comma-separated
default: ""
example: my-repo-1, my-repo-2, owner/repo-3 ...
example: my-repo-1, my-repo-2, owner/repo-3, ...
# Number of languages to display
# Set to 0 to disable limitations