Add generated file header

Author: miorel

workspaces/leetcode-api/graphql-codegen.config.ts

@@ -10,43 +10,52 @@ const commonTypeScriptPluginConfig = {
   // TODO: add strictScalars: true
 };
 
+const headerPlugin = {
+  add: {
+    content: `
+      // THIS FILE IS GENERATED! DO NOT MODIFY IT MANUALLY!!
+      // Instead, update the generation process or inputs and run \`yarn codegen\`.
+    `,
+  },
+};
+
 const config: CodegenConfig = {
   schema: "schema.graphql",
   documents: ["src/**/*.graphql"],
   overwrite: true,
   emitLegacyCommonJSImports: false,
   generates: {
     "src/graphqlTypes.generated.ts": {
-      plugins: ["typescript"],
+      plugins: [headerPlugin, "typescript"],
       config: commonTypeScriptPluginConfig,
     },
     "src/": {
       preset: "near-operation-file",
       presetConfig: {
-        // TODO: get this to use a ".ts" extension in the output
-        baseTypesPath: "~../../graphqlTypes.generated",
+        // The base types are not imported because of the use of
+        // `globalNamespace` below, instead our custom plugin will add the
+        // import, so that it can end up _below_ the header.
+        baseTypesPath: "<not-used-but-cannot-be-empty>",
+
         extension: ".generated.ts",
         fileName: "fetchGraphQL",
       },
       plugins: [
-        "typescript-operations",
+        headerPlugin,
+        { "typescript-operations": { globalNamespace: false } },
         "./src/scripts/codegen/graphqlCodegenPlugin.ts",
       ],
       config: {
         ...commonTypeScriptPluginConfig,
 
-        // Our custom plugin will handle the exports!
+        // Our custom plugin will handle the imports and exports!
+        globalNamespace: true,
         noExport: true,
       },
     },
   },
   hooks: {
-    afterAllFileWrite: [
-      // The per-operation files can end up with imports in the middle.
-      "eslint --fix --rule import-x/first:warn",
-
-      "prettier --write",
-    ],
+    afterAllFileWrite: ["prettier --write"],
   },
 };
 

workspaces/leetcode-api/package.json

@@ -32,6 +32,7 @@
   },
   "devDependencies": {
     "@code-chronicles/eslint-config": "workspace:*",
+    "@graphql-codegen/add": "5.0.3",
     "@graphql-codegen/cli": "5.0.2",
     "@graphql-codegen/near-operation-file-preset": "3.0.0",
     "@types/node": "22.7.4",

workspaces/leetcode-api/src/api/active-daily-coding-challenge-question/fetchGraphQL.generated.ts

@@ -1,8 +1,10 @@
-import type * as Types from "../../graphqlTypes.generated.js";
+// THIS FILE IS GENERATED! DO NOT MODIFY IT MANUALLY!!
+// Instead, update the generation process or inputs and run `yarn codegen`.
 
 import type { Simplify } from "type-fest";
 
 import { getGraphQLClient } from "../../getGraphQLClient.ts";
+import type * as Types from "../../graphqlTypes.generated.ts";
 
 type ActiveDailyCodingChallengeQuestionQueryVariables = Types.Exact<{
   [key: string]: never;

workspaces/leetcode-api/src/api/question-list/fetchGraphQL.generated.ts

@@ -1,8 +1,10 @@
-import type * as Types from "../../graphqlTypes.generated.js";
+// THIS FILE IS GENERATED! DO NOT MODIFY IT MANUALLY!!
+// Instead, update the generation process or inputs and run `yarn codegen`.
 
 import type { Simplify } from "type-fest";
 
 import { getGraphQLClient } from "../../getGraphQLClient.ts";
+import type * as Types from "../../graphqlTypes.generated.ts";
 
 type QuestionListQueryVariables = Types.Exact<{
   categorySlug: Types.Scalars["String"]["input"];

workspaces/leetcode-api/src/api/recent-ac-submission-list/fetchGraphQL.generated.ts

@@ -1,8 +1,10 @@
-import type * as Types from "../../graphqlTypes.generated.js";
+// THIS FILE IS GENERATED! DO NOT MODIFY IT MANUALLY!!
+// Instead, update the generation process or inputs and run `yarn codegen`.
 
 import type { Simplify } from "type-fest";
 
 import { getGraphQLClient } from "../../getGraphQLClient.ts";
+import type * as Types from "../../graphqlTypes.generated.ts";
 
 type RecentAcSubmissionListQueryVariables = Types.Exact<{
   username: Types.Scalars["String"]["input"];

workspaces/leetcode-api/src/api/topic/fetchGraphQL.generated.ts

@@ -1,8 +1,10 @@
-import type * as Types from "../../graphqlTypes.generated.js";
+// THIS FILE IS GENERATED! DO NOT MODIFY IT MANUALLY!!
+// Instead, update the generation process or inputs and run `yarn codegen`.
 
 import type { Simplify } from "type-fest";
 
 import { getGraphQLClient } from "../../getGraphQLClient.ts";
+import type * as Types from "../../graphqlTypes.generated.ts";
 
 type TopicQueryVariables = Types.Exact<{
   topicId: Types.Scalars["Int"]["input"];

workspaces/leetcode-api/src/graphqlTypes.generated.ts

@@ -1,3 +1,6 @@
+// THIS FILE IS GENERATED! DO NOT MODIFY IT MANUALLY!!
+// Instead, update the generation process or inputs and run `yarn codegen`.
+
 export type Maybe<T> = T | null;
 export type InputMaybe<T> = Maybe<T>;
 export type Exact<T extends { [key: string]: unknown }> = {

workspaces/leetcode-api/src/scripts/codegen/graphqlCodegenPlugin.ts

@@ -28,19 +28,27 @@ export const plugin: PluginFunction<{}> = function plugin(_schema, documents) {
 
   // TODO: strip out the operation name from the minified GraphQL
 
-  // Note: The import will be moved to the top by ESLint post-processing.
-  return `
-    export type QueryVariables = Simplify<${operationName}QueryVariables>;
-    export type Query = Simplify<${operationName}Query>;  
-
-    export const QUERY = ${JSON.stringify(minifiedGraphql)};
-
-    export function fetchGraphQL(variables: QueryVariables): Promise<Query> {
-      return getGraphQLClient().request(QUERY, variables);
-    }
-
-    import type { Simplify } from 'type-fest';
-
-    import { getGraphQLClient } from "../../getGraphQLClient.ts";
-  `;
+  return {
+    prepend: [
+      `
+        import type { Simplify } from "type-fest";
+
+        import { getGraphQLClient } from "../../getGraphQLClient.ts";
+        import type * as Types from "../../graphqlTypes.generated.ts";
+      `,
+    ],
+    append: [
+      `
+        export type QueryVariables = Simplify<${operationName}QueryVariables>;
+        export type Query = Simplify<${operationName}Query>;  
+
+        export const QUERY = ${JSON.stringify(minifiedGraphql)};
+
+        export function fetchGraphQL(variables: QueryVariables): Promise<Query> {
+          return getGraphQLClient().request(QUERY, variables);
+        }
+      `,
+    ],
+    content: "",
+  };
 };