From b8c6e2aacaad4c4c84f4c1fa4f5ba7507021404b Mon Sep 17 00:00:00 2001 From: lowlighter <22963968+lowlighter@users.noreply.github.com> Date: Fri, 29 Jul 2022 18:07:00 -0400 Subject: [PATCH] docs: add support for disclaimer and notes --- source/app/metrics/metadata.mjs | 6 +++++- source/plugins/anilist/metadata.yml | 3 +++ source/plugins/code/metadata.yml | 2 +- source/plugins/community/nightscout/metadata.yml | 3 +++ source/plugins/community/poopmap/metadata.yml | 3 +++ source/plugins/licenses/metadata.yml | 5 +++++ source/plugins/music/metadata.yml | 3 +++ source/plugins/pagespeed/metadata.yml | 3 +++ source/plugins/projects/metadata.yml | 2 +- source/plugins/repositories/metadata.yml | 2 +- source/plugins/skyline/metadata.yml | 2 +- source/plugins/stackoverflow/metadata.yml | 3 +++ source/plugins/tweets/metadata.yml | 3 +++ source/plugins/wakatime/metadata.yml | 3 +++ 14 files changed, 38 insertions(+), 5 deletions(-) diff --git a/source/app/metrics/metadata.mjs b/source/app/metrics/metadata.mjs index 291fc0b9..63593762 100644 --- a/source/app/metrics/metadata.mjs +++ b/source/app/metrics/metadata.mjs @@ -98,9 +98,11 @@ metadata.plugin = async function({__plugins, __templates, name, logger}) { const {inputs, ...meta} = yaml.load(raw) Object.assign(metadata.inputs, inputs) - //category + //Category if (!categories.includes(meta.category)) meta.category = "community" + if ((meta.category === "github")&&(!meta.disclaimer)) + meta.disclaimer = "This plugin is not affiliated, associated, authorized, endorsed by, or in any way officially connected with [GitHub](https://github.com).\nAll product and company names are trademarks™ or registered® trademarks of their respective holders." //Inputs parser { @@ -397,6 +399,8 @@ metadata.plugin = async function({__plugins, __templates, name, logger}) { `

${meta.name}

`, ` ${marked.parse(meta.description ?? "", {silent: true})}`, meta.deprecation ? ` ⚠️ Deprecated${marked.parse(meta.deprecation ?? "", {silent: true})}` : "", + meta.disclaimer ? ` ⚠️ Disclaimer${marked.parse(meta.disclaimer ?? "", {silent: true})}` : "", + meta.notes ? ` ℹ Additional notes${marked.parse(meta.notes ?? "", {silent: true})}` : "", meta.authors?.length ? `Authors${[meta.authors].flat().map(author => `@${author}`)}` : "", " ", ' Supported features
→ Full specification', diff --git a/source/plugins/anilist/metadata.yml b/source/plugins/anilist/metadata.yml index 3c533f62..0493a9a8 100644 --- a/source/plugins/anilist/metadata.yml +++ b/source/plugins/anilist/metadata.yml @@ -2,6 +2,9 @@ name: 🌸 Anilist watch list and reading list category: social description: | This plugin displays favorites animes, mangas and characters from a [AniList](https://anilist.co) account. +disclaimer: | + This plugin is not affiliated, associated, authorized, endorsed by, or in any way officially connected with [AniList](https://anilist.co). + All product and company names are trademarks™ or registered® trademarks of their respective holders. examples: +for anime watchers: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.anilist.svg for manga readers: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.anilist.manga.svg diff --git a/source/plugins/code/metadata.yml b/source/plugins/code/metadata.yml index fb1db52f..130c47ec 100644 --- a/source/plugins/code/metadata.yml +++ b/source/plugins/code/metadata.yml @@ -2,7 +2,7 @@ name: ♐ Random code snippet category: github description: | This plugin displays a random code snippet from recent activity history. - +notes: | > ⚠️ When improperly configured, this plugin could display private code. > If you work with sensitive data or company code, it is advised to keep this plugin disabled. > Use at your own risk, *metrics* and its authors cannot be held responsible for any resulting code leaks. diff --git a/source/plugins/community/nightscout/metadata.yml b/source/plugins/community/nightscout/metadata.yml index 0130d470..3279a337 100644 --- a/source/plugins/community/nightscout/metadata.yml +++ b/source/plugins/community/nightscout/metadata.yml @@ -2,6 +2,9 @@ name: 💉 Nightscout category: community description: | This plugin displays blood sugar values from a [Nightscout](http://nightscout.info) site. +disclaimer: | + This plugin is not affiliated, associated, authorized, endorsed by, or in any way officially connected with [Nightscout](http://nightscout.info). + All product and company names are trademarks™ or registered® trademarks of their respective holders. examples: default: https://github.com/legoandmars/legoandmars/blob/master/metrics.plugin.nightscout.svg authors: diff --git a/source/plugins/community/poopmap/metadata.yml b/source/plugins/community/poopmap/metadata.yml index 5e3aa018..a890cf0f 100644 --- a/source/plugins/community/poopmap/metadata.yml +++ b/source/plugins/community/poopmap/metadata.yml @@ -2,6 +2,9 @@ name: 💩 PoopMap plugin category: community description: | This plugin displays statistics from a [PoopMap](https://poopmap.net) account. +disclaimer: | + This plugin is not affiliated, associated, authorized, endorsed by, or in any way officially connected with [PoopMap](https://poopmap.net). + All product and company names are trademarks™ or registered® trademarks of their respective holders. examples: default: https://github.com/matievisthekat/matievisthekat/blob/master/metrics.plugin.poopmap.svg authors: diff --git a/source/plugins/licenses/metadata.yml b/source/plugins/licenses/metadata.yml index d0ec8e75..fcd0ba5c 100644 --- a/source/plugins/licenses/metadata.yml +++ b/source/plugins/licenses/metadata.yml @@ -2,6 +2,11 @@ name: 📜 Repository licenses category: github description: | This plugin display repository license informations like permissions, limitations and conditions along with additional stats about dependencies. +notes: | + > ⚠️ This is **NOT** legal advice, use at your own risk + + > 💣 This plugin **SHOULD NOT** be enabled on web instances, since it allows raw command injection. + > This could result in compromised server! examples: +permissions, limitations and conditions: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.licenses.svg +licenses overview: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.licenses.ratio.svg diff --git a/source/plugins/music/metadata.yml b/source/plugins/music/metadata.yml index 392c9ec2..69854f57 100644 --- a/source/plugins/music/metadata.yml +++ b/source/plugins/music/metadata.yml @@ -4,6 +4,9 @@ description: | This plugin can display top and recently listened music tracks or titles from a random playlist. Different music providers are supported. +disclaimer: | + This plugin is not affiliated, associated, authorized, endorsed by, or in any way officially connected with any of the supported provider. + All product and company names are trademarks™ or registered® trademarks of their respective holders. examples: +random tracks from a playlist: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.music.playlist.svg +recently listened: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.music.recent.svg diff --git a/source/plugins/pagespeed/metadata.yml b/source/plugins/pagespeed/metadata.yml index 8ad58bcb..171c620f 100644 --- a/source/plugins/pagespeed/metadata.yml +++ b/source/plugins/pagespeed/metadata.yml @@ -4,6 +4,9 @@ description: | This plugin displays performance statistics of a website. It uses [Google's PageSpeed API](https://developers.google.com/speed/docs/insights/v5/get-started) (same as [web.dev](https://web.dev)), see [performance scoring](https://web.dev/performance-scoring/) and [score calculator](https://googlechrome.github.io/lighthouse/scorecalc/) for more informations about results. +disclaimer: | + This plugin is not affiliated, associated, authorized, endorsed by, or in any way officially connected with [Google PageSpeed](https://pagespeed.web.dev/). + All product and company names are trademarks™ or registered® trademarks of their respective holders. examples: +PageSpeed scores: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.pagespeed.svg PageSpeed scores with detailed report: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.pagespeed.detailed.svg diff --git a/source/plugins/projects/metadata.yml b/source/plugins/projects/metadata.yml index f2bde3dc..620cdffc 100644 --- a/source/plugins/projects/metadata.yml +++ b/source/plugins/projects/metadata.yml @@ -2,7 +2,7 @@ name: 🗂️ GitHub projects category: github description: | This plugin displays progress of profile and repository projects. - +notes: | > ℹ️ This plugin currently only supports [GitHub projects boards](https://docs.github.com/en/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards) and not [GitHub projects (beta)](https://docs.github.com/en/issues/trying-out-the-new-projects-experience/about-projects) examples: default: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.projects.svg diff --git a/source/plugins/repositories/metadata.yml b/source/plugins/repositories/metadata.yml index 494d1175..9157ce77 100644 --- a/source/plugins/repositories/metadata.yml +++ b/source/plugins/repositories/metadata.yml @@ -4,7 +4,7 @@ description: | This plugin displays a list of chosen featured repositories. Since it is possible to [pin repositories](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/pinning-items-to-your-profile) on GitHub, this plugin is mostly intended for external usage. - +notes: | > ⚠️ Due to limitations of using SVG images inside `` tags, clicking on a repository card will not redirect to repository page. examples: +featured: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.repositories.svg diff --git a/source/plugins/skyline/metadata.yml b/source/plugins/skyline/metadata.yml index e96a6054..1c38fbed 100644 --- a/source/plugins/skyline/metadata.yml +++ b/source/plugins/skyline/metadata.yml @@ -2,7 +2,7 @@ name: 🌇 GitHub Skyline category: github description: | This plugin displays the 3D commits calendar from [skyline.github.com](https://skyline.github.com/). - +notes: | > ⚠️ This plugin significantly increase file size, consider using it as standalone. examples: +GitHub Skyline: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.skyline.svg diff --git a/source/plugins/stackoverflow/metadata.yml b/source/plugins/stackoverflow/metadata.yml index 86ec42e8..0a39abc1 100644 --- a/source/plugins/stackoverflow/metadata.yml +++ b/source/plugins/stackoverflow/metadata.yml @@ -2,6 +2,9 @@ name: 🗨️ Stack Overflow category: social description: | This plugin displays stats, questions and answer from [Stack Overflow](https://stackoverflow.com/). +disclaimer: | + This plugin is not affiliated, associated, authorized, endorsed by, or in any way officially connected with [Stack Overflow](https://stackoverflow.com/). + All product and company names are trademarks™ or registered® trademarks of their respective holders. examples: default: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stackoverflow.svg index: 3 diff --git a/source/plugins/tweets/metadata.yml b/source/plugins/tweets/metadata.yml index ceaacc04..929b91a7 100644 --- a/source/plugins/tweets/metadata.yml +++ b/source/plugins/tweets/metadata.yml @@ -2,6 +2,9 @@ name: 🐤 Latest tweets category: social description: | This plugin displays the latest tweets from a [Twitter](https://twitter.com) account. +disclaimer: | + This plugin is not affiliated, associated, authorized, endorsed by, or in any way officially connected with [Twitter](https://twitter.com). + All product and company names are trademarks™ or registered® trademarks of their respective holders. examples: +latest tweets with attachments: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.tweets.attachments.svg latest tweets: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.tweets.svg diff --git a/source/plugins/wakatime/metadata.yml b/source/plugins/wakatime/metadata.yml index e26ab8a6..46faceb1 100644 --- a/source/plugins/wakatime/metadata.yml +++ b/source/plugins/wakatime/metadata.yml @@ -4,6 +4,9 @@ description: | This plugin displays statistics from a [WakaTime](https://wakatime.com) account. It is also compatible with self-hosted instances from [wakapi](https://github.com/muety/wakapi). +disclaimer: | + This plugin is not affiliated, associated, authorized, endorsed by, or in any way officially connected with [WakaTime](https://wakatime.com). + All product and company names are trademarks™ or registered® trademarks of their respective holders. examples: default: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.wakatime.svg index: 8