feat: add pnpm workspace configuration and enhance TypeScript support for GraphQL Yoga

- Introduced a new pnpm workspace configuration in `pnpm-workspace.yaml` to manage multiple packages.
- Updated `src/index.ts` to include TypeScript path aliases for GraphQL types, improving IDE support.
- Moved GraphQL Yoga options declaration from `src/types.ts` to `src/index.ts` for better organization.
- Added a utility function `relativeWithDot` in `src/utils.ts` to handle relative paths with dot notation.
- Modified `tsconfig.json` to exclude additional directories related to the new workspace structure.

Author: productdevbook

.npmrc

@@ -0,0 +1 @@
+ignore-workspace-root-check=true

playground/nitro.config.ts

@@ -1,4 +1,5 @@
 import { defineNitroConfig } from 'nitropack/config'
+// import 'nitro-graphql' // Import for types
 
 export default defineNitroConfig({
   srcDir: 'server',

pnpm-lock.yaml

@@ -0,0 +1,3 @@
+packages:
+  - playground
+  - playground-nuxt

pnpm-workspace.yaml

@@ -2,8 +2,19 @@ import type { Nitro } from 'nitropack/types'
 import type { NitroGraphQLOptions } from './types'
 
 import { defineNitroModule } from 'nitropack/kit'
-import { join } from 'pathe'
+import { dirname, join, resolve } from 'pathe'
 import { devmode } from './dev'
+import { relativeWithDot } from './utils'
+
+declare module 'nitropack' {
+  interface NitroOptions {
+    graphqlYoga?: NitroGraphQLOptions
+  }
+
+  interface NitroRuntimeConfig {
+    graphqlYoga?: NitroGraphQLOptions
+  }
+}
 
 export default defineNitroModule({
   name: 'nitro:graphql-yoga',
@@ -153,18 +164,32 @@ export default defineEventHandler(async (event) => {
       })
     }
 
+    const tsConfigPath = resolve(
+      nitro.options.buildDir,
+      nitro.options.typescript.tsconfigPath,
+    )
+    const tsconfigDir = dirname(tsConfigPath)
+    const typesDir = resolve(nitro.options.buildDir, 'types')
+
     nitro.hooks.hook('types:extend', (types) => {
       // Add TypeScript path alias for IDE support
       types.tsConfig ||= {}
       types.tsConfig.compilerOptions ??= {}
       types.tsConfig.compilerOptions.paths ??= {}
-      types.tsConfig.compilerOptions.paths['#build/graphql-types.generated'] = [
-        join(nitro.options.buildDir, 'types', 'graphql-types.generated.ts'),
+      // types.tsConfig.compilerOptions.paths['#build/graphql-types.generated'] = [
+      //   join(nitro.options.buildDir, 'types', 'graphql-types.generated.ts'),
+      // ]
+      types.tsConfig.compilerOptions.paths['#graphql/server'] = [
+        relativeWithDot(tsconfigDir, join(typesDir, 'graphql-types.generated.ts')),
+      ]
+      types.tsConfig.compilerOptions.paths['#graphql/client'] = [
+        relativeWithDot(tsconfigDir, join(typesDir, 'graphql-client.generated.ts')),
       ]
       types.tsConfig.include = types.tsConfig.include || []
       types.tsConfig.include.push(
-        join(nitro.options.buildDir, 'types', 'graphql-types.generated.ts'),
-        join(nitro.options.buildDir, 'types', 'graphql.d.ts'),
+        relativeWithDot(tsconfigDir, join(typesDir, 'graphql-client.generated.ts')),
+        relativeWithDot(tsconfigDir, join(typesDir, 'graphql-types.generated.ts')),
+        relativeWithDot(tsconfigDir, join(typesDir, 'graphql.d.ts')),
       )
     })
 

src/index.ts

@@ -32,14 +32,4 @@ export interface NitroGraphQLOptions {
   yogaConfig?: Partial<YogaServerOptions<any, any>>
 }
 
-declare module 'nitropack' {
-  interface NitroOptions {
-    graphqlYoga?: NitroGraphQLOptions
-  }
-
-  interface NitroRuntimeConfig {
-    graphqlYoga?: NitroGraphQLOptions
-  }
-}
-
 export interface Resolvers {}

src/types.ts

@@ -1,5 +1,6 @@
 import type { YogaServerOptions } from 'graphql-yoga'
 import type { GraphQLSchemaConfig, Resolvers } from 'nitro-graphql/types'
+import { relative } from 'pathe'
 
 // TODO: check used.
 export function defineGraphQLSchema(config: GraphQLSchemaConfig): GraphQLSchemaConfig {
@@ -20,3 +21,9 @@ export function defineYogaConfig<TServerContext = any, TUserContext = any>(
 ): Partial<YogaServerOptions<TServerContext, TUserContext>> {
   return config
 }
+const RELATIVE_RE = /^\.{1,2}\//
+
+export function relativeWithDot(from: string, to: string) {
+  const rel = relative(from, to)
+  return RELATIVE_RE.test(rel) ? rel : `./${rel}`
+}

src/utils.ts

@@ -26,5 +26,5 @@
     "skipLibCheck": true
   },
   "include": ["src/**/*"],
-  "exclude": ["node_modules", "dist"]
+  "exclude": ["node_modules", "dist", "playground", "playground-nuxt"]
 }