feat(internal): Add support for ${configDir} to directory path conf…

…igs (#239)
0no-co · Apr 21, 2024 · 5888a0c · 5888a0c
1 parent a96d587
commit 5888a0c
Show file tree

Hide file tree

Showing 10 changed files with 59 additions and 10 deletions.
diff --git a/.changeset/tame-beers-look.md b/.changeset/tame-beers-look.md
@@ -0,0 +1,5 @@
+---
+"@gql.tada/cli-utils": minor
+---
+
+Add support for `${configDir}` to directory path configs. When used in paths in our configuration, `${configDir}` will be substituted with the location of the main `tsconfig.json`
diff --git a/.changeset/twenty-students-hunt.md b/.changeset/twenty-students-hunt.md
@@ -0,0 +1,5 @@
+---
+"@gql.tada/internal": patch
+---
+
+Add support for `${configDir}` to directory path configs.
diff --git a/packages/cli-utils/src/commands/check/runner.ts b/packages/cli-utils/src/commands/check/runner.ts
@@ -37,7 +37,7 @@ export async function* run(tty: TTY, opts: Options): AsyncIterable<ComposeInput>
   let pluginConfig: GraphQLSPConfig;
   try {
     configResult = await loadConfig(opts.tsconfig);
-    pluginConfig = parseConfig(configResult.pluginConfig);
+    pluginConfig = parseConfig(configResult.pluginConfig, configResult.rootPath);
   } catch (error) {
     throw logger.externalError('Failed to load configuration.', error);
   }

diff --git a/packages/cli-utils/src/commands/doctor/runner.ts b/packages/cli-utils/src/commands/doctor/runner.ts
@@ -147,7 +147,7 @@ export async function* run(): AsyncIterable<ComposeInput> {
 
   let pluginConfig: GraphQLSPConfig;
   try {
-    pluginConfig = parseConfig(configResult.pluginConfig);
+    pluginConfig = parseConfig(configResult.pluginConfig, configResult.rootPath);
   } catch (error) {
     throw logger.externalError(
       `The plugin configuration for ${logger.code('"@0no-co/graphqlsp"')} seems to be invalid.`,

diff --git a/packages/cli-utils/src/commands/generate-output/runner.ts b/packages/cli-utils/src/commands/generate-output/runner.ts
@@ -35,7 +35,7 @@ export async function* run(tty: TTY, opts: OutputOptions): AsyncIterable<Compose
   let pluginConfig: GraphQLSPConfig;
   try {
     configResult = await loadConfig(opts.tsconfig);
-    pluginConfig = parseConfig(configResult.pluginConfig);
+    pluginConfig = parseConfig(configResult.pluginConfig, configResult.rootPath);
   } catch (error) {
     throw logger.externalError('Failed to load configuration.', error);
   }

diff --git a/packages/cli-utils/src/commands/generate-persisted/runner.ts b/packages/cli-utils/src/commands/generate-persisted/runner.ts
@@ -26,7 +26,7 @@ export async function* run(tty: TTY, opts: PersistedOptions): AsyncIterable<Comp
   let pluginConfig: GraphQLSPConfig;
   try {
     configResult = await loadConfig(opts.tsconfig);
-    pluginConfig = parseConfig(configResult.pluginConfig);
+    pluginConfig = parseConfig(configResult.pluginConfig, configResult.rootPath);
   } catch (error) {
     throw logger.externalError('Failed to load configuration.', error);
   }

diff --git a/packages/cli-utils/src/commands/generate-schema/runner.ts b/packages/cli-utils/src/commands/generate-schema/runner.ts
@@ -44,7 +44,7 @@ export async function* run(tty: TTY, opts: SchemaOptions): AsyncIterable<Compose
     let pluginConfig: GraphQLSPConfig;
     try {
       configResult = await loadConfig(opts.tsconfig);
-      pluginConfig = parseConfig(configResult.pluginConfig);
+      pluginConfig = parseConfig(configResult.pluginConfig, configResult.rootPath);
     } catch (error) {
       throw logger.externalError('Failed to load configuration.', error);
     }

diff --git a/packages/cli-utils/src/commands/turbo/runner.ts b/packages/cli-utils/src/commands/turbo/runner.ts
@@ -28,7 +28,7 @@ export async function* run(tty: TTY, opts: TurboOptions): AsyncIterable<ComposeI
   let pluginConfig: GraphQLSPConfig;
   try {
     configResult = await loadConfig(opts.tsconfig);
-    pluginConfig = parseConfig(configResult.pluginConfig);
+    pluginConfig = parseConfig(configResult.pluginConfig, configResult.rootPath);
   } catch (error) {
     throw logger.externalError('Failed to load configuration.', error);
   }

diff --git a/packages/internal/src/config.ts b/packages/internal/src/config.ts
@@ -1,5 +1,7 @@
+import * as path from 'node:path';
 import { TadaError } from './errors';
-import type { SchemaOrigin } from './loaders/types';
+import { getURLConfig } from './loaders';
+import type { SchemaOrigin } from './loaders';
 
 export interface GraphQLSPConfig {
   schema: SchemaOrigin;
@@ -9,7 +11,31 @@ export interface GraphQLSPConfig {
   template?: string;
 }
 
-export const parseConfig = (input: Record<string, unknown>) => {
+export const parseConfig = (
+  input: Record<string, 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()
+) => {
+  const resolveConfigDir = (input: string | undefined) => {
+    if (!input) return input;
+    return path.normalize(
+      input.replace(/\${([^}]+)}/, (_match, name) => {
+        if (name === 'configDir') {
+          return rootPath;
+        } else {
+          throw new TadaError(
+            `Substitution "\${${name}}" is not recognized (did you mean 'configDir'?)`
+          );
+        }
+      })
+    );
+  };
+
   if (input.schema && typeof input.schema === 'object') {
     const { schema } = input;
     if (!('url' in schema)) {
@@ -59,5 +85,18 @@ export const parseConfig = (input: Record<string, unknown>) => {
     throw new TadaError("Configuration contains a `template` property, but it's not a string");
   }
 
-  return input as any as GraphQLSPConfig;
+  const output = input as any as GraphQLSPConfig;
+
+  let schema: SchemaOrigin = output.schema;
+  if (typeof schema === 'string') {
+    const url = getURLConfig(schema);
+    if (!url) schema = resolveConfigDir(schema) || schema;
+  }
+
+  return {
+    ...output,
+    tadaOutputLocation: resolveConfigDir(output.tadaOutputLocation),
+    tadaTurboLocation: resolveConfigDir(output.tadaTurboLocation),
+    tadaPersistedLocation: resolveConfigDir(output.tadaPersistedLocation),
+  } satisfies GraphQLSPConfig;
 };
diff --git a/packages/internal/src/loaders/index.ts b/packages/internal/src/loaders/index.ts
@@ -7,7 +7,7 @@ import { loadFromURL } from './url';
 
 export { loadFromSDL, loadFromURL };
 
-const getURLConfig = (origin: SchemaOrigin | null) => {
+export const getURLConfig = (origin: SchemaOrigin | null) => {
   try {
     return origin
       ? {