cli: Add Interrupt to simplify control flow

Author: sonnyp

demos

@@ -12,7 +12,7 @@ const languageId = "blueprint";
 export default async function blueprint({ file, lspc }) {
   print(`  ${file.get_path()}`);
 
-  const text = await diagnose({
+  await diagnose({
     file,
     lspc,
     languageId,
@@ -21,10 +21,12 @@ export default async function blueprint({ file, lspc }) {
       return ![
         "Gtk.ShortcutsShortcut is deprecated\nhint: This widget will be removed in GTK 5",
         "Gtk.ShortcutLabel is deprecated\nhint: This widget will be removed in GTK 5",
+        "Gtk.ShortcutsWindow is deprecated\nhint: This widget will be removed in GTK 5",
+        "Gtk.ShortcutsGroup is deprecated\nhint: This widget will be removed in GTK 5",
+        "Gtk.ShortcutsSection is deprecated\nhint: This widget will be removed in GTK 5",
       ].includes(diagnostic.message);
     },
   });
-  if (text === false) return false;
 
   const { xml } = await lspc._request("textDocument/x-blueprint-compile", {
     textDocument: {
@@ -53,13 +55,12 @@ export default async function blueprint({ file, lspc }) {
     }
   }
 
-  const checks = await checkFile({
+  await checkFile({
     lspc,
     file,
     lang: getLanguage(languageId),
     uri: file.get_uri(),
   });
-  if (!checks) return false;
 
   await lspc._notify("textDocument/didClose", {
     textDocument: {

src/cli/blueprint.js

@@ -8,16 +8,14 @@ const languageId = "css";
 export default async function css({ file, lspc }) {
   print(`  ${file.get_path()}`);
 
-  const text = await diagnose({ file, lspc, languageId });
-  if (text === false) return false;
+  await diagnose({ file, lspc, languageId });
 
-  const checks = await checkFile({
+  await checkFile({
     lspc,
     file,
     lang: getLanguage(languageId),
     uri: file.get_uri(),
   });
-  if (!checks) return false;
 
   await lspc._notify("textDocument/didClose", {
     textDocument: {

src/cli/css.js

@@ -1,7 +1,7 @@
 /* eslint-disable no-restricted-globals */
 
 import { getLanguage } from "../common.js";
-import { checkFile, getCodeObjectIds, diagnose } from "./util.js";
+import { checkFile, getCodeObjectIds, diagnose, Interrupt } from "./util.js";
 
 const languageId = "javascript";
 
@@ -18,21 +18,19 @@ export default async function javascript({
   print(`  ${file.get_path()}`);
 
   const text = await diagnose({ file, lspc, languageId });
-  if (text === false) return false;
 
-  const checks = await checkFile({
+  await checkFile({
     lspc: lspc,
     file: file,
     lang: getLanguage("javascript"),
     uri: file.get_uri(),
   });
-  if (!checks) return false;
 
   const js_object_ids = getCodeObjectIds(text);
   for (const object_id of js_object_ids) {
     if (!blueprint_object_ids.includes(object_id)) {
       print(`  ❌ Reference to inexistant object id "${object_id}"`);
-      return false;
+      throw new Interrupt();
     }
   }
 

src/cli/javascript.js

@@ -4,6 +4,7 @@ import Gio from "gi://Gio";
 
 import { formatting } from "./format.js";
 import { diagnostic_severities } from "../lsp/LSP.js";
+import { waitForDiagnostics } from "./util.js";
 
 export default async function lint({ filenames, lang, lspc, ci }) {
   let success = true;
@@ -47,19 +48,6 @@ export default async function lint({ filenames, lang, lspc, ci }) {
   return success;
 }
 
-export function waitForDiagnostics({ uri, lspc }) {
-  return new Promise((resolve) => {
-    const handler_id = lspc.connect(
-      "notification::textDocument/publishDiagnostics",
-      (_self, params) => {
-        if (uri !== params.uri) return;
-        lspc.disconnect(handler_id);
-        resolve(params.diagnostics);
-      },
-    );
-  });
-}
-
 function serializeDiagnostics({ file, diagnostics }) {
   return (
     `\n${file.get_path()}\n` +

src/cli/lint.js

@@ -21,6 +21,7 @@ import typescript from "./typescript.js";
 import vala from "./vala.js";
 import python from "./python.js";
 import rust from "./rust.js";
+import { Interrupt } from "./util.js";
 
 GObject.type_ensure(Shumate.SimpleMap);
 GObject.type_ensure(WebKit.WebView);
@@ -30,8 +31,16 @@ export async function main([action, ...args]) {
 
   if (action === "ci") {
     const filenames = args;
-    const success = await ci({ filenames });
-    return success ? 0 : 1;
+    try {
+      await ci({ filenames });
+      return 0;
+    } catch (err) {
+      if (err instanceof Interrupt) {
+        return 1;
+      } else {
+        throw err;
+      }
+    }
   }
 
   const [language_id, ...filenames] = args;
@@ -66,19 +75,27 @@ export async function main([action, ...args]) {
     });
   }
 
-  let success = false;
-
-  if (action === "lint") {
-    success = await lint({ filenames, lang, lspc, ci: false });
-  } else if (action === "check") {
-    success = await lint({ filenames, lang, lspc, ci: true });
-  } else if (action === "format") {
-    success = await format({ filenames, lang, lspc });
-  } else {
-    printerr(`Unknown action "${action}"}`);
+  try {
+    if (action === "lint") {
+      await lint({ filenames, lang, lspc, ci: false });
+      return 0;
+    } else if (action === "check") {
+      await lint({ filenames, lang, lspc, ci: true });
+      return 0;
+    } else if (action === "format") {
+      await format({ filenames, lang, lspc });
+      return 0;
+    } else {
+      printerr(`Unknown action "${action}"}`);
+      return 1;
+    }
+  } catch (err) {
+    if (err instanceof Interrupt) {
+      return 1;
+    } else {
+      throw err;
+    }
   }
-
-  return success ? 0 : 1;
 }
 
 const application = new Adw.Application();
@@ -133,12 +150,10 @@ async function ci({ filenames }) {
 
     const file_blueprint = demo_dir.get_child("main.blp");
     if (file_blueprint.query_exists(null)) {
-      const result = await blueprint({
+      ({ template, builder, blueprint_object_ids } = await blueprint({
         file: file_blueprint,
         lspc: lsp_clients.blueprint,
-      });
-      if (result === false) return;
-      ({ template, builder, blueprint_object_ids } = result);
+      }));
     }
 
     const file_css = demo_dir.get_child("main.css");
@@ -195,8 +210,6 @@ async function ci({ filenames }) {
       }),
     );
   }
-
-  return true;
 }
 
 const key_file = new GLib.KeyFile();

src/cli/main.js

@@ -13,16 +13,14 @@ export default async function python({ file, lspc }) {
     settings: PYTHON_LSP_CONFIG,
   });
 
-  const text = await diagnose({ file, lspc, languageId });
-  if (text === false) return false;
+  await diagnose({ file, lspc, languageId });
 
-  const checks = await checkFile({
+  await checkFile({
     lspc,
     file,
     lang: getLanguage(languageId),
     uri: file.get_uri(),
   });
-  if (!checks) return false;
 
   await lspc._notify("textDocument/didClose", {
     textDocument: {

src/cli/python.js

@@ -27,24 +27,18 @@ export default async function rust({ file, lspc }) {
   // FIXME: rust analyzer doesn't publish diagnostics if there are none
   // probably we should switch to pulling diagnostics but unknown if supported
   // https://microsoft.github.io/language-server-protocol/specifications/lsp/3.18/specification/#textDocument_pullDiagnostics
-
-  // const diagnostics = await waitForDiagnostics({
-  //   uri,
-  //   lspc: lsp_clients.rust,
+  // await diagnose({
+  //   file,
+  //   lspc,
+  //   languageId,
   // });
-  // if (diagnostics.length > 0) {
-  //   printerr(serializeDiagnostics({ diagnostics }));
-  //   return false;
-  // }
-  // print(`  ✅ lints`);
 
-  const checks = await checkFile({
+  await checkFile({
     lspc,
     file,
     lang: getLanguage(languageId),
     uri,
   });
-  if (!checks) return false;
 
   await lspc._notify("textDocument/didClose", {
     textDocument: {

src/cli/rust.js

@@ -1,7 +1,7 @@
 /* eslint-disable no-restricted-globals */
 
 import { getLanguage } from "../common.js";
-import { checkFile, getCodeObjectIds, diagnose } from "./util.js";
+import { checkFile, getCodeObjectIds, diagnose, Interrupt } from "./util.js";
 
 const languageId = "typescript";
 
@@ -18,21 +18,19 @@ export default async function typescript({
   print(`  ${file.get_path()}`);
 
   const text = await diagnose({ file, lspc, languageId });
-  if (text === false) return false;
 
-  const checks = await checkFile({
+  await checkFile({
     lspc,
     file,
     lang: getLanguage(languageId),
     uri: file.get_uri(),
   });
-  if (!checks) return false;
 
   const js_object_ids = getCodeObjectIds(text);
   for (const object_id of js_object_ids) {
     if (!blueprint_object_ids.includes(object_id)) {
       print(`  ❌ Reference to inexistant object id "${object_id}"`);
-      return false;
+      throw new Interrupt();
     }
   }
 

src/cli/typescript.js

@@ -4,7 +4,13 @@ import Gtk from "gi://Gtk";
 
 import { diagnostic_severities } from "../lsp/LSP.js";
 import { formatting } from "./format.js";
-import { waitForDiagnostics } from "./lint.js";
+
+export class Interrupt extends Error {
+  constructor(...args) {
+    super(...args);
+    Error.captureStackTrace?.(this, Interrupt);
+  }
+}
 
 export async function diagnose({
   file,
@@ -36,7 +42,7 @@ export async function diagnose({
   diagnostics = diagnostics.filter(filter);
   if (diagnostics.length > 0) {
     printerr(serializeDiagnostics({ diagnostics }));
-    return false;
+    throw new Interrupt();
   }
 
   print(`  ✅ lints`);
@@ -73,14 +79,13 @@ export async function checkFile({ lspc, file, lang, uri }) {
 
   if (buffer_tmp.text === buffer.text) {
     print(`  ✅ checks`);
-    return true;
   } else {
     printerr(
       `  ❌ formatting differs - open and run ${file
         .get_parent()
         .get_basename()} with Workbench to fix`,
     );
-    return false;
+    throw new Interrupt();
   }
 }
 
@@ -91,3 +96,16 @@ export function getCodeObjectIds(text) {
   }
   return object_ids;
 }
+
+export function waitForDiagnostics({ uri, lspc }) {
+  return new Promise((resolve) => {
+    const handler_id = lspc.connect(
+      "notification::textDocument/publishDiagnostics",
+      (_self, params) => {
+        if (uri !== params.uri) return;
+        lspc.disconnect(handler_id);
+        resolve(params.diagnostics);
+      },
+    );
+  });
+}