Update documentation and reorder plugins by categorie

.github/quickstart/plugin/metadata.yml

@@ -1,15 +1,10 @@
 name: "🧩 <%= `${name.charAt(0).toLocaleUpperCase()}${name.substring(1)}` %>"
-
-# Estimate of how many GitHub requests will be used
-cost: N/A
-
-# Supported modes
+cost: Estimates how many GitHub requests is used during plugin execution ("N/A" for Third-Party services)
+categorie: other  # Set plugin categorie ("github", "social", "health" or "other")
 supports:
-  - user
-  - organization
-  - repository
-
-# Inputs list
+  - user          # Support users account
+  - organization  # Support organizations account
+  - repository    # Support repositories metrics
 inputs:
 
   # Enable or disable plugin

.github/readme/README.md

@@ -2,6 +2,6 @@
 
 ![Build](https://github.com/lowlighter/metrics/workflows/Build/badge.svg)
 
-<% for (const partial of ["introduction", "shared", "setup", "documentation", "references", "license"]) { -%>
+<% for (const partial of ["introduction", "shared", "setup", "documentation", "license", "references"]) { -%>
 <%- await include(`/partials/${partial}.md`) %>
 <% } %>

.github/readme/partials/documentation/compatibility.md

@@ -3,8 +3,8 @@
 <table>
   <tr>
     <th nowrap="nowrap">Template\Plugin</th><%# -%>
-    <% for (const [plugin, {icon}] of Object.entries(plugins).filter(([key, value]) => (value)&&(!["core"].includes(key)))) { %>
-    <th nowrap="nowrap" align="center"><%= icon %></th><% } %>
+    <% for (const [plugin, {name, icon}] of Object.entries(plugins).filter(([key, value]) => (value)&&(!["core"].includes(key)))) { %>
+    <th nowrap="nowrap" align="center" title="<%= name %>"><%= icon %></th><% } %>
   </tr><%# -%>
   <% for (const [template, {name, readme}] of Object.entries(templates).filter(([key, value]) => (value)&&(!["community"].includes(key)))) { %>
   <tr>

.github/readme/partials/documentation/plugins.md

@@ -2,6 +2,9 @@
 
 Plugins are features which provide additional content and lets you customize your rendered metrics.
 See their respective documentation for more informations about how to setup them:
-<% for (const [plugin, {name}] of Object.entries(plugins).filter(([key, value]) => value)) { %>
-* [<%= name %>](/source/plugins/<%= plugin %>/README.md)<%# -%>
-<% } %>
+<% { let previous = null; for (const [plugin, {name, categorie}] of Object.entries(plugins).filter(([key, value]) => value)) { %>
+<% if (previous !== categorie) { previous = categorie -%>
+* **<%= `${categorie.charAt(0).toLocaleUpperCase()}${categorie.substring(1)}` %>**
+<% } -%>
+  * [<%= name %>](/source/plugins/<%= plugin %>/README.md)<%# -%>
+<% }} %>

CONTRIBUTING.md

@@ -298,6 +298,7 @@ Here's an example:
 ```yaml
 name: "🧩 Plugin name (with emoji icon)"
 cost: Estimates how many GitHub requests is used during plugin execution ("N/A" for Third-Party services)
+categorie: github # Plugin categorie ("github", "social", "health" or "other")
 supports:
   - user          # Support users account
   - organization  # Support organizations account

source/app/metrics/metadata.mjs

@@ -4,6 +4,9 @@
   import url from "url"
   import yaml from "js-yaml"
 
+//Defined categories
+  const categories = ["core", "github", "social", "health", "other"]
+
 /**Metadata descriptor parser */
   export default async function metadata({log = true} = {}) {
     //Paths
@@ -25,7 +28,7 @@
       }
     //Reorder keys
       const {base, core, ...plugins} = Plugins
-      Plugins = {base, core, ...plugins}
+      Plugins = Object.fromEntries(Object.entries(Plugins).sort(([_an, a], [_bn, b]) => categories.indexOf(a.categorie) - categories.indexOf(b.categorie)))
 
     //Load templates metadata
       let Templates = {}
@@ -53,6 +56,10 @@
         const raw = `${await fs.promises.readFile(path.join(__plugins, name, "metadata.yml"), "utf-8")}`
         const {inputs, ...meta} = yaml.load(raw)
 
+      //Categorie
+        if (!categories.includes(meta.categorie))
+          meta.categorie = "other"
+
       //Inputs parser
         {
           meta.inputs = function({data:{user = null} = {}, q, account}, defaults = {}) {
@@ -260,7 +267,7 @@
         return {
           name:raw.match(/^### (?<name>[\s\S]+?)\n/)?.groups?.name?.trim(),
           readme:{
-            demo:raw.match(/(?<demo><table>[\s\S]*?<[/]table>)/)?.groups?.demo?.replace(/<[/]?(?:table|tr)>/g, "")?.trim() ?? (name === "community" ? "<td align=\"center\">See <a href=\"/source/templates/community/README.md\">documentation</a> 🌍</td>" : "<td></td>"),
+            demo:raw.match(/(?<demo><table>[\s\S]*?<[/]table>)/)?.groups?.demo?.replace(/<[/]?(?:table|tr)>/g, "")?.trim() ?? (name === "community" ? "<td align=\"center\"><h3>See <a href=\"/source/templates/community/README.md\">documentation</a> 🌍</h3></td>" : "<td></td>"),
             compatibility:{...compatibility, base:true},
           },
         }

source/plugins/contributors/metadata.yml

@@ -1,5 +1,6 @@
 name: "🏅 Contributors"
 cost: N/A
+categorie: github
 supports:
   - repository
 inputs:

source/plugins/licenses/metadata.yml

@@ -1,5 +1,6 @@
 name: "📜 Licenses"
 cost: N/A
+categorie: github
 supports:
   - repository
 inputs: