Add typechecking for TypeScript (#946)

vixalien · sonnyp · web-flow · commit 2b13cf3ce2e9 · 2024-07-07T01:23:09.000+02:00
Co-authored-by: Sonny &lt;sonny@fastmail.net&gt;
diff --git a/.gitmodules b/.gitmodules
@@ -7,3 +7,7 @@
 [submodule "blueprint-compiler"]
 	path = blueprint-compiler
 	url = https://gitlab.gnome.org/jwestman/blueprint-compiler.git
+[submodule "src/langs/typescript/template/gi-types"]
+	path = src/langs/typescript/gi-types
+	url = https://gitlab.gnome.org/BrainBlasted/gi-typescript-definitions.git
+	branch = nightly
diff --git a/Makefile b/Makefile
@@ -61,7 +61,7 @@ unit:
 test: unit lint
 	./build-aux/fun workbench-cli ci demos/src/Welcome
 
-ci: setup test
+ci: setup build test
 	./build-aux/fun workbench-cli ci demos/src/*
 
 # Note that if you have Sdk extensions installed they will be used
diff --git a/src/PanelCode.js b/src/PanelCode.js
@@ -9,6 +9,7 @@ export default function PanelCode({
   builder,
   previewer,
   session: { settings, file },
+  langs,
 }) {
   const panel_code = builder.get_object("panel_code");
   const button_code = builder.get_object("button_code");
@@ -59,7 +60,9 @@ export default function PanelCode({
     }
 
     if (panel.language.toLowerCase() === "typescript") {
-      setupTypeScriptProject(file).catch(console.error);
+      setupTypeScriptProject(file, langs.typescript.document).catch(
+        console.error,
+      );
     }
   }
   switchLanguage();
diff --git a/src/common.js b/src/common.js
@@ -128,14 +128,7 @@ export const languages = [
     document: null,
     default_file: "main.ts",
     index: 4,
-    language_server: [
-      "biome",
-      "lsp-proxy",
-      // src/meson.build installs biome.json there
-      GLib.getenv("FLATPAK_ID")
-        ? `--config-path=${pkg.pkgdatadir}`
-        : `--config-path=src/langs/typescript`,
-    ],
+    language_server: ["typescript-language-server", "--stdio"],
     formatting_options: {
       ...formatting_options,
       tabSize: 2,
diff --git a/src/langs/typescript/TypeScriptDocument.js b/src/langs/typescript/TypeScriptDocument.js
@@ -8,6 +8,7 @@ export class TypeScriptDocument extends Document {
     super(...args);
 
     this.lspc = setup({ document: this });
+    this.code_view.lspc = this.lspc;
   }
 
   async format() {
@@ -25,10 +26,6 @@ export class TypeScriptDocument extends Document {
       },
     });
 
-    // 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);
   }
 }
diff --git a/src/langs/typescript/biome.json b/src/langs/typescript/biome.json
diff --git a/src/langs/typescript/gi-types b/src/langs/typescript/gi-types
@@ -0,0 +1 @@
+Subproject commit 396fe147142e28a921f0745eff1a562c7a551843
diff --git a/src/langs/typescript/meson.build b/src/langs/typescript/meson.build
@@ -0,0 +1,14 @@
+configure_file(
+  input: 'template/tsconfig.json',
+  output: 'tsconfig.json',
+  install_dir: join_paths(pkgdatadir, 'langs/typescript/template/'),
+  configuration: bin_conf,
+)
+
+install_data(
+  ['types/ambient.d.ts'],
+  install_dir: join_paths(pkgdatadir, 'langs/typescript'),
+  preserve_path: true,
+)
+
+install_subdir('gi-types', install_dir: join_paths(pkgdatadir, 'langs/typescript'))
diff --git a/src/langs/typescript/template/meson.build b/src/langs/typescript/template/meson.build
diff --git a/src/langs/typescript/template/tsconfig.json b/src/langs/typescript/template/tsconfig.json
@@ -6,9 +6,15 @@
     // currently supported by the latest GJS
     "target": "ESNext",
     "outDir": "compiled_javascript",
+    "baseUrl": ".",
     "paths": {
-      "gi://*": ["./types/gi-module.d.ts"]
-    }
+      "*": ["*", "@pkgdatadir@/langs/typescript/gi-types/*"]
+    },
+    "skipLibCheck": true
   },
-  "include": ["main.ts", "types/ambient.d.ts", "types/gi-module.d.ts"]
+  "include": [
+    "main.ts",
+    "@pkgdatadir@/langs/typescript/types/ambient.d.ts",
+    "@pkgdatadir@/langs/typescript/gi-types/gi.d.ts"
+  ]
 }
diff --git a/src/langs/typescript/template/types/gi-module.d.ts b/src/langs/typescript/template/types/gi-module.d.ts
diff --git a/src/langs/typescript/types/ambient.d.ts b/src/langs/typescript/types/ambient.d.ts
@@ -1,3 +1,7 @@
+// import Adw from "gi://Adw";
+// import Gtk from "gi://Gtk?version=4.0";
+// import GObject from "gi://GObject";
+
 // additional type declarations for GJS
 
 // additional GJS log utils
@@ -31,6 +35,16 @@ declare module "gettext" {
   ): string;
 }
 
+// TODO: uncomment correct typings after we switch to `ts-for-gir`
+// declare const workbench: {
+//   window: Adw.ApplicationWindow;
+//   application: Adw.Application;
+//   builder: Gtk.Builder;
+//   template: string;
+//   resolve(path: string): string;
+//   preview(object: Gtk.Widget): void;
+//   build(params: Record<string, Function | GObject.Object>): void;
+// };
+
 // global workbench object
-// TODO: use correct typings
 declare const workbench: any;
diff --git a/src/langs/typescript/typescript.js b/src/langs/typescript/typescript.js
@@ -40,31 +40,17 @@ const typescript_template_dir = Gio.File.new_for_path(
   pkg.pkgdatadir,
 ).resolve_relative_path("langs/typescript/template");
 
-export async function setupTypeScriptProject(destination) {
-  const types_destination = destination.get_child("types");
-
-  if (!types_destination.query_exists(null)) {
-    types_destination.make_directory_with_parents(null);
-  }
+export async function setupTypeScriptProject(destination, document) {
+  const destination_file = await copy(
+    "tsconfig.json",
+    typescript_template_dir,
+    destination,
+    Gio.FileCopyFlags.NONE,
+  );
 
-  return Promise.all([
-    copy(
-      "types/ambient.d.ts",
-      typescript_template_dir,
-      types_destination,
-      Gio.FileCopyFlags.NONE,
-    ),
-    copy(
-      "types/gi-module.d.ts",
-      typescript_template_dir,
-      types_destination,
-      Gio.FileCopyFlags.NONE,
-    ),
-    copy(
-      "tsconfig.json",
-      typescript_template_dir,
-      destination,
-      Gio.FileCopyFlags.NONE,
-    ),
-  ]);
+  // Notify the language server that the tsconfig file was created
+  // to initialized diagnostics and type checkings
+  await document.lspc.notify("workspace/didCreateFile", {
+    files: [{ uri: destination_file.get_uri() }],
+  });
 }
diff --git a/src/lsp/LSPClient.js b/src/lsp/LSPClient.js
@@ -299,7 +299,7 @@ export default class LSPClient {
       },
       position: {
         line: iter_cursor.get_line(),
-        character: iter_cursor.get_line_offset() - 1,
+        character: iter_cursor.get_line_offset(),
       },
     });
 
diff --git a/src/meson.build b/src/meson.build
@@ -16,7 +16,7 @@ blueprint_compiler = find_program(
 meson.add_install_script('../build-aux/library.js', pkgdatadir)
 
 subdir('langs/rust/template')
-subdir('langs/typescript/template')
+subdir('langs/typescript')
 
 configure_file(
   input: 'bin.js',
diff --git a/src/util.js b/src/util.js
@@ -191,10 +191,11 @@ export function removeDirectory(file) {
 
 export async function copy(filename, source_dir, dest_dir, flags) {
   const file = source_dir.get_child(filename);
+  const dest_file = dest_dir.get_child(file.get_basename());
 
   try {
     await file.copy_async(
-      dest_dir.get_child(file.get_basename()), // destination
+      dest_file, // destination
       flags, // flags
       GLib.PRIORITY_DEFAULT, // priority
       null, // cancellable
@@ -205,4 +206,6 @@ export async function copy(filename, source_dir, dest_dir, flags) {
       throw err;
     }
   }
+
+  return dest_file;
 }
diff --git a/src/window.js b/src/window.js
@@ -163,6 +163,7 @@ export default function Window({ application, session }) {
     builder,
     previewer,
     session,
+    langs,
   });
 
   previewer.setPanelCode(panel_code);

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@ export default function PanelCode({`
`9`	`9`	`builder,`
`10`	`10`	`previewer,`
`11`	`11`	`session: { settings, file },`
	`12`	`+ langs,`
`12`	`13`	`}) {`
`13`	`14`	`const panel_code = builder.get_object("panel_code");`
`14`	`15`	`const button_code = builder.get_object("button_code");`
`@@ -59,7 +60,9 @@ export default function PanelCode({`
`59`	`60`	`}`
`60`	`61`
`61`	`62`	`if (panel.language.toLowerCase() === "typescript") {`
`62`		`- setupTypeScriptProject(file).catch(console.error);`
	`63`	`+ setupTypeScriptProject(file, langs.typescript.document).catch(`
	`64`	`+ console.error,`
	`65`	`+ );`
`63`	`66`	`}`
`64`	`67`	`}`
`65`	`68`	`switchLanguage();`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@ export class TypeScriptDocument extends Document {`
`8`	`8`	`super(...args);`
`9`	`9`
`10`	`10`	`this.lspc = setup({ document: this });`
	`11`	`+ this.code_view.lspc = this.lspc;`
`11`	`12`	`}`
`12`	`13`
`13`	`14`	`async format() {`
`@@ -25,10 +26,6 @@ export class TypeScriptDocument extends Document {`
`25`	`26`	`},`
`26`	`27`	`});`
`27`	`28`
`28`		`- // Biome doesn't support diff - it just returns one edit`
`29`		`- // we don't want to loose the cursor position so we use this`
`30`		`- const state = this.code_view.saveState();`
`31`	`29`	`applyTextEdits(text_edits, this.buffer);`
`32`		`- await this.code_view.restoreState(state);`
`33`	`30`	`}`
`34`	`31`	`}`