Refactor document and format code logic

Author: sonnyp

src/Document.js

@@ -2,18 +2,26 @@ import Source from "gi://GtkSource";
 import Gio from "gi://Gio";
 import GLib from "gi://GLib";
 
-export default function Document({ session, code_view, lang }) {
-  const { buffer } = code_view;
-  let handler_id = null;
+export default class Document {
+  handler_id = null;
 
-  const file = session.file.get_child(lang.default_file);
-  const source_file = new Source.File({
-    location: file,
-  });
+  constructor({ session, code_view, lang }) {
+    this.code_view = code_view;
+    this.buffer = code_view.buffer;
+    this.session = session;
+    this.source_view = code_view.source_view;
+
+    const file = session.file.get_child(lang.default_file);
+    this.file = file;
+    this.source_file = new Source.File({
+      location: file,
+    });
 
-  start();
+    this.start();
+  }
 
-  function save() {
+  save() {
+    const { source_file, buffer, session } = this;
     saveSourceBuffer({ source_file, buffer })
       .catch(console.error)
       .finally(() => {
@@ -25,26 +33,27 @@ export default function Document({ session, code_view, lang }) {
       });
   }
 
-  function start() {
-    stop();
-    handler_id = buffer.connect("modified-changed", () => {
-      if (!buffer.get_modified()) return;
-      save();
+  start() {
+    this.stop();
+    this.handler_id = this.buffer.connect("modified-changed", () => {
+      if (!this.buffer.get_modified()) return;
+      this.save();
     });
   }
 
-  function stop() {
-    if (handler_id !== null) {
-      buffer.disconnect(handler_id);
-      handler_id = null;
+  stop() {
+    if (this.handler_id !== null) {
+      this.buffer.disconnect(this.handler_id);
+      this.handler_id = null;
     }
   }
 
-  function load() {
-    return loadSourceBuffer({ source_file, buffer, lang });
+  load() {
+    const { source_file, buffer } = this;
+    return loadSourceBuffer({ source_file, buffer });
   }
 
-  return { start, stop, save, code_view, file, load };
+  format() {}
 }
 
 async function saveSourceBuffer({ source_file, buffer }) {

src/PanelCode.js

@@ -1,17 +1,9 @@
 import Gio from "gi://Gio";
 import GObject from "gi://GObject";
 
-import { setup as setupVala } from "./langs/vala/vala.js";
-import { setup as setupJavaScript } from "./langs/javascript/javascript.js";
 import { settings as global_settings, makeDropdownFlat } from "./util.js";
 
-export default function PanelCode({
-  builder,
-  previewer,
-  document_vala,
-  document_javascript,
-  settings,
-}) {
+export default function PanelCode({ builder, previewer, settings }) {
   const panel_code = builder.get_object("panel_code");
   const button_code = builder.get_object("button_code");
   const stack_code = builder.get_object("stack_code");
@@ -51,10 +43,6 @@ export default function PanelCode({
     panel: panel_code,
   };
 
-  setupVala({ document: document_vala });
-  const { format } = setupJavaScript({ document: document_javascript });
-  document_javascript.format = format;
-
   function switchLanguage() {
     panel.language = dropdown_code_lang.selected_item?.string;
     stack_code.visible_child_name = panel.language;

src/PanelUI.js

@@ -10,10 +10,7 @@ import {
   makeDropdownFlat,
 } from "./util.js";
 
-import {
-  setup as setupBlueprint,
-  logBlueprintError,
-} from "./langs/blueprint/blueprint.js";
+import { logBlueprintError } from "./langs/blueprint/blueprint.js";
 
 // eslint-disable-next-line no-restricted-globals
 const { addSignalMethods } = imports.signals;
@@ -59,24 +56,19 @@ export default function PanelUI({
   makeDropdownFlat(dropdown_ui_lang);
   dropdown_ui_lang.set_selected(settings.get_enum("user-interface-language"));
 
-  const blueprint = setupBlueprint({
-    document: document_blueprint,
-  });
-
   async function convertToXML() {
     term_console.clear();
     settings.set_boolean("show-console", true);
 
-    const xml = await blueprint.compile(buffer_blueprint.text);
+    const xml = await document_blueprint.compile(buffer_blueprint.text);
     code_view_xml.replaceText(xml);
   }
 
   async function convertToBlueprint() {
     term_console.clear();
     settings.set_boolean("show-console", true);
 
-    const blp = await blueprint.decompile(buffer_xml.text);
-
+    const blp = await document_blueprint.decompile(buffer_xml.text);
     code_view_blueprint.replaceText(blp);
   }
 
@@ -106,7 +98,7 @@ export default function PanelUI({
   // when loading demo
   async function update() {
     if (lang === lang_blueprint) {
-      onXML(await blueprint.compile());
+      onXML(await document_blueprint.compile());
     } else if (lang === lang_xml) {
       onXML(buffer_xml.text);
     }
@@ -118,7 +110,7 @@ export default function PanelUI({
   }
 
   const onBlueprint = unstack(function onBlueprint() {
-    return blueprint.compile().then(onXML);
+    return document_blueprint.compile().then(onXML);
   }, console.error);
 
   function start() {
@@ -195,7 +187,6 @@ export default function PanelUI({
   panel.stop = stop;
   panel.update = update;
   panel.panel = panel_ui;
-  panel.format = blueprint.format;
 
   return panel;
 }

src/langs/blueprint/BlueprintDocument.js

@@ -0,0 +1,55 @@
+import Document from "../../Document.js";
+import { applyTextEdits } from "../../lsp/sourceview.js";
+
+import { setup as setupBlueprint } from "./blueprint.js";
+
+export class BlueprintDocument extends Document {
+  constructor(...args) {
+    super(...args);
+
+    this.lspc = setupBlueprint({ document: this });
+  }
+  async update() {
+    return this.lspc.didChange();
+  }
+  async compile() {
+    await this.lspc.didChange();
+
+    let xml = null;
+
+    try {
+      ({ xml } = await this.lspc.request("textDocument/x-blueprint-compile", {
+        textDocument: {
+          uri: this.file.get_uri(),
+        },
+      }));
+    } catch (err) {
+      console.debug(err);
+    }
+
+    return xml;
+  }
+  async decompile(text) {
+    const { blp } = await this.lspc.request("x-blueprint/decompile", {
+      text,
+    });
+    return blp;
+  }
+  async format() {
+    // https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_formatting
+    const text_edits = await this.lspc.request("textDocument/formatting", {
+      textDocument: {
+        uri: this.file.get_uri(),
+      },
+      options: {
+        tabSize: 2,
+        insertSpaces: true,
+        trimTrailingWhitespace: true,
+        insertFinalNewline: true,
+        trimFinalNewlines: true,
+      },
+    });
+
+    applyTextEdits(text_edits, this.buffer);
+  }
+}

src/langs/blueprint/blueprint.js

@@ -1,7 +1,6 @@
 import GLib from "gi://GLib";
 
 import LSPClient from "../../lsp/LSPClient.js";
-import { applyTextEdits } from "../../lsp/sourceview.js";
 
 export function setup({ document }) {
   const { file, code_view } = document;
@@ -13,52 +12,7 @@ export function setup({ document }) {
 
   lspc.start().catch(console.error);
 
-  return {
-    lspc,
-    async update() {
-      return lspc.didChange();
-    },
-    async compile() {
-      await lspc.didChange();
-
-      let xml = null;
-
-      try {
-        ({ xml } = await lspc.request("textDocument/x-blueprint-compile", {
-          textDocument: {
-            uri: file.get_uri(),
-          },
-        }));
-      } catch (err) {
-        console.debug(err);
-      }
-
-      return xml;
-    },
-    async decompile(text) {
-      const { blp } = await lspc.request("x-blueprint/decompile", {
-        text,
-      });
-      return blp;
-    },
-    async format() {
-      // https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_formatting
-      const text_edits = await lspc.request("textDocument/formatting", {
-        textDocument: {
-          uri: file.get_uri(),
-        },
-        options: {
-          tabSize: 2,
-          insertSpaces: true,
-          trimTrailingWhitespace: true,
-          insertFinalNewline: true,
-          trimFinalNewlines: true,
-        },
-      });
-
-      applyTextEdits(text_edits, document.code_view.buffer);
-    },
-  };
+  return lspc;
 }
 
 const SYSLOG_IDENTIFIER = pkg.name;

src/langs/css/CssDocument.js

@@ -0,0 +1,14 @@
+import { format as prettier } from "../../lib/prettier.js";
+import prettier_postcss from "../../lib/prettier-postcss.js";
+
+import Document from "../../Document.js";
+
+export class CssDocument extends Document {
+  async format() {
+    const code = await prettier(this.buffer.text, {
+      parser: "css",
+      plugins: [prettier_postcss],
+    });
+    this.code_view.replaceText(code, true);
+  }
+}

src/langs/javascript/JavaScriptDocument.js

@@ -0,0 +1,34 @@
+import { setup as setupJavaScript } from "./javascript.js";
+
+import Document from "../../Document.js";
+import { applyTextEdits } from "../../lsp/sourceview.js";
+
+export class JavaScriptDocument extends Document {
+  constructor(...args) {
+    super(...args);
+
+    this.lspc = setupJavaScript({ document: this });
+  }
+
+  async format() {
+    // https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_formatting
+    const text_edits = await this.lspc.request("textDocument/formatting", {
+      textDocument: {
+        uri: this.file.get_uri(),
+      },
+      options: {
+        tabSize: 2,
+        insertSpaces: true,
+        trimTrailingWhitespace: true,
+        insertFinalNewline: true,
+        trimFinalNewlines: true,
+      },
+    });
+
+    // Biome doesn't support diff - it just returns one edit
+    // we don't want to loose the cursor position so we use this
+    const state = this.code_view.saveState();
+    applyTextEdits(text_edits, this.buffer);
+    await this.code_view.restoreState(state);
+  }
+}

src/langs/javascript/javascript.js

@@ -1,7 +1,6 @@
 import GLib from "gi://GLib";
 
 import LSPClient from "../../lsp/LSPClient.js";
-import { applyTextEdits } from "../../lsp/sourceview.js";
 
 export function setup({ document }) {
   const { file, code_view } = document;
@@ -18,26 +17,7 @@ export function setup({ document }) {
     lspc.didChange().catch(console.error);
   });
 
-  return {
-    lspc,
-    async format() {
-      // https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_formatting
-      const text_edits = await lspc.request("textDocument/formatting", {
-        textDocument: {
-          uri: file.get_uri(),
-        },
-        options: {
-          tabSize: 2,
-          insertSpaces: true,
-          trimTrailingWhitespace: true,
-          insertFinalNewline: true,
-          trimFinalNewlines: true,
-        },
-      });
-
-      applyTextEdits(text_edits, document.code_view.buffer);
-    },
-  };
+  return lspc;
 }
 
 function createLSPClient({ file, code_view }) {