vscode-apollo 2.0.0 → 2.1.0

package/src/language-server/config/loadConfig.ts

@@ -1,4 +1,4 @@
-import { cosmiconfig } from "cosmiconfig";
+import { cosmiconfig, defaultLoaders } from "cosmiconfig";
 import { resolve } from "path";
 import { readFileSync, existsSync, lstatSync } from "fs";
 import {
@@ -9,6 +9,7 @@ import {
 import { getServiceFromKey } from "./utils";
 import { URI } from "vscode-uri";
 import { Debug } from "../utilities";
+import { loadTs } from "./loadTsConfig";
 
 // config settings
 const MODULE_NAME = "apollo";
@@ -37,11 +38,16 @@ export type ConfigResult<T> = {
 } | null;
 
 // XXX load .env files automatically
+
 export async function loadConfig({
   configPath,
 }: LoadConfigSettings): Promise<ApolloConfig | null> {
   const explorer = cosmiconfig(MODULE_NAME, {
     searchPlaces: defaultFileNames,
+    loaders: {
+      ...defaultLoaders,
+      [".ts"]: loadTs,
+    },
   });
 
   // search can fail if a file can't be parsed (ex: a nonsense js file) so we wrap in a try/catch

package/src/language-server/config/loadTsConfig.ts

@@ -0,0 +1,70 @@
+import { Loader, defaultLoaders } from "cosmiconfig";
+import { dirname } from "node:path";
+import { rm, writeFile } from "node:fs/promises";
+import { existsSync } from "node:fs";
+
+// implementation based on https://github.com/cosmiconfig/cosmiconfig/blob/a5a842547c13392ebb89a485b9e56d9f37e3cbd3/src/loaders.ts
+// Copyright (c) 2015 David Clark licensed MIT. Full license can be found here:
+// https://github.com/cosmiconfig/cosmiconfig/blob/a5a842547c13392ebb89a485b9e56d9f37e3cbd3/LICENSE
+
+let typescript: typeof import("typescript");
+export const loadTs: Loader = async function loadTs(filepath, content) {
+  try {
+    return await defaultLoaders[".ts"](filepath, content);
+  } catch (error) {
+    if (
+      !(error instanceof Error) ||
+      !error.message.includes("module is not defined")
+    )
+      throw error;
+  }
+
+  if (typescript === undefined) {
+    typescript = await import("typescript");
+  }
+  const compiledFilepath = `${filepath.slice(0, -2)}cjs`;
+  let transpiledContent;
+  try {
+    try {
+      const config = resolveTsConfig(dirname(filepath)) ?? {};
+      config.compilerOptions = {
+        ...config.compilerOptions,
+        module: typescript.ModuleKind.CommonJS,
+        moduleResolution: typescript.ModuleResolutionKind.Bundler,
+        target: typescript.ScriptTarget.ES2022,
+        noEmit: false,
+      };
+      transpiledContent = typescript.transpileModule(
+        content,
+        config,
+      ).outputText;
+      await writeFile(compiledFilepath, transpiledContent);
+    } catch (error: any) {
+      error.message = `TypeScript Error in ${filepath}:\n${error.message}`;
+      throw error;
+    }
+    // eslint-disable-next-line @typescript-eslint/return-await
+    return await defaultLoaders[".js"](compiledFilepath, transpiledContent);
+  } finally {
+    if (existsSync(compiledFilepath)) {
+      await rm(compiledFilepath);
+    }
+  }
+};
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function resolveTsConfig(directory: string): any {
+  const filePath = typescript.findConfigFile(directory, (fileName) => {
+    return typescript.sys.fileExists(fileName);
+  });
+  if (filePath !== undefined) {
+    const { config, error } = typescript.readConfigFile(filePath, (path) =>
+      typescript.sys.readFile(path),
+    );
+    if (error) {
+      throw new Error(`Error in ${filePath}: ${error.messageText.toString()}`);
+    }
+    return config;
+  }
+  return;
+}

package/src/language-server/config/which.d.ts

@@ -0,0 +1,19 @@
+declare module "which" {
+  interface Options {
+    /**  Use instead of the PATH environment variable. */
+    path?: string;
+    /** Use instead of the PATHEXT environment variable. */
+    pathExt?: string;
+    /**  Return all matches, instead of just the first one. Note that this means the function returns an array of strings instead of a single string. */
+    all?: boolean;
+  }
+
+  function which(cmd: string, options?: Options): number;
+  namespace which {
+    function sync(
+      cmd: string,
+      options?: Options & { nothrow?: boolean },
+    ): string | null;
+  }
+  export = which;
+}

package/src/language-server/document.ts

@@ -2,7 +2,6 @@ import { parse, Source, DocumentNode } from "graphql";
 import { SourceLocation, getLocation } from "graphql/language/location";
 
 import {
-  TextDocument,
   Position,
   Diagnostic,
   DiagnosticSeverity,
@@ -14,7 +13,13 @@ import {
   positionFromSourceLocation,
   rangeInContainingDocument,
 } from "./utilities/source";
+import { TextDocument } from "vscode-languageserver-textdocument";
 
+declare global {
+  interface RegExpExecArray {
+    indices?: Array<[number, number]>;
+  }
+}
 export class GraphQLDocument {
   ast?: DocumentNode;
   syntaxErrors: Diagnostic[] = [];
@@ -51,74 +56,102 @@ export class GraphQLDocument {
   }
 }
 
-export function extractGraphQLDocuments(
+export function extractGraphQLSources(
   document: TextDocument,
   tagName: string = "gql",
-): GraphQLDocument[] | null {
+): Source[] | null {
   switch (document.languageId) {
     case "graphql":
-      return [
-        new GraphQLDocument(new Source(document.getText(), document.uri)),
-      ];
+      return [new Source(document.getText(), document.uri)];
     case "javascript":
     case "javascriptreact":
     case "typescript":
     case "typescriptreact":
     case "vue":
     case "svelte":
-      return extractGraphQLDocumentsFromJSTemplateLiterals(document, tagName);
+      return extractGraphQLSourcesFromJSTemplateLiterals(document, tagName);
     case "python":
-      return extractGraphQLDocumentsFromPythonStrings(document, tagName);
+      return extractGraphQLSourcesFromPythonStrings(document, tagName);
     case "ruby":
-      return extractGraphQLDocumentsFromRubyStrings(document, tagName);
+      return extractGraphQLSourcesFromRubyStrings(document, tagName);
     case "dart":
-      return extractGraphQLDocumentsFromDartStrings(document, tagName);
+      return extractGraphQLSourcesFromDartStrings(document, tagName);
     case "reason":
-      return extractGraphQLDocumentsFromReasonStrings(document, tagName);
+      return extractGraphQLSourcesFromReasonStrings(document, tagName);
     case "elixir":
-      return extractGraphQLDocumentsFromElixirStrings(document, tagName);
+      return extractGraphQLSourcesFromElixirStrings(document, tagName);
     default:
       return null;
   }
 }
 
-function extractGraphQLDocumentsFromJSTemplateLiterals(
+export function extractGraphQLDocuments(
   document: TextDocument,
-  tagName: string,
+  tagName: string = "gql",
 ): GraphQLDocument[] | null {
+  const sources = extractGraphQLSources(document, tagName);
+  if (!sources) return null;
+  return sources.map((source) => new GraphQLDocument(source));
+}
+
+const parts = [
+  // normal tagged template literals
+  /TAG_NAME\s*(?:<.*?>\s*)?`(.*?)`/,
+  // template string starting with a #TAG_NAME, #graphql or #GraphQL comment
+  /`(\s*#[ ]*(?:TAG_NAME|graphql|GraphQL).*?)`/,
+  // template string preceeded by a /* TAG_NAME */, /* graphql */ or /* GraphQL */ comment
+  /\/\*\s*(?:TAG_NAME|graphql|GraphQL)\s*\*\/\s?`(.*?)`/,
+  // function call to TAG_NAME with a single template string argument
+  /TAG_NAME\s*(?:<.*?>\s*)?\(\s*`(.*?)`\s*\)/,
+].map((r) => r.source);
+
+function extractGraphQLSourcesFromJSTemplateLiterals(
+  document: TextDocument,
+  tagName: string,
+): Source[] | null {
   const text = document.getText();
 
-  const documents: GraphQLDocument[] = [];
+  const sources: Source[] = [];
 
   const regExp = new RegExp(
-    `(?:${tagName}(?:\\s|\\()*\`|\`#graphql)([\\s\\S]+?)\`\\)?`,
-    "gm",
+    parts.map((r) => r.replace("TAG_NAME", tagName)).join("|"),
+    // g: global search
+    // s: treat `.` as any character, including newlines
+    // d: save indices
+    "gsd",
   );
 
   let result;
   while ((result = regExp.exec(text)) !== null) {
-    const contents = replacePlaceholdersWithWhiteSpace(result[1]);
-    const position = document.positionAt(result.index + (tagName.length + 1));
+    // we have multiple alternative capture groups in the regexp, and only one of them will have a result
+    // so we need the index for that
+    const groupIndex = result.findIndex(
+      (part, index) => index !== 0 && part != null,
+    );
+    const contents = replacePlaceholdersWithWhiteSpace(result[groupIndex]);
+    const position = document.positionAt(result.indices![groupIndex][0]);
     const locationOffset: SourceLocation = {
       line: position.line + 1,
       column: position.character + 1,
     };
     const source = new Source(contents, document.uri, locationOffset);
-    documents.push(new GraphQLDocument(source));
+    if (source.body.trim().length > 0) {
+      sources.push(source);
+    }
   }
 
-  if (documents.length < 1) return null;
+  if (sources.length < 1) return null;
 
-  return documents;
+  return sources;
 }
 
-function extractGraphQLDocumentsFromPythonStrings(
+function extractGraphQLSourcesFromPythonStrings(
   document: TextDocument,
   tagName: string,
-): GraphQLDocument[] | null {
+): Source[] | null {
   const text = document.getText();
 
-  const documents: GraphQLDocument[] = [];
+  const sources: Source[] = [];
 
   const regExp = new RegExp(
     `\\b(${tagName}\\s*\\(\\s*[bfru]*("(?:"")?|'(?:'')?))([\\s\\S]+?)\\2\\s*\\)`,
@@ -134,21 +167,21 @@ function extractGraphQLDocumentsFromPythonStrings(
       column: position.character + 1,
     };
     const source = new Source(contents, document.uri, locationOffset);
-    documents.push(new GraphQLDocument(source));
+    sources.push(source);
   }
 
-  if (documents.length < 1) return null;
+  if (sources.length < 1) return null;
 
-  return documents;
+  return sources;
 }
 
-function extractGraphQLDocumentsFromRubyStrings(
+function extractGraphQLSourcesFromRubyStrings(
   document: TextDocument,
   tagName: string,
-): GraphQLDocument[] | null {
+): Source[] | null {
   const text = document.getText();
 
-  const documents: GraphQLDocument[] = [];
+  const sources: Source[] = [];
 
   const regExp = new RegExp(`(<<-${tagName})([\\s\\S]+?)${tagName}`, "gm");
 
@@ -161,21 +194,21 @@ function extractGraphQLDocumentsFromRubyStrings(
       column: position.character + 1,
     };
     const source = new Source(contents, document.uri, locationOffset);
-    documents.push(new GraphQLDocument(source));
+    sources.push(source);
   }
 
-  if (documents.length < 1) return null;
+  if (sources.length < 1) return null;
 
-  return documents;
+  return sources;
 }
 
-function extractGraphQLDocumentsFromDartStrings(
+function extractGraphQLSourcesFromDartStrings(
   document: TextDocument,
   tagName: string,
-): GraphQLDocument[] | null {
+): Source[] | null {
   const text = document.getText();
 
-  const documents: GraphQLDocument[] = [];
+  const sources: Source[] = [];
 
   const regExp = new RegExp(
     `\\b(${tagName}\\(\\s*r?("""|'''))([\\s\\S]+?)\\2\\s*\\)`,
@@ -191,26 +224,26 @@ function extractGraphQLDocumentsFromDartStrings(
       column: position.character + 1,
     };
     const source = new Source(contents, document.uri, locationOffset);
-    documents.push(new GraphQLDocument(source));
+    sources.push(source);
   }
 
-  if (documents.length < 1) return null;
+  if (sources.length < 1) return null;
 
-  return documents;
+  return sources;
 }
 
-function extractGraphQLDocumentsFromReasonStrings(
+function extractGraphQLSourcesFromReasonStrings(
   document: TextDocument,
   tagName: string,
-): GraphQLDocument[] | null {
+): Source[] | null {
   const text = document.getText();
 
-  const documents: GraphQLDocument[] = [];
+  const sources: Source[] = [];
 
   const reasonFileFilter = new RegExp(/(\[%(graphql|relay\.))/g);
 
   if (!reasonFileFilter.test(text)) {
-    return documents;
+    return sources;
   }
 
   const reasonRegexp = new RegExp(
@@ -226,20 +259,20 @@ function extractGraphQLDocumentsFromReasonStrings(
       column: position.character + 1,
     };
     const source = new Source(contents, document.uri, locationOffset);
-    documents.push(new GraphQLDocument(source));
+    sources.push(source);
   }
 
-  if (documents.length < 1) return null;
+  if (sources.length < 1) return null;
 
-  return documents;
+  return sources;
 }
 
-function extractGraphQLDocumentsFromElixirStrings(
+function extractGraphQLSourcesFromElixirStrings(
   document: TextDocument,
   tagName: string,
-): GraphQLDocument[] | null {
+): Source[] | null {
   const text = document.getText();
-  const documents: GraphQLDocument[] = [];
+  const sources: Source[] = [];
 
   const regExp = new RegExp(
     `\\b(${tagName}\\(\\s*r?("""))([\\s\\S]+?)\\2\\s*\\)`,
@@ -255,12 +288,12 @@ function extractGraphQLDocumentsFromElixirStrings(
       column: position.character + 1,
     };
     const source = new Source(contents, document.uri, locationOffset);
-    documents.push(new GraphQLDocument(source));
+    sources.push(source);
   }
 
-  if (documents.length < 1) return null;
+  if (sources.length < 1) return null;
 
-  return documents;
+  return sources;
 }
 
 function replacePlaceholdersWithWhiteSpace(content: string) {

package/src/language-server/fileSet.ts

@@ -30,6 +30,13 @@ export class FileSet {
     this.excludes = excludes;
   }
 
+  pushIncludes(files: string[]) {
+    this.includes.push(...files);
+  }
+  pushExcludes(files: string[]) {
+    this.excludes.push(...files);
+  }
+
   includesFile(filePath: string): boolean {
     const normalizedFilePath = normalizeURI(filePath);