diff --git a/source/plugins/languages/README.md b/source/plugins/languages/README.md index d65da513..0a7da2f6 100644 --- a/source/plugins/languages/README.md +++ b/source/plugins/languages/README.md @@ -1,139 +1,139 @@ -### 🈷ī¸ 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](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value). -It is also possible to use a predefined set of colors from [colorsets.json](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](https://github.com/Nixinova/Linguist) 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](/source/plugins/languages/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 +## ➡ī¸ 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](metadata.yml)* +## 🔎 `indepth` mode -#### ℹī¸ Examples workflows +The default algorithm use the top languages provided of each repository you contributed to. +When working in collaborative projects with a lot of people, these numbers may be less representative of your actual work. + +The `plugin_languages_indepth` option lets you use a more advanced algorithm for more accurates statistics. +Under the hood, it will clone your repositories, run [linguist-js](https://github.com/Nixinova/Linguist) (a JavaScript port of [GitHub linguist](https://github.com/github/linguist)) and iterate over patches matching your `commits_authoring` setting. + +Since git lets you use any email and username for commits, *metrics* may not be able to detect a commit ownership if it isn't the same as your GitHub personal data. By default, it will use your GitHub username, but you can configure additional matching usernames and email addresses using `commits_authoring` option. + +*Example: configuring `indepth` mode* +```yml +- uses: lowlighter/metrics@latest + with: + plugin_languages: yes + plugin_languages_indepth: yes + commits_authoring: firstname lastname, username, username@users.noreply.github.com +``` + +> 💡 This feature unlocks the `lines` option in `plugin_languages_details` + +> ⚠ī¸ This feature significantly increase workflow time + +> ⚠ī¸ Since this mode iterates over **each commit of each repository**, it is not suited for large code base, especially those with a large amount of commits and the ones containing binaries. While `plugin_languages_analysis_timeout` can be used to increase the default timeout for analysis, please be responsible and keep this feature disabled if it cannot work on your account to save GitHub resources and our planet 🌏 + +> ⚠ī¸ Although *metrics* does not send any code to external sources, repositories are temporarily cloned on the GitHub Action runner. It is advised to keep this option disabled when working with sensitive data or company code. Use at your own risk, *metrics* and its authors **cannot** be held responsible for any resulting code leaks. Source code is available for auditing at [analyzers.mjs](/source/plugins/languages/analyzers.mjs). + +> 🌐 Web instances must enable this feature in `settings.json` + +## 📅 Recently used languages + +This feature uses a similar algorithm as `indepth` mode, but uses patches from your events feed instead. +It will fetch a specified amount of recent push events and perform linguistic analysis on it. + +> ⚠ī¸ Note that *metrics* won't be able to use more events than GitHub API is able to provide + +*Example: display recently used languages from 400 GitHub events from last 2 weeks* +```yml +- uses: lowlighter/metrics@latest + with: + plugin_languages: yes + plugin_languages_sections: recently-used + plugin_languages_recent_load: 400 + plugin_languages_recent_days: 14 +``` + +> 🌐 Web instances must enable this feature in `settings.json` + +## đŸĨŊ Controling which languages are displayed + +Several options lets you customize which languages should be displayed. +It is possible to ignore completely languages or those lower than a given threshold, skip repositories, and filter by language categories. + +*Example: hide HTML and CSS languages, skip lowlighter/metrics repository* +```yml +- uses: lowlighter/metrics@latest + with: + plugin_languages: yes + plugin_languages_ignored: html, css + plugin_languages_skipped: lowlighter/metrics +``` + +*Example: hide languages with less than 2% usage* +```yml +- uses: lowlighter/metrics@latest + with: + plugin_languages: yes + plugin_languages_threshold: 2% +``` + +> 💡 The threshold feature will automatically scale remaining languages so the total percentage is always 100%. However, other stats like bytes count and lines are not affected. + +When using `indepth` mode, it is possible to hide languages per category. +Supported categories are `data`, `markup`, `programming` and `prose`. + +*Example: hide data and prose languages from stats* +```yml +- uses: lowlighter/metrics@latest + with: + plugin_languages: yes + plugin_languages_categories: data, prose + plugin_languages_recent_categories: data, prose +``` + +## 🎨 Using custom colors + +The plugin uses GitHub language colors, but it may be hard to distinguish them depending on which languages you use. +It is possible to use custom colors using `plugin_languages_colors` option. + +The following syntaxes are supported: +- A predefined set from [colorsets.json](colorsets.json) *(support limited to 8 languages max)* +- `${language}:${color}` to change the color of a language *(case insensitive)* +- `${n}:${color}` to change the color of the the n-th language + +Both hexadecimal and [named color](https://developer.mozilla.org/en-US/docs/Web/CSS/color_value) are supported. + +*Example: using a predefined color set* +```yml +- uses: lowlighter/metrics@latest + with: + plugin_languages: yes + plugin_languages_colors: rainbow + plugin_languages_limit: 8 +``` + +*Example: setting JavaScript to red, the first language to blue and the second one to `#ff00aa`* +```yml +- uses: lowlighter/metrics@latest + with: + plugin_languages: yes + plugin_languages_colors: javascript:red, 0:blue, 1:#ff00aa +``` + +## ✍ī¸ Using custom languages name + +This plugin is limited by [GitHub linguist](https://github.com/github/linguist) capabilities, meaning that some languages may be mislabeled in some cases. + +To mitigate this, it is possible to use `plugin_languages_aliases` option and provide a list of overrides using the following syntax: `${language}:${alias}` *(case insensitive)*. + +*Example: display JavaScript as JS and TypeScript as TS* +```yml +- uses: lowlighter/metrics@latest + with: + plugin_languages: yes + plugin_languages_aliases: javascript:JS typescript:TS +``` + +## ℹī¸ Examples workflows -```yaml -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 - -``` -```yaml -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 - -``` -```yaml -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 - -``` -```yaml -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 - -``` diff --git a/source/plugins/languages/metadata.yml b/source/plugins/languages/metadata.yml index 305bf942..181a2c91 100644 --- a/source/plugins/languages/metadata.yml +++ b/source/plugins/languages/metadata.yml @@ -1,5 +1,11 @@ name: "🈷ī¸ Most used languages" 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/lowlighter/blob/master/metrics.plugin.languages.indepth.svg + +recently used (analyze recent activity events): https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.languages.recent.svg + default algorithm: https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.languages.svg + default algorithm (with details): https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.languages.details.svg index: 1 supports: - user @@ -9,113 +15,92 @@ scopes: - public_access inputs: - # Enable or disable plugin plugin_languages: - description: Display most used languages metrics + description: Enable languages plugin type: boolean default: no - # List of languages that will be ignored plugin_languages_ignored: - description: Languages to ignore + description: Ignored languages type: array format: comma-separated default: "" example: html, css, ... - # List of repositories that will be skipped plugin_languages_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 - # Number of languages to display - # Set to 0 to disable limitations plugin_languages_limit: - description: Maximum number of languages to display + description: Display limit type: number default: 8 min: 0 max: 8 + zero: disable - # Sections to display - plugin_languages_sections: - description: Sections to display - type: array - format: comma-separated - default: most-used - example: most-used, recently-used - values: - - most-used # Most used languages - - recently-used # Recently used languages - extras: yes + plugin_languages_threshold: + description: Display threshold (percentage) + type: string + default: 0% - # Overrides default languages colors - # Use `${n}:${color}` to change the color of the n-th most used language (e.g. "0:red" to make your most used language red) - # Use `${language}:${color}` to change the color of named language (e.g. "javascript:red" to make JavaScript language red, language case is ignored) - # Use a value from `colorsets.json` to use a predefined set of colors - # Both hexadecimal and named colors are supported - # This cannot be used when "plugin_languages_limit" is greater than 8 plugin_languages_colors: description: Custom languages colors type: array - format: - - comma-separated - - /((?[0-9])|(?[-+a-z0-9#]+)):(?#?[-a-z0-9]+)/ + format: comma-separated default: github example: javascript:red, 0:blue, 1:#ff00aa - # Overrides default languages name - # Use `${language}:${alias}` to change the name of language (e.g. "javascript:JS" to make JavaScript render as "JS", case of left operand ignored) plugin_languages_aliases: description: Custom languages names type: string default: "" example: javascript:JS typescript:TS - # Languages additional details + plugin_languages_sections: + extras: yes + description: Displayed sections + type: array + format: comma-separated + default: most-used + example: most-used, recently-used + values: + - most-used + - recently-used + plugin_languages_details: + extras: yes description: Additional details type: array format: comma-separated values: - - bytes-size # Languages total size written in bytes - - percentage # Languages proportions in % - - lines # Estimation of lines of code (plugin_languages_indepth must be enabled) + - bytes-size + - percentage + - lines default: "" example: bytes-size, percentage - # Minimum threshold (in percentage) to reach for languages to be displayed - plugin_languages_threshold: - description: Minimum threshold - type: string - default: 0% - - # Compute indepth languages statistics by cloning repositories and processing your commits individually - # See documentation before enabling plugin_languages_indepth: - description: Indepth languages processing (see documentation before enabling) + extras: yes + description: Indepth mode (⚠ī¸ read documentation first) type: boolean default: false - extras: yes - # Analysis timeout (in minutes) - # In case of timeout, it'll automatically fallback to default algorithm - # Please be nice with GitHub Actions and disable `plugin_languages_indepth` if your account is not supported - # See documentation before enabling plugin_languages_analysis_timeout: - description: Languages analysis timeout + extras: yes + description: Indepth mode - Analysis timeout type: number default: 15 min: 1 max: 30 - extras: yes - # GitHub language categories to display plugin_languages_categories: - description: Language categories to display + extras: yes + description: Indepth mode - Displayed categories (most-used section) type: array format: comma-separated values: @@ -125,9 +110,9 @@ inputs: - prose default: markup, programming - # GitHub language categories to display in recently-used section plugin_languages_recent_categories: - description: Language categories to display (for recently used section) + extras: yes + description: Indepth mode - Displayed categories (recently-used section) type: array format: comma-separated values: @@ -137,21 +122,19 @@ inputs: - prose default: markup, programming - # Number of activity events to load (for recently used languages statistics) - # A high number will consume more requests plugin_languages_recent_load: - description: Number of events to load (for recently used section) + extras: yes + description: Events to load (recently-used section) type: number default: 300 min: 100 max: 1000 - # Filter events by age (for recently used languages statistics) - # Set to 0 to disable age filtering - # Note that metrics won't be able to load more events than GitHub is able to provide plugin_languages_recent_days: - description: Maximum event age (for recently used section) + extras: yes + description: Events maximum age (day, recently-used section) type: number default: 14 min: 0 max: 365 + zero: disable