feat: multi-project support (#36)

Author: aaronadamsCA

src/index.ts

@@ -54,6 +54,10 @@ export interface Options {
    * @default false
    */
   matchOnSchemas?: boolean;
+  /**
+   * Name of a project in a multi-project config file.
+   */
+  project?: string;
   /**
    * Manually define the codegen config.
    */
@@ -98,6 +102,7 @@ export function GraphQLCodegen(options?: Options): Plugin {
     throwOnBuild = true,
     matchOnDocuments = true,
     matchOnSchemas = false,
+    project = null,
     config = null,
     configOverride = {},
     configOverrideOnStart = {},
@@ -140,6 +145,7 @@ export function GraphQLCodegen(options?: Options): Plugin {
           log("Loading codegen context:", configFilePathOverride ?? cwd);
           codegenContext = await loadContext(configFilePathOverride);
         }
+        if (project != null) codegenContext.useProject(project);
         log("Loading codegen context successful");
       } catch (error) {
         log("Loading codegen context failed");

test/graphql-multi-project/__snapshots__/graphql-multi-project.spec.ts.snap

@@ -0,0 +1,30 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`graphql-multi-project > generates 1`] = `
+"export type Maybe<T> = T | null;
+export type InputMaybe<T> = Maybe<T>;
+export type Exact<T extends { [key: string]: unknown }> = { [K in keyof T]: T[K] };
+export type MakeOptional<T, K extends keyof T> = Omit<T, K> & { [SubKey in K]?: Maybe<T[SubKey]> };
+export type MakeMaybe<T, K extends keyof T> = Omit<T, K> & { [SubKey in K]: Maybe<T[SubKey]> };
+export type MakeEmpty<T extends { [key: string]: unknown }, K extends keyof T> = { [_ in K]?: never };
+export type Incremental<T> = T | { [P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never };
+/** All built-in and custom scalars, mapped to their actual values */
+export type Scalars = {
+  ID: { input: string; output: string; }
+  String: { input: string; output: string; }
+  Boolean: { input: boolean; output: boolean; }
+  Int: { input: number; output: number; }
+  Float: { input: number; output: number; }
+};
+
+export type Query = {
+  __typename?: 'Query';
+  foo?: Maybe<Scalars['String']['output']>;
+};
+
+export type FooQueryVariables = Exact<{ [key: string]: never; }>;
+
+
+export type FooQuery = { __typename?: 'Query', foo?: string | null };
+"
+`;

test/graphql-multi-project/graphql-multi-project.spec.ts

@@ -0,0 +1,42 @@
+import { promises as fs } from "node:fs";
+import { createServer, type UserConfig, type ViteDevServer } from "vite";
+import { afterAll, afterEach, beforeAll, describe, expect, it } from "vitest";
+import codegen from "../../src/index";
+
+const TEST_PATH = "./test/graphql-multi-project" as const;
+const OUTPUT_PATH = `${TEST_PATH}/generated` as const;
+const OUTPUT_FILE = `${OUTPUT_PATH}/graphql.ts` as const;
+
+const viteConfig = {
+  root: import.meta.dirname,
+  plugins: [
+    codegen({
+      configFilePathOverride: `${TEST_PATH}/graphql.config.yml`,
+      project: "foo",
+    }),
+  ],
+} satisfies UserConfig;
+
+describe("graphql-multi-project", () => {
+  let viteServer: ViteDevServer | null = null;
+
+  beforeAll(async () => {
+    viteServer = await createServer(viteConfig).then((s) => s.listen());
+  });
+
+  afterAll(async () => {
+    await viteServer?.close();
+    viteServer = null;
+  });
+
+  afterEach(async () => {
+    await fs.rm(OUTPUT_PATH, { recursive: true });
+  });
+
+  it("generates", async () => {
+    await new Promise((resolve) => setTimeout(resolve, 200));
+    const file = await fs.readFile(OUTPUT_FILE, "utf-8");
+
+    expect(file).toMatchSnapshot();
+  });
+});

test/graphql-multi-project/graphql.config.yml

@@ -0,0 +1,11 @@
+projects:
+  foo:
+    schema: ./test/graphql-multi-project/schema.graphql
+    documents: ./test/graphql-multi-project/graphql/**/*.graphql
+    extensions:
+      codegen:
+        generates:
+          ./test/graphql-multi-project/generated/graphql.ts:
+            plugins:
+              - typescript
+              - typescript-operations

test/graphql-multi-project/graphql/queries/Foo.graphql

@@ -0,0 +1,3 @@
+query Foo {
+  foo
+}

test/graphql-multi-project/schema.graphql

@@ -0,0 +1,3 @@
+type Query {
+  foo: String
+}