feat(nuxt): graphql default scalers and prepend ignore

oku-ui · Feb 7, 2024 · 6f7bca1 · 6f7bca1
1 parent aa19235
commit 6f7bca1
Show file tree

Hide file tree

Showing 11 changed files with 159 additions and 67 deletions.
diff --git a/eslint.config.js b/eslint.config.js
@@ -26,7 +26,6 @@ export default antfu(
       '**/templates.json',
       'packages-core/pergel/nuxt.js',
       '**/pergel/**',
-      '**/generated/**',
     ],
   },
   {

diff --git a/packages/nuxt/playground/server/graphqlYoga-test/generated/schema.mjs b/packages/nuxt/playground/server/graphqlYoga-test/generated/schema.mjs
@@ -1,4 +1,10 @@
-export const schema = `scalar DateTime
+// THIS FILE IS GENERATED, DO NOT EDIT!
+/* eslint-disable eslint-comments/no-unlimited-disable */
+/* tslint:disable */
+/* eslint-disable */
+/* prettier-ignore */
+/* pergel - oku-ui.com/pergel */
+      export const schema = `scalar DateTime
 
 type Query {
   book(id: ID!): Book!

diff --git a/packages/nuxt/playground/server/graphqlYoga-test/generated/server.ts b/packages/nuxt/playground/server/graphqlYoga-test/generated/server.ts
@@ -1,3 +1,9 @@
+// THIS FILE IS GENERATED, DO NOT EDIT!
+/* eslint-disable eslint-comments/no-unlimited-disable */
+/* tslint:disable */
+/* eslint-disable */
+/* prettier-ignore */
+/* pergel - oku-ui.com/pergel */
 import type { GraphQLResolveInfo, GraphQLScalarType, GraphQLScalarTypeConfig } from 'graphql';
 import type { GraphqlYogaContext } from 'pergel/test/types';
 export type Maybe<T> = T | null;
@@ -15,7 +21,7 @@ export type Scalars = {
   Boolean: { input: boolean; output: boolean; }
   Int: { input: number; output: number; }
   Float: { input: number; output: number; }
-  DateTime: { input: any; output: any; }
+  DateTime: { input: Date | string; output: Date | string; }
 };
 
 export type Query = {
@@ -56,11 +62,10 @@ export type SearchInput = {
 
 export type SearchResult = User | Book;
 
-export enum RoleStatus {
-  User = 'user',
-  Admin = 'admin',
-  Superadmin = 'superadmin'
-}
+export type RoleStatus =
+  | 'user'
+  | 'admin'
+  | 'superadmin';
 
 export type User = {
   __typename?: 'User';

diff --git a/packages/nuxt/src/runtime/core/setupModules.ts b/packages/nuxt/src/runtime/core/setupModules.ts
@@ -96,6 +96,7 @@ async function initModules(nuxt: Nuxt) {
             projectNameCamelCase: camelCase(projectName, { normalize: true }),
             projectNameCamelCaseWithPergel: camelCase(`pergel-${projectName}`, { normalize: true }),
             generatorFunctionName: (text: string) => camelCase(`${projectName}-${text}`),
+            generatorFolderName: (moduleName, projectName) => `${camelCase(moduleName)}-${camelCase(projectName)}`,
             folderName: `${camelCase(moduleName)}-${camelCase(projectName)}`,
             importPath: join(projectName, moduleName),
             buildDir: join(nuxt.options.buildDir, 'pergel', projectName, moduleName),
@@ -271,6 +272,7 @@ export async function setupModules(data: {
           projectNameCamelCase: camelCase(projectName, { normalize: true }),
           projectNameCamelCaseWithPergel: camelCase(`pergel-${projectName}`, { normalize: true }),
           generatorFunctionName: (text: string) => camelCase(`${projectName}-${text}`),
+          generatorFolderName: (moduleName, projectName) => `${camelCase(moduleName)}-${camelCase(projectName)}`,
           folderName: `${camelCase(moduleName)}-${camelCase(projectName)}`,
           importPath: join(projectName, moduleName),
           buildDir: join(data.nuxt.options.buildDir, 'pergel', projectName, moduleName),

diff --git a/packages/nuxt/src/runtime/core/types/module.ts b/packages/nuxt/src/runtime/core/types/module.ts
@@ -52,6 +52,8 @@ export interface ResolvedPergelModuleOptions {
    */
   folderName: string
 
+  generatorFolderName: (moduleName: PergelModuleNames, projectName: string) => string
+
   /**
    * @default
    * projectname: TEst

diff --git a/packages/nuxt/src/runtime/modules/graphqlYoga/types.ts b/packages/nuxt/src/runtime/modules/graphqlYoga/types.ts
@@ -143,7 +143,18 @@ export interface GraphQLYogaConfig extends PergelModuleOptions {
 
       /**
        * Codegen config
-       * @default undefined
+       * @default
+          scalars: {
+            DateTime: DateTimeResolver.extensions.codegenScalarType as any,
+            UUID: UUIDResolver.extensions.codegenScalarType as any,
+            JSON: JSONResolver.extensions.codegenScalarType as any,
+            JSONObject: JSONResolver.extensions.codegenScalarType as any,
+            NonEmptyString: NonEmptyStringResolver.extensions.codegenScalarType as any,
+            Currency: CurrencyResolver.extensions.codegenScalarType as any,
+          },
+          enumsAsTypes: true,
+          useTypeImports: true,
+          strictScalars: true,
        */
       config?: (args: {
         dir: {
@@ -160,6 +171,11 @@ export interface GraphQLYogaConfig extends PergelModuleOptions {
            * .nuxt/pergel/${projectName}/graphqlYoga
            */
           nuxtModule: string
+
+          /**
+           * #projectName/server/drizzle/schema
+           */
+          drizzleShemas: (key: string) => string
         }
       }) => CodegenServerConfig
     }
@@ -261,6 +277,11 @@ export interface ResolvedGraphQLYogaConfig extends GraphQLYogaConfig, ResolvedPe
            * .nuxt/pergel/${projectName}/graphqlYoga
            */
           nuxtModule: string
+
+          /**
+           * #projectName/server/drizzle/schema
+           */
+          drizzleShemas: (key: string) => string
         }
       }) => CodegenServerConfig
     }

diff --git a/packages/nuxt/src/runtime/modules/graphqlYoga/utils/codegen.ts b/packages/nuxt/src/runtime/modules/graphqlYoga/utils/codegen.ts
@@ -2,7 +2,7 @@ import { writeFileSync } from 'node:fs'
 import type { LoadSchemaOptions, LoadTypedefsOptions, UnnormalizedTypeDefPointer } from '@graphql-tools/load'
 import { loadDocumentsSync, loadSchemaSync } from '@graphql-tools/load'
 import { GraphQLFileLoader } from '@graphql-tools/graphql-file-loader'
-import type { Types } from '@graphql-codegen/plugin-helpers'
+import type { PluginFunction, Types } from '@graphql-codegen/plugin-helpers'
 import type { GraphQLSchema } from 'graphql'
 import { codegen } from '@graphql-codegen/core'
 import { parse, printSchema } from 'graphql'
@@ -15,7 +15,30 @@ import type { Source } from '@graphql-tools/utils'
 import * as typescriptPlugin from '@graphql-codegen/typescript'
 import * as typescriptResolversPlugin from '@graphql-codegen/typescript-resolvers'
 import * as urqlIntrospectionPlugin from '@graphql-codegen/urql-introspection'
+
 import consola from 'consola'
+import defu from 'defu'
+import {
+  CurrencyResolver,
+  DateTimeResolver,
+  JSONResolver,
+  NonEmptyStringResolver,
+  UUIDResolver,
+} from 'graphql-scalars'
+
+const pluginContent: PluginFunction<any> = (_schema, _documents, _config, _info) => {
+  return {
+    prepend: [
+      '// THIS FILE IS GENERATED, DO NOT EDIT!',
+      '/* eslint-disable eslint-comments/no-unlimited-disable */',
+      '/* tslint:disable */',
+      '/* eslint-disable */',
+      '/* prettier-ignore */',
+      '/* pergel - oku-ui.com/pergel */',
+    ],
+    content: '',
+  }
+}
 
 export type CodegenClientConfig = TypeScriptPluginConfig & TypeScriptDocumentsPluginConfig & TypeScriptTypedDocumentNodesConfig
 
@@ -77,20 +100,37 @@ async function loadDocumentsFiles(pointerOrPointers: UnnormalizedTypeDefPointer
 
 async function typescriptResolvers(
   schema: GraphQLSchema,
-  config: CodegenServerConfig = { },
+  config: CodegenServerConfig,
 ) {
+  const mergeConfig = defu(config, {
+    scalars: {
+      DateTime: DateTimeResolver.extensions.codegenScalarType as any,
+      UUID: UUIDResolver.extensions.codegenScalarType as any,
+      JSON: JSONResolver.extensions.codegenScalarType as any,
+      JSONObject: JSONResolver.extensions.codegenScalarType as any,
+      NonEmptyString: NonEmptyStringResolver.extensions.codegenScalarType as any,
+      Currency: CurrencyResolver.extensions.codegenScalarType as any,
+    },
+    enumsAsTypes: true,
+    useTypeImports: true,
+    strictScalars: true,
+  } as CodegenServerConfig)
   // See https://www.graphql-code-generator.com/docs/getting-started/programmatic-usage for more details
   const res = await codegen({
     filename: '',
     schema: parse(printSchema(schema)),
     // TODO: Add support for fragments
     documents: [],
-    config,
+    config: mergeConfig,
     plugins: [
+      { pluginContent: {} },
       { typescript: {} },
       { typescriptResolvers: {} },
     ],
     pluginMap: {
+      pluginContent: {
+        plugin: pluginContent,
+      },
       typescript: typescriptPlugin,
       typescriptResolvers: typescriptResolversPlugin,
     },
@@ -104,17 +144,25 @@ async function typescriptResolvers(
 
 async function urqlIntrospection(
   schema: GraphQLSchema,
-  config: CodegenClientConfig = {},
+  config: CodegenClientConfig,
 ) {
+  const mergeConfig = defu(config, {
+    useTypeImports: true,
+  } as CodegenClientConfig)
+
   const res = await codegen({
     filename: 'a.ts',
     schema: parse(printSchema(schema)),
     documents: [],
-    config,
+    config: mergeConfig,
     plugins: [
+      { pluginContent: {} },
       { urqlIntrospection: {} },
     ],
     pluginMap: {
+      pluginContent: {
+        plugin: pluginContent,
+      },
       urqlIntrospection: urqlIntrospectionPlugin,
     },
   }).catch((e) => {
@@ -128,22 +176,31 @@ async function urqlIntrospection(
 async function generateTypedDocumentNode(
   schema: GraphQLSchema,
   documents: Types.DocumentFile[],
-  config: CodegenClientConfig = {},
+  config: CodegenClientConfig,
 ) {
+  const mergeConfig = defu(config, {
+    enumsAsTypes: true,
+    useTypeImports: true,
+  } as CodegenClientConfig)
+
   // See https://www.graphql-code-generator.com/docs/getting-started/programmatic-usage for more details
   const res = await codegen({
     // Filename is not used. This is because the typescript plugin returns a string instead of writing to a file.
     filename: 'a.ts',
     schema: parse(printSchema(schema)),
     // TODO: Add support for fragments
     documents,
-    config,
+    config: mergeConfig,
     plugins: [
+      { pluginContent: {} },
       { typescript: {} },
       { typescriptOperations: {} },
       { typedDocumentNode: {} },
     ],
     pluginMap: {
+      pluginContent: {
+        plugin: pluginContent,
+      },
       typescript: typescriptPlugin,
       typescriptOperations: {
         plugin: typescriptOperationsPlugin,