fix(cli-utils, internal): Fix retrieval of tsconfig.json extends and standard TS libs (#251)

Author: kitten

.changeset/nervous-rats-stare.md

@@ -0,0 +1,5 @@
+---
+"@gql.tada/cli-utils": patch
+---
+
+Fix resolution of default lib path when libs aren't in standard location

.changeset/violet-tools-relax.md

@@ -0,0 +1,5 @@
+---
+"@gql.tada/internal": patch
+---
+
+Fix resolving `tsconfig.json`' `extends` option

packages/cli-utils/src/ts/container.ts

@@ -9,7 +9,7 @@ import type { SourcePosition } from './utils';
 import { spanToFilePosition } from './utils';
 
 function maybeBind<T extends Function>(that: object, fn: T | undefined): T {
-  return fn ? fn.bind(that, fn) : fn;
+  return fn ? fn.bind(that) : fn;
 }
 
 export interface PluginCreateInfo<Config extends {} = GraphQLSPConfig>

packages/cli-utils/src/ts/factory.ts

@@ -49,19 +49,14 @@ export const programFactory = (params: ProgramFactoryParams): ProgramFactory =>
   const virtualMap: VirtualMap = new Map();
 
   const projectRoot = path.dirname(params.configPath);
-  const tslibPath = path.join(projectRoot, 'node_modules/typescript/lib/');
-  const system = createFSBackedSystem(vfsMap, projectRoot, ts, tslibPath);
+  const system = createFSBackedSystem(vfsMap, projectRoot, ts, resolveDefaultLibsPath(params));
   const config = resolveConfig(params, system);
 
-  for (const { filename, contents } of resolveLibs(params)) {
-    if (contents) system.writeFile(path.join(tslibPath, filename), contents);
-  }
-
   const rootNames = new Set(config.fileNames);
   const options = {
+    getDefaultLibFilePath: ts.getDefaultLibFilePath(config.options),
     ...defaultCompilerOptions,
     ...config.options,
-    getDefaultLibFilePath: tslibPath,
   };
   const host = createVirtualCompilerHost(system, options, ts);
 
@@ -178,45 +173,31 @@ export const programFactory = (params: ProgramFactoryParams): ProgramFactory =>
   return factory;
 };
 
-interface LibFile {
-  filename: string;
-  contents: string;
-}
-
 const defaultCompilerOptions = {
   target: ts.ScriptTarget.Latest,
 } satisfies ts.CompilerOptions;
 
-const resolveLibs = (params: ProgramFactoryParams): readonly LibFile[] => {
-  const require = createRequire(params.configPath);
-  const request = 'typescript/package.json';
-  let tsPath: string;
-  try {
-    tsPath = path.dirname(
-      require.resolve(request, {
-        paths: [
-          path.join(path.dirname(params.configPath), 'node_modules'),
-          path.join(params.rootPath, 'node_modules'),
-          ...(require.resolve.paths(request) || []),
-        ],
-      })
-    );
-  } catch (_error) {
-    return [];
-  }
-  const libs = ts.sys.readDirectory(
-    path.resolve(tsPath, 'lib'),
-    /*extensions*/ ['.d.ts'],
-    /*exclude*/ ['typescript.d.ts'],
-    /*include*/ ['lib.*'],
-    /*depth*/ 1
-  );
-  const output: LibFile[] = [];
-  for (const fileName of libs) {
-    const contents = ts.sys.readFile(fileName, 'utf8');
-    if (contents) output.push({ filename: path.basename(fileName), contents });
+const resolveDefaultLibsPath = (params: ProgramFactoryParams): string => {
+  const target = ts.getDefaultLibFilePath({});
+  if (!ts.sys.fileExists(target)) {
+    const require = createRequire(params.configPath);
+    const request = 'typescript/package.json';
+    try {
+      return path.dirname(
+        require.resolve(request, {
+          paths: [
+            path.join(path.dirname(params.configPath), 'node_modules'),
+            path.join(params.rootPath, 'node_modules'),
+            ...(require.resolve.paths(request) || []),
+          ],
+        })
+      );
+    } catch (_error) {
+      return path.resolve(params.rootPath, 'node_modules', 'typescript', 'lib');
+    }
+  } else {
+    return path.dirname(target);
   }
-  return output;
 };
 
 const resolveConfig = (params: ProgramFactoryParams, system: ts.System): ts.ParsedCommandLine => {

packages/internal/src/config.ts

@@ -12,15 +12,15 @@ export interface GraphQLSPConfig {
 }
 
 export const parseConfig = (
-  input: Record<string, unknown>,
+  input: unknown,
   /** Defines the path of the "main" `tsconfig.json` file.
    * @remarks
    * This should be the `rootPath` output from `loadConfig`,
    * which is the path of the user's `tsconfig.json` before
    * resolving `extends` options.
    */
   rootPath: string = process.cwd()
-) => {
+): GraphQLSPConfig => {
   const resolveConfigDir = (input: string | undefined) => {
     if (!input) return input;
     return path.normalize(
@@ -36,7 +36,11 @@ export const parseConfig = (
     );
   };
 
-  if (input.schema && typeof input.schema === 'object') {
+  if (input == null || typeof input !== 'object') {
+    throw new TadaError(`Configuration was not loaded properly (Received: ${input})`);
+  }
+
+  if ('schema' in input && input.schema && typeof input.schema === 'object') {
     const { schema } = input;
     if (!('url' in schema)) {
       throw new TadaError('Configuration contains a `schema` object, but no `url` property');
@@ -55,7 +59,7 @@ export const parseConfig = (
         "Configuration contains a `schema.headers` property, but it's not an object"
       );
     }
-  } else if (typeof input.schema !== 'string') {
+  } else if (!('schema' in input) || typeof input.schema !== 'string') {
     throw new TadaError('Configuration is missing a `schema` property');
   } else if (
     'tadaOutputLocation' in input &&
@@ -98,5 +102,5 @@ export const parseConfig = (
     tadaOutputLocation: resolveConfigDir(output.tadaOutputLocation),
     tadaTurboLocation: resolveConfigDir(output.tadaTurboLocation),
     tadaPersistedLocation: resolveConfigDir(output.tadaPersistedLocation),
-  } satisfies GraphQLSPConfig;
+  };
 };

packages/internal/src/resolve.ts

@@ -81,46 +81,40 @@ export const loadConfig = async (targetPath?: string): Promise<LoadConfigResult>
         : 'No tsconfig.json found at or above current working directory'
     );
   }
-  const tsconfig = await readTSConfigFile(rootTsconfigPath);
-  const pluginConfig = getPluginConfig(tsconfig);
-  if (pluginConfig) {
-    return {
-      pluginConfig,
-      configPath: rootTsconfigPath,
-      rootPath: path.dirname(rootTsconfigPath),
-    };
-  }
 
-  if (Array.isArray(tsconfig.extends)) {
-    for (let extend of tsconfig.extends) {
-      if (path.extname(extend) !== '.json') extend += '.json';
+  const load = async (targetPath: string): Promise<LoadConfigResult> => {
+    const tsconfig = await readTSConfigFile(targetPath);
+    const pluginConfig = getPluginConfig(tsconfig);
+
+    if (pluginConfig) {
+      return {
+        pluginConfig,
+        configPath: targetPath,
+        rootPath: path.dirname(rootTsconfigPath),
+      };
+    }
+
+    if (Array.isArray(tsconfig.extends)) {
+      for (let extend of tsconfig.extends) {
+        if (path.extname(extend) !== '.json') extend += '.json';
+        try {
+          const tsconfigPath = await resolveExtend(extend, path.dirname(rootTsconfigPath));
+          if (tsconfigPath) return load(tsconfigPath);
+        } catch (_error) {}
+      }
+    } else if (tsconfig.extends) {
       try {
-        const tsconfigPath = await resolveExtend(extend, path.dirname(rootTsconfigPath));
-        if (tsconfigPath) {
-          const config = loadConfig(targetPath);
-          return {
-            ...config,
-            rootPath: path.dirname(rootTsconfigPath),
-          };
-        }
+        const tsconfigPath = await resolveExtend(tsconfig.extends, path.dirname(rootTsconfigPath));
+        if (tsconfigPath) return load(tsconfigPath);
       } catch (_error) {}
     }
-  } else if (tsconfig.extends) {
-    try {
-      const tsconfigPath = await resolveExtend(tsconfig.extends, path.dirname(rootTsconfigPath));
-      if (tsconfigPath) {
-        const config = loadConfig(targetPath);
-        return {
-          ...config,
-          rootPath: path.dirname(rootTsconfigPath),
-        };
-      }
-    } catch (_error) {}
-  }
 
-  throw new TadaError(
-    `Could not find a valid GraphQLSP plugin entry in: ${maybeRelative(rootTsconfigPath)}`
-  );
+    throw new TadaError(
+      `Could not find a valid GraphQLSP plugin entry in: ${maybeRelative(rootTsconfigPath)}`
+    );
+  };
+
+  return await load(rootTsconfigPath);
 };
 
 /** @deprecated Use {@link loadConfig} instead */