feat(app): improved errors and warning for disabled features

Author: lowlighter

.github/readme/partials/templated/plugins.community.md

@@ -3,7 +3,7 @@ export default async function({login, q, imports, data, computed, rest, graphql,
   //Plugin execution
   try {
     //Check if plugin is enabled and requirements are met
-    if ((!enabled) || (!q.<%= name %>) || (!imports.metadata.plugins.<%= name %>.extras("enabled", {extras})))
+    if ((!q.<%= name %>) || (!imports.metadata.plugins.<%= name %>.enabled(enabled, {extras})))
       return null
     //Results
     return {}

.github/scripts/quickstart/plugin/index.mjs

@@ -217,9 +217,20 @@ metadata.plugin = async function({__plugins, __templates, name, logger}) {
       Object.assign(meta.inputs, inputs, Object.fromEntries(Object.entries(inputs).map(([key, value]) => [metadata.to.query(key, {name}), value])))
     }
 
+    //Enable state handler
+    {
+      meta.enabled = function(enabled, {extras = {}, error = true} = {}) {
+        if ((process.env.GITHUB_ACTIONS)&&(!enabled))
+          console.warn(`::warning::Plugin "${name}" is currently disabled. Add "plugin_${name}: yes" to your workflow to enable it.`)
+        if ((error)&&(!enabled))
+          throw Object.assign(new Error(`Plugin "${name}" is disabled${process.env.GITHUB_ACTIONS ? "" : " on this server"}`), {enabled: true})
+        return (enabled) && (meta.extras("enabled", {extras, error}))
+      }
+    }
+
     //Extra features parser
     {
-      meta.extras = function(input, {extras = {}, error = true}) {
+      meta.extras = function(input, {extras = {}, error = true} = {}) {
         const key = metadata.to.yaml(input, {name})
         try {
           //Required permissions
@@ -270,7 +281,7 @@ metadata.plugin = async function({__plugins, __templates, name, logger}) {
             console.debug(`metrics/extras > ${name} > ${key} > skipping (no error mode)`)
             return false
           }
-          throw Object.assign(new Error(`Unsupported option "${key}"`), {extras: true})
+          throw Object.assign(new Error(`Option "${key}" is disabled on this server`), {extras: true})
         }
       }
     }

source/app/metrics/metadata.mjs

@@ -130,8 +130,8 @@ export function formatters({timeZone} = {}) {
   /**Error formatter */
   format.error = function(error, {descriptions = {}, ...attributes} = {}) {
     try {
-      //Extras features error
-      if (error.extras)
+      //Extras features or enable state error
+      if ((error.extras)||(error.enabled))
         throw {error: {message: error.message, instance: error}}
       //Already formatted error
       if (error.error?.message)

source/app/metrics/utils.mjs

@@ -6,7 +6,7 @@ export default async function({login, q, imports, data, computed, graphql, queri
   //Plugin execution
   try {
     //Check if plugin is enabled and requirements are met
-    if ((!enabled) || (!q.achievements) || (!imports.metadata.plugins.achievements.extras("enabled", {extras})))
+    if ((!q.achievements) || (!imports.metadata.plugins.achievements.enabled(enabled, {extras})))
       return null
 
     //Load inputs

source/plugins/achievements/index.mjs

@@ -3,7 +3,7 @@ export default async function({login, data, rest, q, account, imports}, {enabled
   //Plugin execution
   try {
     //Check if plugin is enabled and requirements are met
-    if ((!enabled) || (!q.activity) || (!imports.metadata.plugins.activity.extras("enabled", {extras})))
+    if ((!q.activity) || (!imports.metadata.plugins.activity.enabled(enabled, {extras})))
       return null
 
     //Context

source/plugins/activity/index.mjs

@@ -3,7 +3,7 @@ export default async function({login, data, queries, imports, q, account}, {enab
   //Plugin execution
   try {
     //Check if plugin is enabled and requirements are met
-    if ((!enabled) || (!q.anilist) || (!imports.metadata.plugins.anilist.extras("enabled", {extras})))
+    if ((!q.anilist) || (!imports.metadata.plugins.anilist.enabled(enabled, {extras})))
       return null
 
     //Load inputs

source/plugins/anilist/index.mjs

@@ -3,7 +3,7 @@ export default async function({login, q, data, imports, graphql, queries, accoun
   //Plugin execution
   try {
     //Check if plugin is enabled and requirements are met
-    if ((!enabled) || (!q.calendar) || (!imports.metadata.plugins.calendar.extras("enabled", {extras})))
+    if ((!q.calendar) || (!imports.metadata.plugins.calendar.enabled(enabled, {extras})))
       return null
 
     //Load inputs

source/plugins/calendar/index.mjs

@@ -3,7 +3,7 @@ export default async function({login, q, imports, data, rest, account}, {enabled
   //Plugin execution
   try {
     //Check if plugin is enabled and requirements are met
-    if ((!enabled) || (!q.code) || (!imports.metadata.plugins.code.extras("enabled", {extras})))
+    if ((!q.code) || (!imports.metadata.plugins.code.enabled(enabled, {extras})))
       return null
 
     //Context

source/plugins/code/index.mjs

@@ -3,7 +3,7 @@ export default async function({q, data, imports, account}, {enabled = false, ext
   //Plugin execution
   try {
     //Check if plugin is enabled and requirements are met
-    if ((!enabled) || (!q.fortune) || (!imports.metadata.plugins.fortune.extras("enabled", {extras})))
+    if ((!q.fortune) || (!imports.metadata.plugins.fortune.enabled(enabled, {extras})))
       return null
 
     //Load inputs