Skip to content

Latest commit

 

History

History
139 lines (117 loc) · 6.56 KB

README.md

File metadata and controls

139 lines (117 loc) · 6.56 KB
Raw

🈷️ Most used languages

The languages plugin displays which programming languages you use the most across all your repositories.

Indepth analysis (clone and analyze repositories)
Recently used (analyze recent activity events)
Default algorithm
Default algorithm (with details)

It is possible to use custom colors for languages instead of those provided by GitHub by using plugin_languages_colors option. You can specify either an index with a color, or a language name (case insensitive) with a color. Colors can be either in hexadecimal format or a named color. It is also possible to use a predefined set of colors from colorsets.json

Using indepth statistics

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.

The plugin_languages_indepth option lets you get more accurate metrics by cloning each repository you contributed to, running linguist-js 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 and its authors cannot be held responsible for any resulting code leaks, use at your own risk. Source code is available for auditing at analyzers.mjs

🔣 On web instances, indepth is an extra feature and must be enabled globally in settings.json

commits_authoring option

Since Git lets you use any email and name for commits, metrics may not be able to detect whether you own a commit or not. By default, it'll check whether it matches your GitHub login.

For better results, it's advised to add either your surnames and eventually no-reply email addresses.

➡️ Available options

Option Type (format) [default] {allowed values} Description
plugin_languages boolean [no] Display most used languages metrics
plugin_languages_ignored array (comma-separated) [] Languages to ignore
plugin_languages_skipped array (comma-separated) [] Repositories to skip
plugin_languages_limit number [8] {0 ≤ 𝑥 ≤ 8} Maximum number of languages to display
plugin_languages_sections 🧰 array (comma-separated) [most-used] {"most-used", "recently-used"} Sections to display
plugin_languages_colors array (comma-separated) [github] Custom languages colors
plugin_languages_aliases string [] Custom languages names
plugin_languages_details array (comma-separated) [] {"bytes-size", "percentage", "lines"} Additional details
plugin_languages_threshold string [0%] Minimum threshold
plugin_languages_indepth 🧰 boolean [false] Indepth languages processing (see documentation before enabling)
plugin_languages_analysis_timeout 🧰 number [15] {1 ≤ 𝑥 ≤ 30} Languages analysis timeout
plugin_languages_categories array (comma-separated) [markup, programming] {"data", "markup", "programming", "prose"} Language categories to display
plugin_languages_recent_categories array (comma-separated) [markup, programming] {"data", "markup", "programming", "prose"} Language categories to display (for recently used section)
plugin_languages_recent_load number [300] {100 ≤ 𝑥 ≤ 1000} Number of events to load (for recently used section)
plugin_languages_recent_days number [14] {0 ≤ 𝑥 ≤ 365} Maximum event age (for recently used section)

Legend for option icons:

  • 🧰 Must be enabled in settings.json (for web instances)

→ Full specification

ℹ️ Examples workflows

name: Most used
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.languages.svg
  token: ${{ secrets.METRICS_TOKEN }}
  base: ''
  plugin_languages: 'yes'
  plugin_languages_ignored: >-
    html, css, tex, less, dockerfile, makefile, qmake, lex, cmake, shell,
    gnuplot
  plugin_languages_limit: 4

name: Most used (with details)
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.languages.details.svg
  token: ${{ secrets.METRICS_TOKEN }}
  base: ''
  plugin_languages: 'yes'
  plugin_languages_ignored: >-
    html, css, tex, less, dockerfile, makefile, qmake, lex, cmake, shell,
    gnuplot
  plugin_languages_details: bytes-size, percentage
  plugin_languages_limit: 4

name: Recently used
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.languages.recent.svg
  token: ${{ secrets.METRICS_TOKEN }}
  base: ''
  plugin_languages: 'yes'
  plugin_languages_ignored: >-
    html, css, tex, less, dockerfile, makefile, qmake, lex, cmake, shell,
    gnuplot
  plugin_languages_sections: recently-used
  plugin_languages_details: bytes-size, percentage
  plugin_languages_limit: 4

name: Indepth analysis
uses: lowlighter/metrics@latest
with:
  filename: metrics.plugin.languages.indepth.svg
  token: ${{ secrets.METRICS_TOKEN }}
  base: ''
  plugin_languages: 'yes'
  plugin_languages_ignored: >-
    html, css, tex, less, dockerfile, makefile, qmake, lex, cmake, shell,
    gnuplot
  plugin_languages_indepth: 'yes'
  plugin_languages_details: lines, bytes-size
  plugin_languages_limit: 4
  plugin_languages_analysis_timeout: 15