Fix resolve tildes in file paths

We forgot to handle the VSCode side of path resolution
Fixes #707

Author: JohnnyMorganz

CHANGELOG.md

@@ -18,6 +18,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 - Fixed inlay hint off-by-one on a function definition with an explicit self (i.e., `function Class.foo(self, param)`) ([#702](https://github.com/JohnnyMorganz/luau-lsp/issues/702))
 - Fixed `:GetPropertyChangedSignal()` still showing children in autocomplete for DataModel types ([#699](https://github.com/JohnnyMorganz/luau-lsp/issues/699))
 - Fixed grandparent's children showing up in autocomplete of FindFirstChild
+- Fixed tilde expansion (`~`) for paths to home directory not working in VSCode ([#707](https://github.com/JohnnyMorganz/luau-lsp/issues/707))
 
 ## [1.32.0] - 2024-07-14
 

editors/code/src/extension.ts

@@ -76,7 +76,8 @@ const startLanguageServer = async (context: vscode.ExtensionContext) => {
   // Load extra type definitions
   const definitionFiles = typesConfig.get<string[]>("definitionFiles");
   if (definitionFiles) {
-    for (const definitionPath of definitionFiles) {
+    for (let definitionPath of definitionFiles) {
+      definitionPath = utils.resolvePath(definitionPath);
       let uri;
       if (vscode.workspace.workspaceFolders) {
         uri = utils.resolveUri(
@@ -99,7 +100,8 @@ const startLanguageServer = async (context: vscode.ExtensionContext) => {
   // Load extra documentation files
   const documentationFiles = typesConfig.get<string[]>("documentationFiles");
   if (documentationFiles) {
-    for (const documentationPath of documentationFiles) {
+    for (let documentationPath of documentationFiles) {
+      documentationPath = utils.resolvePath(documentationPath);
       let uri;
       if (vscode.workspace.workspaceFolders) {
         uri = utils.resolveUri(

editors/code/src/test/suite/utils.test.ts

@@ -0,0 +1,20 @@
+import * as assert from "assert";
+import path from "path";
+import os from "os";
+import { resolvePath } from "../../utils";
+
+suite("Utils Test Suite", () => {
+  test("Expands tilde to home directory (directory sep: /)", () => {
+    assert.strictEqual(
+      path.join(os.homedir(), "typedefs.luau"),
+      resolvePath("~/typedefs.luau"),
+    );
+  });
+
+  test("Expands tilde to home directory (directory sep: \\)", () => {
+    assert.strictEqual(
+      path.join(os.homedir(), "typedefs.luau"),
+      resolvePath("~\\typedefs.luau"),
+    );
+  });
+});

editors/code/src/utils.ts

@@ -1,5 +1,6 @@
 import * as vscode from "vscode";
 import * as path from "path";
+import * as os from "os";
 
 export const basenameUri = (uri: vscode.Uri): string => {
   return path.basename(uri.fsPath);
@@ -15,3 +16,11 @@ export const exists = (uri: vscode.Uri): Thenable<boolean> => {
 export const resolveUri = (uri: vscode.Uri, ...paths: string[]): vscode.Uri => {
   return vscode.Uri.file(path.resolve(uri.fsPath, ...paths));
 };
+
+/// Expand ~ at the start of the path
+export const resolvePath = (mainPath: string): string => {
+  if (mainPath.startsWith("~/") || mainPath.startsWith("~\\")) {
+    return path.join(os.homedir(), mainPath.slice(2));
+  }
+  return mainPath;
+};