Be more error tolerant

Author: pokey

src/core/Snippets.ts

@@ -1,11 +1,12 @@
 import { readFile, stat } from "fs/promises";
 import { cloneDeep, max, merge } from "lodash";
 import { join } from "path";
-import { workspace } from "vscode";
+import { window, workspace } from "vscode";
 import { walkFiles } from "../testUtil/walkAsync";
 import { Snippet, SnippetMap } from "../typings/snippet";
 import { Graph } from "../typings/Types";
 import { mergeStrict } from "../util/object";
+import { CURSORLESS_SNIPPETS_SUFFIX } from "./constants";
 
 const SNIPPET_DIR_REFRESH_INTERVAL_MS = 1000;
 
@@ -34,6 +35,8 @@ export class Snippets {
    */
   private maxSnippetMtimeMs: number = -1;
 
+  private shownErrorMessageForDir: string | null | undefined = null;
+
   constructor(private graph: Graph) {
     this.updateUserSnippetsPath();
 
@@ -63,7 +66,7 @@ export class Snippets {
   async init() {
     const extensionPath = this.graph.extensionContext.extensionPath;
     const snippetsDir = join(extensionPath, "cursorless-snippets");
-    const snippetFiles = await walkFiles(snippetsDir);
+    const snippetFiles = await getSnippetPaths(snippetsDir);
     this.coreSnippets = mergeStrict(
       ...(await Promise.all(
         snippetFiles.map(async (path) =>
@@ -98,9 +101,25 @@ export class Snippets {
   }
 
   async updateUserSnippets() {
-    const snippetFiles = this.userSnippetsDir
-      ? await walkFiles(this.userSnippetsDir)
-      : [];
+    let snippetFiles: string[];
+    try {
+      snippetFiles = this.userSnippetsDir
+        ? await getSnippetPaths(this.userSnippetsDir)
+        : [];
+    } catch (err) {
+      if (this.shownErrorMessageForDir !== this.userSnippetsDir) {
+        window.showErrorMessage(
+          `Error with cursorless snippets dir "${this.userSnippetsDir}": ${
+            (err as Error).message
+          }`
+        );
+      }
+
+      this.shownErrorMessageForDir = this.userSnippetsDir;
+      return;
+    }
+
+    this.shownErrorMessageForDir = null;
 
     const maxSnippetMtime =
       max(
@@ -117,9 +136,24 @@ export class Snippets {
 
     this.userSnippets = mergeStrict(
       ...(await Promise.all(
-        snippetFiles.map(async (path) =>
-          JSON.parse(await readFile(path, "utf8"))
-        )
+        snippetFiles.map(async (path) => {
+          try {
+            const content = await readFile(path, "utf8");
+
+            if (content.length === 0) {
+              return {};
+            }
+
+            return JSON.parse(content);
+          } catch (err) {
+            window.showErrorMessage(
+              `Error with cursorless snippets file "${path}": ${
+                (err as Error).message
+              }`
+            );
+            return {};
+          }
+        })
       ))
     );
 
@@ -185,3 +219,9 @@ export class Snippets {
     return this.mergedSnippets[snippetName];
   }
 }
+
+async function getSnippetPaths(snippetsDir: string) {
+  return (await walkFiles(snippetsDir)).filter((path) =>
+    path.endsWith(CURSORLESS_SNIPPETS_SUFFIX)
+  );
+}

src/core/constants.ts

@@ -1,3 +1,5 @@
+export const CURSORLESS_SNIPPETS_SUFFIX = ".cursorless-snippets";
+
 export const SUBWORD_MATCHER = /[A-Z]?[a-z]+|[A-Z]+(?![a-z])|[0-9]+/g;
 
 export const DEBOUNCE_DELAY = 175;