feat: Add skip option

# Conflicts:
#	src/index.ts
#	test/skip/skip.spec.ts

Author: mihaerzen

src/index.ts

@@ -139,43 +139,28 @@ export function GraphQLCodegen(options?: Options): Plugin {
     debugLog(...args);
   };
 
+  const shouldSkipGeneration = async (context: SkipContext) =>
+    typeof skip === "function" ? await skip(context) : skip;
+
   const generateWithOverride = async (
     overrideConfig: Partial<CodegenConfig>,
+    skipContext: SkipContext,
   ) => {
-    const currentConfig = codegenContext.getConfig();
+    if (await shouldSkipGeneration(skipContext)) {
+      log("Generation skipped", skipContext);
+      return;
+    }
 
-    return await generate({
+    const currentConfig = codegenContext.getConfig();
+    await generate({
       ...currentConfig,
       ...configOverride,
       ...overrideConfig,
       // Vite handles file watching
       watch: false,
     });
-  };
-
-  const shouldSkipGeneration = async (context: SkipContext) => {
-    const skipValue = typeof skip === "function" ? await skip(context) : skip;
-
-    log("Skip evaluated", {
-      ...context,
-      skip: skipValue,
-    });
-
-    return skipValue;
-  };
-
-  const generateIfNotSkipped = async (
-    context: SkipContext,
-    overrideConfig: Partial<CodegenConfig>,
-  ) => {
-    if (await shouldSkipGeneration(context)) {
-      log("Generation skipped", context);
-      return false;
-    }
-
-    await generateWithOverride(overrideConfig);
 
-    return true;
+    log(`Generation successful on ${skipContext.trigger}`);
   };
 
   if (options) log("Plugin initialized with options:", options);
@@ -206,15 +191,9 @@ export function GraphQLCodegen(options?: Options): Plugin {
         if (!runOnStart) return;
 
         try {
-          const generated = await generateIfNotSkipped(
-            { trigger: "start" },
-            configOverrideOnStart,
-          );
-          log(
-            generated
-              ? "Generation successful on start"
-              : "Generation skipped on start",
-          );
+          await generateWithOverride(configOverrideOnStart, {
+            trigger: "start",
+          });
         } catch (error) {
           // GraphQL Codegen handles logging useful errors
           log("Generation failed on start");
@@ -226,15 +205,9 @@ export function GraphQLCodegen(options?: Options): Plugin {
         if (!runOnBuild) return;
 
         try {
-          const generated = await generateIfNotSkipped(
-            { trigger: "build" },
-            configOverrideOnBuild,
-          );
-          log(
-            generated
-              ? "Generation successful on build"
-              : "Generation skipped on build",
-          );
+          await generateWithOverride(configOverrideOnBuild, {
+            trigger: "build",
+          });
         } catch (error) {
           // GraphQL Codegen handles logging useful errors
           log("Generation failed on build");
@@ -257,15 +230,10 @@ export function GraphQLCodegen(options?: Options): Plugin {
           log("File is in match cache");
 
           try {
-            const generated = await generateIfNotSkipped(
-              { trigger: "watch", filePath },
-              configOverrideWatcher,
-            );
-            log(
-              generated
-                ? "Generation successful in file watcher"
-                : "Generation skipped in file watcher",
-            );
+            await generateWithOverride(configOverrideWatcher, {
+              trigger: "watch",
+              filePath,
+            });
           } catch {
             // GraphQL Codegen handles logging useful errors
             log("Generation failed in file watcher");

test/skip/skip.spec.ts

@@ -1,7 +1,7 @@
 import { promises as fs } from "node:fs";
 import { createServer, type UserConfig } from "vite";
 import { afterEach, describe, expect, it, vi, type TestContext } from "vitest";
-import codegen, { type Options } from "../../src/index";
+import codegen, { type Options, type SkipContext } from "../../src/index";
 
 const codegenGenerateMock = vi.hoisted(() => vi.fn());
 vi.mock("@graphql-codegen/cli", async (importOriginal) => {
@@ -108,12 +108,13 @@ describe("skip", () => {
         skip: false,
       },
       {
-        describe: "when skip returns false",
-        skip: () => false,
+        describe: "when skip returns false by matching start trigger",
+        skip: ({ trigger }: SkipContext) => trigger !== "start",
       },
       {
-        describe: "when skip resolves false",
-        skip: () => Promise.resolve(false),
+        describe: "when skip resolves false by matching start trigger",
+        skip: ({ trigger }: SkipContext) =>
+          Promise.resolve(trigger !== "start"),
       },
     ])("it should run codegen $describe", async ({ skip }, context) => {
       await startServer({ skip }, context as TestContextWithServer);
@@ -137,12 +138,13 @@ describe("skip", () => {
         skip: true,
       },
       {
-        describe: "when skip returns true",
-        skip: () => true,
+        describe: "when skip returns true by matching start trigger",
+        skip: ({ trigger }: SkipContext) => trigger === "start",
       },
       {
-        describe: "when skip resolves true",
-        skip: () => Promise.resolve(true),
+        describe: "when skip resolves true by matching start trigger",
+        skip: ({ trigger }: SkipContext) =>
+          Promise.resolve(trigger === "start"),
       },
     ])("it should skip codegen $describe", async ({ skip }, context) => {
       await startServer({ skip }, context as TestContextWithServer);
@@ -162,12 +164,18 @@ describe("skip", () => {
         skip: false,
       },
       {
-        describe: "when skip returns false",
-        skip: () => false,
+        describe: "when skip returns false by matching watch trigger",
+        skip: ({ trigger }: SkipContext) => trigger !== "watch",
       },
       {
-        describe: "when skip resolves false",
-        skip: () => Promise.resolve(false),
+        describe: "when skip resolves false by matching watch trigger",
+        skip: ({ trigger }: SkipContext) =>
+          Promise.resolve(trigger !== "watch"),
+      },
+      {
+        describe: "when skip resolves false by matching filePath",
+        skip: async ({ filePath }: SkipContext) =>
+          filePath !== (await fs.realpath(QUERY_FILE)),
       },
     ])("it should run codegen $describe", async ({ skip }, context) => {
       await startServer(
@@ -197,12 +205,18 @@ describe("skip", () => {
         skip: true,
       },
       {
-        describe: "when skip returns true",
-        skip: () => true,
+        describe: "when skip returns true by matching watch trigger",
+        skip: ({ trigger }: SkipContext) => trigger === "watch",
+      },
+      {
+        describe: "when skip resolves true by matching watch trigger",
+        skip: ({ trigger }: SkipContext) =>
+          Promise.resolve(trigger === "watch"),
       },
       {
-        describe: "when skip resolves true",
-        skip: () => Promise.resolve(true),
+        describe: "when skip resolves true by matching filePath",
+        skip: async ({ filePath }: SkipContext) =>
+          filePath === (await fs.realpath(QUERY_FILE)),
       },
     ])("it should skip codegen $describe", async ({ skip }, context) => {
       await startServer(