feat: display scripts errors in FL results

Author: Koalhack

icon/error.png

@@ -9,8 +9,17 @@ const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 const __rootpath = path.resolve(__dirname, '..');
 
+// ─── Scripts ─────────────────────────────────────────────────────────────────────────
+
 export const defaultScriptPath = path.join(__rootpath, 'dist', 'scripts/');
 
+// ─── Icon ────────────────────────────────────────────────────────────────────────────
+
+export const ICON = {
+  app: path.join(__rootpath, 'icon', 'app.png'),
+  error: path.join(__rootpath, 'icon', 'error.png')
+};
+
 // ┌           ┐
 // │   Metas   │
 // └           ┘

src/const.ts

@@ -14,11 +14,16 @@ export class FlowViewController {
 
   // ─── METHOD: query ───────────────────────────────────────────────────────────────────
   queryScript(parameter: string = '') {
-    const results = this.scriptManager.search(parameter ?? '');
-    const resultsFmt = FlowLauncher.searchResultFormat(results);
+    const normalizeQuery = parameter.toLowerCase();
+
+    const errorResults = this.scriptManager.scriptsError;
+    const errorsFMT = FlowLauncher.searchScriptErrorResultFMT(errorResults);
+
+    const scriptResults = this.scriptManager.search(normalizeQuery);
+    const scriptsFMT = FlowLauncher.searchScriptResultFMT(scriptResults);
 
     // Send result to Flow laucher via JsonRPC
-    sendJsonRpcRequest({ result: resultsFmt });
+    sendJsonRpcRequest({ result: [...errorsFMT, ...scriptsFMT] });
   }
 
   // ─── METHOD: run ─────────────────────────────────────────────────────────────────────

src/controllers/FlowViewController.ts

@@ -0,0 +1,13 @@
+type ScriptErrorArguments = {
+  file: string;
+  error: Error;
+};
+
+export class ScriptError {
+  filename: string;
+  err: Error;
+  constructor({ file, error }: ScriptErrorArguments) {
+    this.filename = file;
+    this.err = error;
+  }
+}

src/models/ScriptError.ts

@@ -3,6 +3,7 @@ import path from 'node:path';
 import type { Metas } from './types.js';
 import { Script, type ScriptArguments } from './models/Script.js';
 import { ScriptExecution } from './models/ScriptExecution.js';
+import { ScriptError } from './models/ScriptError.js';
 import {
   defaultScriptPath,
   metaEndTerm,
@@ -13,12 +14,15 @@ import {
 import { matchesObject, sortByProperty, stringRange } from './utils/utils.js';
 import { Clipboard } from './utils/clipboard.js';
 import { FlowLauncher } from './utils/flowLauncher.js';
+import { ensureError } from './utils/error.js';
 
 export class ScriptManager {
   scripts: Script[];
+  scriptsError: ScriptError[];
 
   constructor() {
     this.scripts = [];
+    this.scriptsError = [];
   }
 
   init() {
@@ -50,8 +54,13 @@ export class ScriptManager {
       });
 
       this.scripts.push(scriptObject);
-    } catch (e) {
-      console.error(`Unable to load ${path}, Error: ${e}`);
+    } catch (err) {
+      const error = ensureError(err);
+      const scriptErrorObject = new ScriptError({
+        file: path,
+        error: error
+      });
+      this.scriptsError.push(scriptErrorObject);
     }
   }
 

src/scriptManager.ts

@@ -0,0 +1,17 @@
+/**
+ * Return Error based on unknown potential error
+ * @param value the unknown error to convert to true Error
+ */
+export function ensureError(value: unknown): Error {
+  if (value instanceof Error) return value;
+
+  let stringified = '[Unable to stringify the thrown value]';
+  try {
+    stringified = JSON.stringify(value);
+  } catch {}
+
+  const error = new Error(
+    `This value was thrown as is, not through an Error: ${stringified}`
+  );
+  return error;
+}

src/utils/error.ts

@@ -1,12 +1,14 @@
+import { ICON } from '../const.js';
 import type { Script } from '../models/Script.js';
+import type { ScriptError } from '../models/ScriptError.js';
 import type { Result } from '../types.js';
 
 export const FlowLauncher = {
   /**
    * Return reformatted list of scripts for Flow Launcher
    * @param scripts list of scripts to format.
    */
-  searchResultFormat: function (scripts: Script[]): Result[] {
+  searchScriptResultFMT: function (scripts: Script[]): Result[] {
     return scripts.map(script => ({
       Title: script.name ?? 'No Name',
       Subtitle: script.desc ?? 'No description',
@@ -20,10 +22,28 @@ export const FlowLauncher = {
           })
         ]
       },
-      IcoPath: 'icon\\app.png',
+      IcoPath: ICON.app,
       score: 0
     }));
   },
+
+  /**
+   * Return reformatted list of scripts Errors for Flow Launcher
+   * @param scriptErrors list of scripts errors to format.
+   */
+  searchScriptErrorResultFMT: function (scriptErrors: ScriptError[]): Result[] {
+    return scriptErrors.map(scriptError => ({
+      Title: `Unable to load ${scriptError.filename ?? 'No filename'}`,
+      Subtitle: `Error: ${scriptError.err.message ?? 'No error'}`,
+      JsonRPCAction: {
+        method: '', // TODO: add script error function
+        parameters: []
+      },
+      IcoPath: ICON.error,
+      score: 0
+    }));
+  },
+
   /**
    * Shows a desktop notification.
    * @param title The notification title.