feat: add option to provide a custom output path (#47)

* add option to provide a custom output path

* add some help with npm scripts.

* put getOutputDocumentsPath into a function and use rootResolver

.nvmrc

@@ -0,0 +1 @@
+v22

docs/configuration/module.md

@@ -146,11 +146,12 @@ operations types.
 
 [Check out `@graphql-codegen/typescript-operations` for all available options](https://www.the-guild.dev/graphql/codegen/plugins/typescript/typescript-operations)
 
-## outputDocuments: boolean
+## outputDocuments: boolean | string
 
-Output the compiled documents to disk. Path is
+Output the compiled documents to disk. If boolean then path is
 $buildDir/nuxt-graphql-middleware/documents, usually
-`/.nuxt/nuxt-graphql-middleware/documents`.
+`/.nuxt/nuxt-graphql-middleware/documents` else we use `outputDocuments` as the
+path.
 
 ### default
 

package.json.md

@@ -0,0 +1,13 @@
+This file contains explanation and help around code in package.json
+
+# scritps
+
+For the following commands to work you need to execute npm run dev:prepare at
+least once
+
+- prepack
+- lint
+- typecheck
+- test
+
+To create a build run `npm run prepack`

src/helpers/index.ts

@@ -19,8 +19,9 @@ import { generateSchema, generateTemplates } from './../codegen'
 import { type GraphqlMiddlewareDocument } from './../types'
 import { type ModuleOptions } from './../module'
 import { logDocuments } from './reporter'
+import { name } from '../../package.json'
 
-export const logger = useLogger('nuxt-graphql-middleware')
+export const logger = useLogger(name)
 
 export const defaultOptions: ModuleOptions = {
   codegenConfig: {
@@ -494,3 +495,19 @@ export async function outputDocuments(
     }
   })
 }
+
+export async function getOutputDocumentsPath(
+  optionsOutputDocuments: ModuleOptions['outputDocuments'],
+  nuxtBuildDir: string,
+  resolvePath: Resolver['resolvePath'],
+): Promise<string | null> {
+  if (!optionsOutputDocuments) {
+    return null
+  }
+
+  if (typeof optionsOutputDocuments === 'boolean') {
+    return resolve(nuxtBuildDir, `${name}/documents`)
+  } else {
+    return await resolvePath(optionsOutputDocuments)
+  }
+}

src/module.ts

@@ -29,6 +29,7 @@ import {
   logger,
   fileExists,
   outputDocuments,
+  getOutputDocumentsPath,
 } from './helpers'
 import { type CodegenResult } from './codegen'
 import { type ClientFunctions, type ServerFunctions } from './rpc-types'
@@ -207,8 +208,9 @@ export interface ModuleOptions {
   /**
    * Set to true if you want to output each compiled query and mutation in the
    * .nuxt folder.
+   * Set to a path to output to a custom path.
    */
-  outputDocuments?: boolean
+  outputDocuments?: boolean | string
 
   /**
    * Enable Nuxt DevTools integration.
@@ -354,17 +356,19 @@ export default defineNuxtModule<ModuleOptions>({
         rpc?.broadcast.documentsUpdated(documents)
 
         // Output the generated documents if desired.
-        if (options.outputDocuments) {
-          const destFolder = resolve(
-            nuxt.options.buildDir,
-            'nuxt-graphql-middleware/documents',
-          )
+        const outputDocumentsPath = await getOutputDocumentsPath(
+          options.outputDocuments,
+          nuxt.options.buildDir,
+          rootResolver.resolvePath,
+        )
+        if (outputDocumentsPath) {
+          outputDocuments(outputDocumentsPath, documents)
 
-          outputDocuments(destFolder, documents)
           if (isFirst) {
-            logger.info('Documents generated at ' + destFolder)
+            logger.info('Documents generated at ' + outputDocumentsPath)
           }
         }
+
         if (hasErrors) {
           throw new Error('Documents has errors.')
         }