From 161c0bd5bc43bbba01c7d59f932c78974a318902 Mon Sep 17 00:00:00 2001 From: lowlighter <22963968+lowlighter@users.noreply.github.com> Date: Fri, 12 Mar 2021 13:26:29 +0100 Subject: [PATCH] Update plugin order --- README.md | 380 +++++++------- action.yml | 598 +++++++++++----------- settings.example.json | 90 ++-- source/app/metrics/metadata.mjs | 4 +- source/plugins/README.md | 32 +- source/plugins/activity/metadata.yml | 1 + source/plugins/anilist/metadata.yml | 1 + source/plugins/contributors/README.md | 2 +- source/plugins/contributors/metadata.yml | 1 + source/plugins/followup/metadata.yml | 1 + source/plugins/gists/metadata.yml | 1 + source/plugins/habits/metadata.yml | 1 + source/plugins/introduction/metadata.yml | 1 + source/plugins/isocalendar/metadata.yml | 1 + source/plugins/languages/metadata.yml | 1 + source/plugins/licenses/metadata.yml | 1 + source/plugins/lines/metadata.yml | 1 + source/plugins/music/metadata.yml | 1 + source/plugins/nightscout/metadata.yml | 1 + source/plugins/pagespeed/metadata.yml | 1 + source/plugins/people/metadata.yml | 1 + source/plugins/posts/metadata.yml | 1 + source/plugins/projects/metadata.yml | 1 + source/plugins/reactions/metadata.yml | 1 + source/plugins/skyline/metadata.yml | 1 + source/plugins/stackoverflow/metadata.yml | 1 + source/plugins/stargazers/metadata.yml | 1 + source/plugins/stars/metadata.yml | 1 + source/plugins/topics/metadata.yml | 1 + source/plugins/traffic/metadata.yml | 1 + source/plugins/tweets/metadata.yml | 1 + source/plugins/wakatime/metadata.yml | 1 + 32 files changed, 579 insertions(+), 553 deletions(-) diff --git a/README.md b/README.md index 319e7a8b..ab8edf6a 100644 --- a/README.md +++ b/README.md @@ -34,59 +34,6 @@ And you can customize these heavily with plugins, templates and hundreds of opti 🧩 26 plugins - - 📰 Recent activity - 🏅 Repository contributors - - - - - - - - -
With number of contributions - -
- - - - - 🎟️ Follow-up of issues and pull requests - 🎫 Gists - - - - - - - - - - - - - 💡 Coding habits - 🙋 Introduction - - - - -
Charts version - -
- - - -
Account version - -
-
Repository version - -
- - - 📅 Isometric commit calendar 🈷️ Most used languages @@ -107,9 +54,31 @@ And you can customize these heavily with plugins, templates and hundreds of opti + + 🙋 Introduction + 💡 Coding habits + + + +
Account version + +
+
Repository version + +
+ + + + +
Charts version + +
+ + + 📜 Repository licenses - 👨‍💻 Lines of code changed + 🏅 Repository contributors @@ -120,15 +89,39 @@ And you can customize these heavily with plugins, templates and hundreds of opti - + +
With number of contributions + +
- 🧑‍🤝‍🧑 People plugin - 🗂️ Active projects + 🌟 Recently starred repositories + 📌 Starred topics + + + + + + +
Mastered and known technologies version + +
+ + + + + 🎭 Comment reactions + 🧑‍🤝‍🧑 People plugin + + + + + +
Followed people version @@ -142,18 +135,55 @@ And you can customize these heavily with plugins, templates and hundreds of opti
+ + + 🎫 Gists + 🎟️ Follow-up of issues and pull requests + + + + + + + + + + + + + 👨‍💻 Lines of code changed + 🧮 Repositories traffic + + + + + + + + + + + + ✨ Stargazers over last weeks + 🗂️ Active projects + + + + + + - 🎭 Comment reactions + 📰 Recent activity 🌇 GitHub Skyline 3D calendar - + @@ -162,47 +192,17 @@ And you can customize these heavily with plugins, templates and hundreds of opti - ✨ Stargazers over last weeks - 🌟 Recently starred repositories - - - - - - - - - - - - - 📌 Starred topics - 🧮 Repositories traffic - - - - -
Mastered and known technologies version - -
- - - - - - - - 🌸 Anilist watch list and reading list + ⏱️ Website performances 🎼 Music plugin - -
Manga version - + +
Detailed version +
-
Favorites characters version - +
With screenshot version +
@@ -217,31 +217,31 @@ And you can customize these heavily with plugins, templates and hundreds of opti - ⏱️ Website performances - ✒️ Recent posts + 🐤 Latest tweets + 🌸 Anilist watch list and reading list - -
Detailed version - -
-
With screenshot version - + +
With tweets attachments version +
- -
With posts descriptions and cover images version - + +
Manga version + +
+
Favorites characters version +
🗨️ Stackoverflow plugin - 🐤 Latest tweets + ✒️ Recent posts @@ -249,9 +249,9 @@ And you can customize these heavily with plugins, templates and hundreds of opti - -
With tweets attachments version - + +
With posts descriptions and cover images version +
@@ -596,120 +596,120 @@ https://my-personal-domain.com/my-github-user?base=0&base.repositories=1 Template\Plugin 🗃️ - 📰 - 🏅 - 🎟️ - 🎫 - 💡 - 🙋 📅 🈷️ + 🙋 + 💡 📜 - 👨‍💻 - 🧑‍🤝‍🧑 - 🗂️ - 🎭 - 🌇 - ✨ + 🏅 🌟 📌 + 🎭 + 🧑‍🤝‍🧑 + 🎫 + 🎟️ + 👨‍💻 🧮 - 🌸 - 🎼 + ✨ + 🗂️ + 📰 + 🌇 ⏱️ - ✒️ - 🗨️ + 🎼 🐤 + 🌸 + 🗨️ + ✒️ ⏰ 💉 📗 Classic ✔️ - ✔️ - ❌ - ✔️ - ✔️ - ✔️ - ✔️ ✔️ ✔️ + ✔️ + ✔️ ❌ - ✔️ - ✔️ - ✔️ - ✔️ - ✔️ - ✔️ + ❌ ✔️ ✔️ + ✔️ + ✔️ + ✔️ + ✔️ + ✔️ ✔️ - ✔️ - ✔️ + ✔️ + ✔️ + ✔️ + ✔️ ✔️ - ✔️ - ✔️ + ✔️ ✔️ + ✔️ + ✔️ + ✔️ ✔️ ✔️ 📘 Repository ✔️ - ✔️ - ✔️ - ✔️ - ❌ - ❌ - ✔️ ❌ ✔️ + ✔️ + ❌ ✔️ - ✔️ - ✔️ - ✔️ - ❌ - ❌ - ✔️ + ✔️ ❌ ❌ + ❌ + ✔️ + ❌ + ✔️ + ✔️ ✔️ - ❌ - ❌ + ✔️ + ✔️ + ✔️ + ❌ ✔️ - ❌ - ❌ + ❌ ❌ + ❌ + ❌ + ❌ ❌ ❌ 📙 Terminal ✔️ - ❌ - ❌ - ❌ - ✔️ - ❌ - ❌ ❌ ✔️ + ❌ + ❌ ❌ - ✔️ - ❌ - ❌ - ❌ - ❌ - ❌ + ❌ ❌ ❌ + ❌ + ❌ + ✔️ + ❌ + ✔️ ✔️ - ❌ - ❌ + ❌ + ❌ + ❌ + ❌ ✔️ - ❌ - ❌ + ❌ ❌ + ❌ + ❌ + ❌ ❌ ❌ @@ -734,31 +734,31 @@ See their respective documentation for more informations about how to setup them * [🗃️ Base content](/source/plugins/base/README.md) * [🧱 Core](/source/plugins/core/README.md) * **Github** - * [📰 Recent activity](/source/plugins/activity/README.md) - * [🏅 Repository contributors](/source/plugins/contributors/README.md) - * [🎟️ Follow-up of issues and pull requests](/source/plugins/followup/README.md) - * [🎫 Gists](/source/plugins/gists/README.md) - * [💡 Coding habits](/source/plugins/habits/README.md) - * [🙋 Introduction](/source/plugins/introduction/README.md) * [📅 Isometric commit calendar](/source/plugins/isocalendar/README.md) * [🈷️ Most used languages](/source/plugins/languages/README.md) + * [🙋 Introduction](/source/plugins/introduction/README.md) + * [💡 Coding habits](/source/plugins/habits/README.md) * [📜 Repository licenses](/source/plugins/licenses/README.md) - * [👨‍💻 Lines of code changed](/source/plugins/lines/README.md) - * [🧑‍🤝‍🧑 People plugin](/source/plugins/people/README.md) - * [🗂️ Active projects](/source/plugins/projects/README.md) - * [🎭 Comment reactions](/source/plugins/reactions/README.md) - * [🌇 GitHub Skyline 3D calendar](/source/plugins/skyline/README.md) - * [✨ Stargazers over last weeks](/source/plugins/stargazers/README.md) + * [🏅 Repository contributors](/source/plugins/contributors/README.md) * [🌟 Recently starred repositories](/source/plugins/stars/README.md) * [📌 Starred topics](/source/plugins/topics/README.md) + * [🎭 Comment reactions](/source/plugins/reactions/README.md) + * [🧑‍🤝‍🧑 People plugin](/source/plugins/people/README.md) + * [🎫 Gists](/source/plugins/gists/README.md) + * [🎟️ Follow-up of issues and pull requests](/source/plugins/followup/README.md) + * [👨‍💻 Lines of code changed](/source/plugins/lines/README.md) * [🧮 Repositories traffic](/source/plugins/traffic/README.md) + * [✨ Stargazers over last weeks](/source/plugins/stargazers/README.md) + * [🗂️ Active projects](/source/plugins/projects/README.md) + * [📰 Recent activity](/source/plugins/activity/README.md) + * [🌇 GitHub Skyline 3D calendar](/source/plugins/skyline/README.md) * **Social** - * [🌸 Anilist watch list and reading list](/source/plugins/anilist/README.md) - * [🎼 Music plugin](/source/plugins/music/README.md) * [⏱️ Website performances](/source/plugins/pagespeed/README.md) - * [✒️ Recent posts](/source/plugins/posts/README.md) - * [🗨️ Stackoverflow plugin](/source/plugins/stackoverflow/README.md) + * [🎼 Music plugin](/source/plugins/music/README.md) * [🐤 Latest tweets](/source/plugins/tweets/README.md) + * [🌸 Anilist watch list and reading list](/source/plugins/anilist/README.md) + * [🗨️ Stackoverflow plugin](/source/plugins/stackoverflow/README.md) + * [✒️ Recent posts](/source/plugins/posts/README.md) * [⏰ WakaTime plugin](/source/plugins/wakatime/README.md) * **Health** * [💉 Nightscout](/source/plugins/nightscout/README.md) diff --git a/action.yml b/action.yml index 407d435d..276ea353 100644 --- a/action.yml +++ b/action.yml @@ -195,128 +195,6 @@ inputs: description: Use pre-built image from GitHub registry default: yes - # ==================================================================================== - # 📰 Recent activity - - # Enable or disable plugin - plugin_activity: - description: Display recent activity - default: no - - # Number of activity events to display - plugin_activity_limit: - description: Maximum number of events to display - default: 5 - - # Filter events by age - # Set to 0 to disable age filtering - plugin_activity_days: - description: Maximum event age - default: 14 - - # Filter events by type - plugin_activity_filter: - description: Events types to keep - default: all - - # Set events visibility (use this to restrict events when using a "repo" token) - plugin_activity_visibility: - description: Set events visibility - default: all - - # Display events timestamps - plugin_activity_timestamps: - description: Display events timestamps - default: no - - # ==================================================================================== - # 🏅 Repository contributors - - # Enable or disable plugin - plugin_contributors: - description: Display repository contributors - default: no - - # Base reference (commit, tag, branch, etc.) - plugin_contributors_base: - description: Base reference - default: "" - - # Head reference (commit, tag, branch, etc.) - plugin_contributors_head: - description: Head reference - default: master - - # Ignored contributors (useful to ignore bots users) - plugin_contributors_ignored: - description: Contributors to ignore - default: github-actions[bot] - - # Display total contributions for each contributor - plugin_contributors_contributions: - description: Display contributions - default: no - - # ==================================================================================== - # 🎟️ Follow-up of issues and pull requests - - # Enable or disable plugin - plugin_followup: - description: Display follow-up of repositories issues and pull requests - default: no - - # ==================================================================================== - # 🎫 Gists - - # Enable or disable plugin - plugin_gists: - description: Display gists metrics - default: no - - # ==================================================================================== - # 💡 Coding habits - - # Enable or disable plugin - plugin_habits: - description: Display coding habits metrics - default: no - - # Number of events to use to computes habits - # Using more will result in more accurate metrics, but you may hit GitHub rate-limit more easily - plugin_habits_from: - description: Number of events to use - default: 200 - - # Filter used events to compute habits by age - plugin_habits_days: - description: Maximum event age - default: 14 - - # Display tidbits about your most active hours/days, indents used (spaces/tabs), etc. - # This is deduced from your recent activity - plugin_habits_facts: - description: Display coding habits collected facts based on recent activity - default: yes - - # Display charts of most active time of the day and most active day of the week - # Also display languages recently used (this is not the same as plugin_languages, as the latter is an all-time stats) - plugin_habits_charts: - description: Display coding habits charts based on recent activity - default: no - - # ==================================================================================== - # 🙋 Introduction - - # Enable or disable plugin - plugin_introduction: - description: Display account or repository introduction - default: no - - # Display introduction section title - plugin_introduction_title: - description: Display introduction section title - default: yes - # ==================================================================================== # 📅 Isometric commit calendar @@ -367,6 +245,50 @@ inputs: description: Minimum threshold default: 0% + # ==================================================================================== + # 🙋 Introduction + + # Enable or disable plugin + plugin_introduction: + description: Display account or repository introduction + default: no + + # Display introduction section title + plugin_introduction_title: + description: Display introduction section title + default: yes + + # ==================================================================================== + # 💡 Coding habits + + # Enable or disable plugin + plugin_habits: + description: Display coding habits metrics + default: no + + # Number of events to use to computes habits + # Using more will result in more accurate metrics, but you may hit GitHub rate-limit more easily + plugin_habits_from: + description: Number of events to use + default: 200 + + # Filter used events to compute habits by age + plugin_habits_days: + description: Maximum event age + default: 14 + + # Display tidbits about your most active hours/days, indents used (spaces/tabs), etc. + # This is deduced from your recent activity + plugin_habits_facts: + description: Display coding habits collected facts based on recent activity + default: yes + + # Display charts of most active time of the day and most active day of the week + # Also display languages recently used (this is not the same as plugin_languages, as the latter is an all-time stats) + plugin_habits_charts: + description: Display coding habits charts based on recent activity + default: no + # ==================================================================================== # 📜 Repository licenses @@ -393,13 +315,105 @@ inputs: default: yes # ==================================================================================== - # 👨‍💻 Lines of code changed + # 🏅 Repository contributors # Enable or disable plugin - plugin_lines: - description: Display lines of code metrics + plugin_contributors: + description: Display repository contributors default: no + # Base reference (commit, tag, branch, etc.) + plugin_contributors_base: + description: Base reference + default: "" + + # Head reference (commit, tag, branch, etc.) + plugin_contributors_head: + description: Head reference + default: master + + # Ignored contributors (useful to ignore bots users) + plugin_contributors_ignored: + description: Contributors to ignore + default: github-actions[bot] + + # Display total contributions for each contributor + plugin_contributors_contributions: + description: Display contributions + default: no + + # ==================================================================================== + # 🌟 Recently starred repositories + + # Enable or disable plugin + plugin_stars: + description: Display recently starred repositories + default: no + + # Number of stars to display + plugin_stars_limit: + description: Maximum number of stars to display + default: 4 + + # ==================================================================================== + # 📌 Starred topics + + # Enable or disable plugin + plugin_topics: + description: Display starred topics + default: no + + # Plugin mode + plugin_topics_mode: + description: Plugin mode + default: starred + + # Topics sorting order + plugin_topics_sort: + description: Sorting method of starred topics + default: stars + + # Number of topics to display + # Set to 0 to disable limitations + # When in "starred" mode, additional topics will be grouped into an ellipsis + plugin_topics_limit: + description: Maximum number of topics to display + default: 15 + + # ==================================================================================== + # 🎭 Comment reactions + + # Enable or disable plugin + plugin_reactions: + description: Display average issue comments reactions + default: no + + # Maximum number of issue comments to parse + # Issues will be fetched before issues comments + plugin_reactions_limit: + description: Maximum number of issue comments to parse + default: 200 + + # Filter reactions by issue comments age + # Set to 0 to disable age filtering + plugin_reactions_days: + description: Maximum issue comments age + default: 0 + + # Reaction display mode. + # Use this option to fill gauges using: + # - "absolute" to use total reactions count + # - "relative" to use highest reaction count + plugin_reactions_display: + description: Display mode + default: absolute + + # Additional details + # If multiple values are specified, emphasis will be set on first value + plugin_reactions_details: + description: Additional details + default: "" + # ==================================================================================== # 🧑‍🤝‍🧑 People plugin @@ -447,6 +461,46 @@ inputs: description: Shuffle users default: no + # ==================================================================================== + # 🎫 Gists + + # Enable or disable plugin + plugin_gists: + description: Display gists metrics + default: no + + # ==================================================================================== + # 🎟️ Follow-up of issues and pull requests + + # Enable or disable plugin + plugin_followup: + description: Display follow-up of repositories issues and pull requests + default: no + + # ==================================================================================== + # 👨‍💻 Lines of code changed + + # Enable or disable plugin + plugin_lines: + description: Display lines of code metrics + default: no + + # ==================================================================================== + # 🧮 Repositories traffic + + # Enable or disable plugin + plugin_traffic: + description: Display repositories traffic metrics + default: no + + # ==================================================================================== + # ✨ Stargazers over last weeks + + # Enable or disable plugin + plugin_stargazers: + description: Display stargazers metrics + default: no + # ==================================================================================== # 🗂️ Active projects @@ -474,38 +528,38 @@ inputs: default: no # ==================================================================================== - # 🎭 Comment reactions + # 📰 Recent activity # Enable or disable plugin - plugin_reactions: - description: Display average issue comments reactions + plugin_activity: + description: Display recent activity default: no - # Maximum number of issue comments to parse - # Issues will be fetched before issues comments - plugin_reactions_limit: - description: Maximum number of issue comments to parse - default: 200 + # Number of activity events to display + plugin_activity_limit: + description: Maximum number of events to display + default: 5 - # Filter reactions by issue comments age + # Filter events by age # Set to 0 to disable age filtering - plugin_reactions_days: - description: Maximum issue comments age - default: 0 + plugin_activity_days: + description: Maximum event age + default: 14 - # Reaction display mode. - # Use this option to fill gauges using: - # - "absolute" to use total reactions count - # - "relative" to use highest reaction count - plugin_reactions_display: - description: Display mode - default: absolute + # Filter events by type + plugin_activity_filter: + description: Events types to keep + default: all - # Additional details - # If multiple values are specified, emphasis will be set on first value - plugin_reactions_details: - description: Additional details - default: "" + # Set events visibility (use this to restrict events when using a "repo" token) + plugin_activity_visibility: + description: Set events visibility + default: all + + # Display events timestamps + plugin_activity_timestamps: + description: Display events timestamps + default: no # ==================================================================================== # 🌇 GitHub Skyline 3D calendar @@ -533,99 +587,37 @@ inputs: default: 0.5 # ==================================================================================== - # ✨ Stargazers over last weeks + # ⏱️ Website performances # Enable or disable plugin - plugin_stargazers: - description: Display stargazers metrics + plugin_pagespeed: + description: Display a website Google PageSpeed metrics default: no - # ==================================================================================== - # 🌟 Recently starred repositories + # Website to audit with PageSpeed + plugin_pagespeed_url: + description: Audited website + default: .user.website - # Enable or disable plugin - plugin_stars: - description: Display recently starred repositories + # Display the following additional metrics from audited website: + # First Contentful Paint, Speed Index, Largest Contentful Paint, Time to Interactive, Total Blocking Time, Cumulative Layout Shift + # See https://web.dev/performance-scoring/ and https://googlechrome.github.io/lighthouse/scorecalc/ for more informations + plugin_pagespeed_detailed: + description: Detailed audit result default: no - # Number of stars to display - plugin_stars_limit: - description: Maximum number of stars to display - default: 4 - - # ==================================================================================== - # 📌 Starred topics - - # Enable or disable plugin - plugin_topics: - description: Display starred topics + # Display a screenshot of audited website + # May increases significantly filesize + plugin_pagespeed_screenshot: + description: Display a screenshot of your website default: no - # Plugin mode - plugin_topics_mode: - description: Plugin mode - default: starred - - # Topics sorting order - plugin_topics_sort: - description: Sorting method of starred topics - default: stars - - # Number of topics to display - # Set to 0 to disable limitations - # When in "starred" mode, additional topics will be grouped into an ellipsis - plugin_topics_limit: - description: Maximum number of topics to display - default: 15 - - # ==================================================================================== - # 🧮 Repositories traffic - - # Enable or disable plugin - plugin_traffic: - description: Display repositories traffic metrics - default: no - - # ==================================================================================== - # 🌸 Anilist watch list and reading list - - # Enable or disable plugin - plugin_anilist: - description: Display data from your AniList account - default: no - - # Types of medias to display - plugin_anilist_medias: - description: Medias types to display - default: anime, manga - - # Sections to display - # Values from "plugin_anilist_medias" may impact displayed sections - plugin_anilist_sections: - description: Sections to display - default: favorites - - # Number of entries to display per section (this does not impacts characters section) - # Set to 0 to disable limitations - plugin_anilist_limit: - description: Maximum number of entries to display per section - default: 2 - - # Number of entries to display in characters section - # Set to 0 to disable limitations - plugin_anilist_limit_characters: - description: Maximum number of entries to display in characters section - default: 22 - - # Shuffle AniList data for varied outputs - plugin_anilist_shuffle: - description: Shuffle AniList data - default: yes - - # Username on AniList - plugin_anilist_user: - description: AniList login - default: .user.login + # PageSpeed API token + # This is optional, but providing it will avoid hitting rate-limiter + # See https://developers.google.com/speed/docs/insights/v5/get-started for more informations + plugin_pagespeed_token: + description: PageSpeed token + default: "" # ==================================================================================== # 🎼 Music plugin @@ -677,69 +669,73 @@ inputs: default: .user.login # ==================================================================================== - # ⏱️ Website performances + # 🐤 Latest tweets # Enable or disable plugin - plugin_pagespeed: - description: Display a website Google PageSpeed metrics + plugin_tweets: + description: Display recent tweets default: no - # Website to audit with PageSpeed - plugin_pagespeed_url: - description: Audited website - default: .user.website - - # Display the following additional metrics from audited website: - # First Contentful Paint, Speed Index, Largest Contentful Paint, Time to Interactive, Total Blocking Time, Cumulative Layout Shift - # See https://web.dev/performance-scoring/ and https://googlechrome.github.io/lighthouse/scorecalc/ for more informations - plugin_pagespeed_detailed: - description: Detailed audit result - default: no - - # Display a screenshot of audited website - # May increases significantly filesize - plugin_pagespeed_screenshot: - description: Display a screenshot of your website - default: no - - # PageSpeed API token - # This is optional, but providing it will avoid hitting rate-limiter - # See https://developers.google.com/speed/docs/insights/v5/get-started for more informations - plugin_pagespeed_token: - description: PageSpeed token + # Twitter API token + # See https://apps.twitter.com for more informations + plugin_tweets_token: + description: Twitter API token default: "" + # Display tweets attachments (images, video previews, etc.) + plugin_tweets_attachments: + description: Display tweets attchments + default: no + + # Number of tweets to display + plugin_tweets_limit: + description: Maximum number of tweets to display + default: 2 + + # Twitter username + plugin_tweets_user: + description: Twitter username + default: .user.twitter + # ==================================================================================== - # ✒️ Recent posts + # 🌸 Anilist watch list and reading list # Enable or disable plugin - plugin_posts: - description: Display recent posts + plugin_anilist: + description: Display data from your AniList account default: no - # Posts external source - plugin_posts_source: - description: Posts external source - default: "" + # Types of medias to display + plugin_anilist_medias: + description: Medias types to display + default: anime, manga - # Display a few lines about each posts - plugin_posts_descriptions: - description: Display posts descriptions - default: no + # Sections to display + # Values from "plugin_anilist_medias" may impact displayed sections + plugin_anilist_sections: + description: Sections to display + default: favorites - # Display posts cover images - plugin_posts_covers: - description: Display posts cover images - default: no + # Number of entries to display per section (this does not impacts characters section) + # Set to 0 to disable limitations + plugin_anilist_limit: + description: Maximum number of entries to display per section + default: 2 - # Number of posts to display - plugin_posts_limit: - description: Maximum number of posts to display - default: 4 + # Number of entries to display in characters section + # Set to 0 to disable limitations + plugin_anilist_limit_characters: + description: Maximum number of entries to display in characters section + default: 22 - # Username on external posts source - plugin_posts_user: - description: Posts external source username + # Shuffle AniList data for varied outputs + plugin_anilist_shuffle: + description: Shuffle AniList data + default: yes + + # Username on AniList + plugin_anilist_user: + description: AniList login default: .user.login # ==================================================================================== @@ -773,33 +769,37 @@ inputs: default: 4 # ==================================================================================== - # 🐤 Latest tweets + # ✒️ Recent posts # Enable or disable plugin - plugin_tweets: - description: Display recent tweets + plugin_posts: + description: Display recent posts default: no - # Twitter API token - # See https://apps.twitter.com for more informations - plugin_tweets_token: - description: Twitter API token + # Posts external source + plugin_posts_source: + description: Posts external source default: "" - # Display tweets attachments (images, video previews, etc.) - plugin_tweets_attachments: - description: Display tweets attchments + # Display a few lines about each posts + plugin_posts_descriptions: + description: Display posts descriptions default: no - # Number of tweets to display - plugin_tweets_limit: - description: Maximum number of tweets to display - default: 2 + # Display posts cover images + plugin_posts_covers: + description: Display posts cover images + default: no - # Twitter username - plugin_tweets_user: - description: Twitter username - default: .user.twitter + # Number of posts to display + plugin_posts_limit: + description: Maximum number of posts to display + default: 4 + + # Username on external posts source + plugin_posts_user: + description: Posts external source username + default: .user.login # ==================================================================================== # ⏰ WakaTime plugin diff --git a/settings.example.json b/settings.example.json index 0847a342..8dd85a7f 100644 --- a/settings.example.json +++ b/settings.example.json @@ -26,50 +26,23 @@ }, "plugins.default": false, "//": "Default plugin state (advised to let 'false' unless in debug mode)", "plugins": { "//": "Global plugin configuration", - "activity":{ - "enabled": false, "//": "Display recent activity" - }, - "contributors":{ - "enabled": false, "//": "Display repository contributors" - }, - "followup":{ - "enabled": false, "//": "Display follow-up of repositories issues and pull requests" - }, - "gists":{ - "enabled": false, "//": "Display gists metrics" - }, - "habits":{ - "enabled": false, "//": "Display coding habits metrics" - }, - "introduction":{ - "enabled": false, "//": "Display account or repository introduction" - }, "isocalendar":{ "enabled": false, "//": "Display an isometric view of your commits calendar" }, "languages":{ "enabled": false, "//": "Display most used languages metrics" }, + "introduction":{ + "enabled": false, "//": "Display account or repository introduction" + }, + "habits":{ + "enabled": false, "//": "Display coding habits metrics" + }, "licenses":{ "enabled": false, "//": "Display licenses informations" }, - "lines":{ - "enabled": false, "//": "Display lines of code metrics" - }, - "people":{ - "enabled": false, "//": "Display GitHub users from various affiliations" - }, - "projects":{ - "enabled": false, "//": "Display active projects" - }, - "reactions":{ - "enabled": false, "//": "Display average issue comments reactions" - }, - "skyline":{ - "enabled": false, "//": "Display GitHub Skyline 3D calendar" - }, - "stargazers":{ - "enabled": false, "//": "Display stargazers metrics" + "contributors":{ + "enabled": false, "//": "Display repository contributors" }, "stars":{ "enabled": false, "//": "Display recently starred repositories" @@ -77,30 +50,57 @@ "topics":{ "enabled": false, "//": "Display starred topics" }, + "reactions":{ + "enabled": false, "//": "Display average issue comments reactions" + }, + "people":{ + "enabled": false, "//": "Display GitHub users from various affiliations" + }, + "gists":{ + "enabled": false, "//": "Display gists metrics" + }, + "followup":{ + "enabled": false, "//": "Display follow-up of repositories issues and pull requests" + }, + "lines":{ + "enabled": false, "//": "Display lines of code metrics" + }, "traffic":{ "enabled": false, "//": "Display repositories traffic metrics" }, - "anilist":{ - "enabled": false, "//": "Display data from your AniList account" + "stargazers":{ + "enabled": false, "//": "Display stargazers metrics" }, - "music":{ - "token": null, "//":"Music provider personal token", - "enabled": false, "//": "Display your music tracks" + "projects":{ + "enabled": false, "//": "Display active projects" + }, + "activity":{ + "enabled": false, "//": "Display recent activity" + }, + "skyline":{ + "enabled": false, "//": "Display GitHub Skyline 3D calendar" }, "pagespeed":{ "token": null, "//":"PageSpeed token", "enabled": false, "//": "Display a website Google PageSpeed metrics" }, - "posts":{ - "enabled": false, "//": "Display recent posts" - }, - "stackoverflow":{ - "enabled": false, "//": "Stackoverflow metrics" + "music":{ + "token": null, "//":"Music provider personal token", + "enabled": false, "//": "Display your music tracks" }, "tweets":{ "token": null, "//":"Twitter API token", "enabled": false, "//": "Display recent tweets" }, + "anilist":{ + "enabled": false, "//": "Display data from your AniList account" + }, + "stackoverflow":{ + "enabled": false, "//": "Stackoverflow metrics" + }, + "posts":{ + "enabled": false, "//": "Display recent posts" + }, "wakatime":{ "token": null, "//":"WakaTime API token", "enabled": false, "//": "Display WakaTime stats" diff --git a/source/app/metrics/metadata.mjs b/source/app/metrics/metadata.mjs index 5408c767..323e7fd2 100644 --- a/source/app/metrics/metadata.mjs +++ b/source/app/metrics/metadata.mjs @@ -29,8 +29,8 @@ } //Reorder keys const {base, core, ...plugins} = Plugins //eslint-disable-line no-unused-vars - Plugins = Object.fromEntries(Object.entries(Plugins).sort(([_an, a], [_bn, b]) => categories.indexOf(a.categorie) - categories.indexOf(b.categorie))) - + Plugins = Object.fromEntries(Object.entries(Plugins).sort(([_an, a], [_bn, b]) => a.categorie === b.categorie ? (a.index ?? Infinity) - (b.index ?? Infinity) : categories.indexOf(a.categorie) - categories.indexOf(b.categorie))) + logger(`metrics/metadata > loaded [${Object.keys(Plugins).join(", ")}]`) //Load templates metadata let Templates = {} logger("metrics/metadata > loading templates metadata") diff --git a/source/plugins/README.md b/source/plugins/README.md index 9f4fcb32..adb1dd96 100644 --- a/source/plugins/README.md +++ b/source/plugins/README.md @@ -7,31 +7,31 @@ See their respective documentation for more informations about how to setup them * [🗃️ Base content](/source/plugins/base/README.md) * [🧱 Core](/source/plugins/core/README.md) * **Github** - * [📰 Recent activity](/source/plugins/activity/README.md) - * [🏅 Repository contributors](/source/plugins/contributors/README.md) - * [🎟️ Follow-up of issues and pull requests](/source/plugins/followup/README.md) - * [🎫 Gists](/source/plugins/gists/README.md) - * [💡 Coding habits](/source/plugins/habits/README.md) - * [🙋 Introduction](/source/plugins/introduction/README.md) * [📅 Isometric commit calendar](/source/plugins/isocalendar/README.md) * [🈷️ Most used languages](/source/plugins/languages/README.md) + * [🙋 Introduction](/source/plugins/introduction/README.md) + * [💡 Coding habits](/source/plugins/habits/README.md) * [📜 Repository licenses](/source/plugins/licenses/README.md) - * [👨‍💻 Lines of code changed](/source/plugins/lines/README.md) - * [🧑‍🤝‍🧑 People plugin](/source/plugins/people/README.md) - * [🗂️ Active projects](/source/plugins/projects/README.md) - * [🎭 Comment reactions](/source/plugins/reactions/README.md) - * [🌇 GitHub Skyline 3D calendar](/source/plugins/skyline/README.md) - * [✨ Stargazers over last weeks](/source/plugins/stargazers/README.md) + * [🏅 Repository contributors](/source/plugins/contributors/README.md) * [🌟 Recently starred repositories](/source/plugins/stars/README.md) * [📌 Starred topics](/source/plugins/topics/README.md) + * [🎭 Comment reactions](/source/plugins/reactions/README.md) + * [🧑‍🤝‍🧑 People plugin](/source/plugins/people/README.md) + * [🎫 Gists](/source/plugins/gists/README.md) + * [🎟️ Follow-up of issues and pull requests](/source/plugins/followup/README.md) + * [👨‍💻 Lines of code changed](/source/plugins/lines/README.md) * [🧮 Repositories traffic](/source/plugins/traffic/README.md) + * [✨ Stargazers over last weeks](/source/plugins/stargazers/README.md) + * [🗂️ Active projects](/source/plugins/projects/README.md) + * [📰 Recent activity](/source/plugins/activity/README.md) + * [🌇 GitHub Skyline 3D calendar](/source/plugins/skyline/README.md) * **Social** - * [🌸 Anilist watch list and reading list](/source/plugins/anilist/README.md) - * [🎼 Music plugin](/source/plugins/music/README.md) * [⏱️ Website performances](/source/plugins/pagespeed/README.md) - * [✒️ Recent posts](/source/plugins/posts/README.md) - * [🗨️ Stackoverflow plugin](/source/plugins/stackoverflow/README.md) + * [🎼 Music plugin](/source/plugins/music/README.md) * [🐤 Latest tweets](/source/plugins/tweets/README.md) + * [🌸 Anilist watch list and reading list](/source/plugins/anilist/README.md) + * [🗨️ Stackoverflow plugin](/source/plugins/stackoverflow/README.md) + * [✒️ Recent posts](/source/plugins/posts/README.md) * [⏰ WakaTime plugin](/source/plugins/wakatime/README.md) * **Health** * [💉 Nightscout](/source/plugins/nightscout/README.md) diff --git a/source/plugins/activity/metadata.yml b/source/plugins/activity/metadata.yml index 9444c809..660bc302 100644 --- a/source/plugins/activity/metadata.yml +++ b/source/plugins/activity/metadata.yml @@ -1,6 +1,7 @@ name: "📰 Recent activity" cost: 1 REST request per 100 events categorie: github +index: 16 supports: - user - organization diff --git a/source/plugins/anilist/metadata.yml b/source/plugins/anilist/metadata.yml index af17d25a..84edd810 100644 --- a/source/plugins/anilist/metadata.yml +++ b/source/plugins/anilist/metadata.yml @@ -1,6 +1,7 @@ name: "🌸 Anilist watch list and reading list" cost: N/A categorie: social +index: 4 supports: - user - organization diff --git a/source/plugins/contributors/README.md b/source/plugins/contributors/README.md index 29b71ad7..b38c5bbf 100644 --- a/source/plugins/contributors/README.md +++ b/source/plugins/contributors/README.md @@ -7,7 +7,7 @@ It's especially useful to acknowledge contributors on release notes.
-
With number of contributions +
With number of contributions
diff --git a/source/plugins/contributors/metadata.yml b/source/plugins/contributors/metadata.yml index d33e4f4d..16333c8e 100644 --- a/source/plugins/contributors/metadata.yml +++ b/source/plugins/contributors/metadata.yml @@ -1,6 +1,7 @@ name: "🏅 Repository contributors" cost: N/A categorie: github +index: 5 supports: - repository inputs: diff --git a/source/plugins/followup/metadata.yml b/source/plugins/followup/metadata.yml index 1dd6f6f5..cc9f387c 100644 --- a/source/plugins/followup/metadata.yml +++ b/source/plugins/followup/metadata.yml @@ -1,6 +1,7 @@ name: "🎟️ Follow-up of issues and pull requests" cost: 0 API request categorie: github +index: 11 supports: - user - organization diff --git a/source/plugins/gists/metadata.yml b/source/plugins/gists/metadata.yml index 09d22aec..607e91d1 100644 --- a/source/plugins/gists/metadata.yml +++ b/source/plugins/gists/metadata.yml @@ -1,6 +1,7 @@ name: "🎫 Gists" cost: 1 GraphQL request per 100 gists categorie: github +index: 10 supports: - user inputs: diff --git a/source/plugins/habits/metadata.yml b/source/plugins/habits/metadata.yml index 3155c3b8..4da802af 100644 --- a/source/plugins/habits/metadata.yml +++ b/source/plugins/habits/metadata.yml @@ -1,6 +1,7 @@ name: "💡 Coding habits" cost: 1 REST request per 100 events + 1 REST request pet commit categorie: github +index: 3 supports: - user - organization diff --git a/source/plugins/introduction/metadata.yml b/source/plugins/introduction/metadata.yml index 214092cd..a8fd988d 100644 --- a/source/plugins/introduction/metadata.yml +++ b/source/plugins/introduction/metadata.yml @@ -1,6 +1,7 @@ name: "🙋 Introduction" cost: 1 GraphQL request categorie: github +index: 2 supports: - user - organization diff --git a/source/plugins/isocalendar/metadata.yml b/source/plugins/isocalendar/metadata.yml index b6bc11d1..1fcd790f 100644 --- a/source/plugins/isocalendar/metadata.yml +++ b/source/plugins/isocalendar/metadata.yml @@ -1,6 +1,7 @@ name: "📅 Isometric commit calendar" cost: 2-3 REST requests categorie: github +index: 0 supports: - user inputs: diff --git a/source/plugins/languages/metadata.yml b/source/plugins/languages/metadata.yml index 9b9ffada..ea0c27b2 100644 --- a/source/plugins/languages/metadata.yml +++ b/source/plugins/languages/metadata.yml @@ -1,6 +1,7 @@ name: "🈷️ Most used languages" cost: 0 API request categorie: github +index: 1 supports: - user - organization diff --git a/source/plugins/licenses/metadata.yml b/source/plugins/licenses/metadata.yml index 15dc8af5..238e7adc 100644 --- a/source/plugins/licenses/metadata.yml +++ b/source/plugins/licenses/metadata.yml @@ -1,6 +1,7 @@ name: "📜 Repository licenses" cost: N/A categorie: github +index: 4 supports: - repository inputs: diff --git a/source/plugins/lines/metadata.yml b/source/plugins/lines/metadata.yml index 2f7c851a..d8b081ca 100644 --- a/source/plugins/lines/metadata.yml +++ b/source/plugins/lines/metadata.yml @@ -1,6 +1,7 @@ name: "👨‍💻 Lines of code changed" cost: 1 REST request per repository categorie: github +index: 12 supports: - user - organization diff --git a/source/plugins/music/metadata.yml b/source/plugins/music/metadata.yml index 9fa1344d..1e3c166b 100644 --- a/source/plugins/music/metadata.yml +++ b/source/plugins/music/metadata.yml @@ -1,6 +1,7 @@ name: "🎼 Music plugin" cost: N/A categorie: social +index: 2 supports: - user - organization diff --git a/source/plugins/nightscout/metadata.yml b/source/plugins/nightscout/metadata.yml index 74f1d6f6..4cad5c59 100644 --- a/source/plugins/nightscout/metadata.yml +++ b/source/plugins/nightscout/metadata.yml @@ -1,6 +1,7 @@ name: "💉 Nightscout" cost: N/A categorie: health +index: 1 supports: - user - organization diff --git a/source/plugins/pagespeed/metadata.yml b/source/plugins/pagespeed/metadata.yml index 008fdd43..e695cb93 100644 --- a/source/plugins/pagespeed/metadata.yml +++ b/source/plugins/pagespeed/metadata.yml @@ -1,6 +1,7 @@ name: "⏱️ Website performances" cost: N/A categorie: social +index: 1 supports: - user - organization diff --git a/source/plugins/people/metadata.yml b/source/plugins/people/metadata.yml index cbc3be3c..0da16dd5 100644 --- a/source/plugins/people/metadata.yml +++ b/source/plugins/people/metadata.yml @@ -1,6 +1,7 @@ name: "🧑‍🤝‍🧑 People plugin" cost: 1 GraphQL request per 100 users + 1 REST request per user in "plugin_people_thanks" categorie: github +index: 9 supports: - user - organization diff --git a/source/plugins/posts/metadata.yml b/source/plugins/posts/metadata.yml index fa46a5d7..f8639c5a 100644 --- a/source/plugins/posts/metadata.yml +++ b/source/plugins/posts/metadata.yml @@ -1,6 +1,7 @@ name: "✒️ Recent posts" cost: N/A categorie: social +index: 6 supports: - user - organization diff --git a/source/plugins/projects/metadata.yml b/source/plugins/projects/metadata.yml index 570d7582..a22740ee 100644 --- a/source/plugins/projects/metadata.yml +++ b/source/plugins/projects/metadata.yml @@ -1,6 +1,7 @@ name: "🗂️ Active projects" cost: 1 GraphQL request + 1 GraphQL request per repository project categorie: github +index: 15 supports: - user - organization diff --git a/source/plugins/reactions/metadata.yml b/source/plugins/reactions/metadata.yml index 813459b9..2a1d081f 100644 --- a/source/plugins/reactions/metadata.yml +++ b/source/plugins/reactions/metadata.yml @@ -1,6 +1,7 @@ name: "🎭 Comment reactions" cost: 1 GraphQL request per 100 issues and issues comments fetched categorie: github +index: 8 supports: - user inputs: diff --git a/source/plugins/skyline/metadata.yml b/source/plugins/skyline/metadata.yml index 790b0c56..4fd866c8 100644 --- a/source/plugins/skyline/metadata.yml +++ b/source/plugins/skyline/metadata.yml @@ -1,6 +1,7 @@ name: "🌇 GitHub Skyline 3D calendar" cost: N/A categorie: github +index: 18 supports: - user inputs: diff --git a/source/plugins/stackoverflow/metadata.yml b/source/plugins/stackoverflow/metadata.yml index 04d35896..7bca964c 100644 --- a/source/plugins/stackoverflow/metadata.yml +++ b/source/plugins/stackoverflow/metadata.yml @@ -1,6 +1,7 @@ name: "🗨️ Stackoverflow plugin" cost: N/A categorie: social +index: 5 supports: - user - organization diff --git a/source/plugins/stargazers/metadata.yml b/source/plugins/stargazers/metadata.yml index a2f18003..bd29e290 100644 --- a/source/plugins/stargazers/metadata.yml +++ b/source/plugins/stargazers/metadata.yml @@ -1,6 +1,7 @@ name: "✨ Stargazers over last weeks" cost: 1 GraphQL request per 100 stargazers categorie: github +index: 14 supports: - user - organization diff --git a/source/plugins/stars/metadata.yml b/source/plugins/stars/metadata.yml index 2dafd3db..e82526c5 100644 --- a/source/plugins/stars/metadata.yml +++ b/source/plugins/stars/metadata.yml @@ -1,6 +1,7 @@ name: "🌟 Recently starred repositories" cost: 1 GraphQL request categorie: github +index: 6 supports: - user inputs: diff --git a/source/plugins/topics/metadata.yml b/source/plugins/topics/metadata.yml index bf858eb6..800b7ca1 100644 --- a/source/plugins/topics/metadata.yml +++ b/source/plugins/topics/metadata.yml @@ -1,6 +1,7 @@ name: "📌 Starred topics" cost: N/A categorie: github +index: 7 supports: - user inputs: diff --git a/source/plugins/traffic/metadata.yml b/source/plugins/traffic/metadata.yml index c1c889d9..4393a0d7 100644 --- a/source/plugins/traffic/metadata.yml +++ b/source/plugins/traffic/metadata.yml @@ -1,6 +1,7 @@ name: "🧮 Repositories traffic" cost: 1 REST request per repository categorie: github +index: 13 supports: - user - organization diff --git a/source/plugins/tweets/metadata.yml b/source/plugins/tweets/metadata.yml index efd9b2d6..c29e276f 100644 --- a/source/plugins/tweets/metadata.yml +++ b/source/plugins/tweets/metadata.yml @@ -1,6 +1,7 @@ name: "🐤 Latest tweets" cost: N/A categorie: social +index: 3 supports: - user - organization diff --git a/source/plugins/wakatime/metadata.yml b/source/plugins/wakatime/metadata.yml index c6a09a1b..009924b5 100644 --- a/source/plugins/wakatime/metadata.yml +++ b/source/plugins/wakatime/metadata.yml @@ -1,6 +1,7 @@ name: "⏰ WakaTime plugin" cost: N/A categorie: social +index: 7 supports: - user inputs: