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

Update README.md

Browse Source
This commit is contained in:
lowlighter
2021-05-26 00:26:40 +02:00
parent 78da4515e8
commit fe97bcdbc5
1 changed files with 7 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -8,6 +8,9 @@ The *languages* plugin displays which programming languages you use the most acr
<details open><summary>With both total bytes size and percentage version</summary> <details open><summary>With both total bytes size and percentage version</summary>
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.languages.details.svg"> <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.languages.details.svg">
</details> </details>
<details open><summary>Recently used version (based on recent activity)</summary>
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.languages.recent.svg">
</details>
<img width="900" height="1" alt=""> <img width="900" height="1" alt="">
</td> </td>
</table> </table>
@@ -19,13 +22,13 @@ It is also possible to use a predefined set of colors from [colorsets.json](colo
#### Using `indepth` statistics #### Using `indepth` statistics
Languages statistics are computed using the top languages of each repository you contributed to. Languages statistics are computed using the top languages provided by GitHub of each repository you contributed to.
If you work a lot with other people, these numbers may be less representative of your actual work. If you work a lot with other people, these numbers may be less representative of your actual work.
The `plugin_languages_indepth` option lets you get more accurate metrics by cloning each repository, running [github/linguist](https://github.com/github/linguist) on it and iterating over patches matching your username from `git log`, but will be **significantly slower**. The `plugin_languages_indepth` option lets you get more accurate metrics by cloning each repository you contributed to, running [github/linguist](https://github.com/github/linguist) on it and then iterating over patches matching your username from `git log`. This method is slower than the first one.
> ⚠️ Although *metrics* does not send any code to external sources, you must understand that when using this option repositories are cloned locally temporarly on the GitHub Action runner. If you work with sensitive data or company code, it is advised to keep this option disabled. *Metrics* cannot be held responsible for any eventual code leaks, use at your own risk. > ⚠️ Although *metrics* does not send any code to external sources, you must understand that when using this option repositories are cloned locally temporarly on the GitHub Action runner. If you work with sensitive data or company code, it is advised to keep this option disabled. *Metrics* cannot be held responsible for any eventual code leaks, use at your own risk.
> Source code is available for auditing at [indepth.mjs](/source/plugins/languages/indepth.mjs) > Source code is available for auditing at [analyzers.mjs](/source/plugins/languages/analyzers.mjs)
#### ℹ️ Examples workflows #### ℹ️ Examples workflows
@@ -42,5 +45,6 @@ The `plugin_languages_indepth` option lets you get more accurate metrics by clon
plugin_languages_details: bytes-size, percentage # Additionally display total bytes size and percentage 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_threshold: 2% # Hides all languages less than 2%
plugin_languages_limit: 8 # Display up to 8 languages plugin_languages_limit: 8 # Display up to 8 languages
plugin_languages_sections: most-used, recently-used # Display most used and recently used languages stats
plugin_languages_indepth: no # Get indepth stats (see documentation before enabling) plugin_languages_indepth: no # Get indepth stats (see documentation before enabling)
``` ```