feat: gentime setting for output directory

package.json

@@ -25,7 +25,11 @@
     "./generator": {
       "require": "./dist-cjs/entrypoints/generator.js",
       "import": "./dist-esm/entrypoints/generator.js"
-    }
+    },
+    "./_/*": {
+      "require": "./dist-cjs/*.js",
+      "import": "./dist-esm/*.js"
+   }
   },
   "types": "./dist-cjs/entrypoints/main.d.ts",
   "typesVersions": {

src/cli/nexus-prisma.ts

@@ -28,7 +28,7 @@ generatorHandler({
   },
   // async required by interface
   // eslint-disable-next-line
-  async onGenerate({ dmmf, otherGenerators }) {
+  async onGenerate({ dmmf, otherGenerators, generator }) {
     const prismaClientGenerator = otherGenerators.find((g) => g.provider.value === 'prisma-client-js')
 
     // TODO test showing this pretty error in action
@@ -39,6 +39,18 @@ generatorHandler({
       )
     }
 
+    // TODO If the user is using nexus-prisma.config.ts then that should be the preferred source for this configuration because it is type safe. Give them a warning so they are aware.
+    if (generator.isCustomOutput) {
+      if (!generator.output) {
+        throw new Error(`Failed to read the custom output path.`)
+      }
+      Gentime.changeSettings({
+        output: {
+          directory: generator.output.value,
+        },
+      })
+    }
+
     // WARNING: Make sure this logic comes before `loadUserGentimeSettings` below
     // otherwise we will overwrite the user's choice for this setting if they have set it.
     Gentime.settings.change({

src/generator/generate.ts

@@ -10,80 +10,6 @@ import { ModuleSpec } from './types'
 const OUTPUT_SOURCE_DIR_ESM = getOutputSourceDir({ esm: true })
 const OUTPUT_SOURCE_DIR_CJS = getOutputSourceDir({ esm: false })
 
-/** Generate the Nexus Prisma runtime files and emit them into a "hole" in the internal package source tree. */
-export function generateRuntimeAndEmit(dmmf: DMMF.Document, settings: Gentime.Settings): void {
-  d('start generateRuntime with configuration %j', settings)
-
-  d('start generateRuntime')
-
-  if (process.env.NP_DEBUG) {
-    fs.write('dmmf.json', dmmf)
-  }
-
-  const declarationSourceFile = ModelsGenerator.TS.createModuleSpec(dmmf, settings)
-
-  // ESM
-
-  const esmSourceFiles: ModuleSpec[] = [
-    ModelsGenerator.JS.createModuleSpec({
-      gentimeSettings: settings,
-      esm: true,
-      dmmf,
-    }),
-    declarationSourceFile,
-  ]
-
-  fs.remove(OUTPUT_SOURCE_DIR_ESM)
-
-  esmSourceFiles.forEach((sf) => {
-    const filePath = Path.join(OUTPUT_SOURCE_DIR_ESM, sf.fileName)
-    fs.remove(filePath)
-    fs.write(filePath, sf.content)
-    d(`did write ${filePath}`)
-  })
-
-  // CJS
-
-  fs.remove(OUTPUT_SOURCE_DIR_CJS)
-
-  const cjsSourceFiles: ModuleSpec[] = [
-    ModelsGenerator.JS.createModuleSpec({
-      gentimeSettings: settings,
-      esm: false,
-      dmmf,
-    }),
-    declarationSourceFile,
-  ]
-
-  cjsSourceFiles.forEach((sf) => {
-    const filePath = Path.join(OUTPUT_SOURCE_DIR_CJS, sf.fileName)
-    fs.remove(filePath)
-    fs.write(filePath, sf.content)
-    d(`did write ${filePath}`)
-  })
-
-  d(`done writing all emitted files`)
-}
-
-/** Transform the given DMMF into JS source code with accompanying TS declarations. */
-export function generateRuntime(dmmf: DMMF.Document, settings: Gentime.Settings): ModuleSpec[] {
-  const sourceFiles: ModuleSpec[] = [
-    ModelsGenerator.JS.createModuleSpec({
-      gentimeSettings: settings,
-      esm: true,
-      dmmf,
-    }),
-    ModelsGenerator.JS.createModuleSpec({
-      gentimeSettings: settings,
-      esm: false,
-      dmmf,
-    }),
-    ModelsGenerator.TS.createModuleSpec(dmmf, settings),
-  ]
-
-  return sourceFiles
-}
-
 /**
  * Find the output source directory. When using the Yalc workflow some additional hacking around is required.
  *
@@ -119,3 +45,99 @@ function getOutputSourceDir(params: { esm: boolean }): string {
 
   return outputSourceDir
 }
+
+/** Generate the Nexus Prisma runtime files and emit them into a "hole" in the internal package source tree. */
+export function generateRuntimeAndEmit(dmmf: DMMF.Document, settings: Gentime.Settings): void {
+  d('start generateRuntime with configuration %j', settings)
+
+  d('start generateRuntime')
+
+  if (process.env.NP_DEBUG) {
+    fs.write('dmmf.json', dmmf)
+  }
+
+  const declarationSourceFile = ModelsGenerator.TS.createModuleSpec(dmmf, settings)
+
+  if (settings.data.output) {
+    const outputDir = settings.data.output.directory
+
+    const sourceFiles = [
+      ModelsGenerator.JS.createModuleSpec({
+        gentimeSettings: settings,
+        esm: settings.data.output?.moduleSystem === 'esm',
+        dmmf,
+      }),
+      declarationSourceFile,
+    ]
+
+    fs.remove(outputDir)
+
+    sourceFiles.forEach((sf) => {
+      const filePath = Path.join(outputDir, sf.fileName)
+      fs.remove(filePath)
+      fs.write(filePath, sf.content)
+      d(`did write ${filePath}`)
+    })
+  } else {
+    // ESM
+
+    const esmSourceFiles = [
+      ModelsGenerator.JS.createModuleSpec({
+        gentimeSettings: settings,
+        esm: true,
+        dmmf,
+      }),
+      declarationSourceFile,
+    ]
+
+    fs.remove(OUTPUT_SOURCE_DIR_ESM)
+
+    esmSourceFiles.forEach((sf) => {
+      const filePath = Path.join(OUTPUT_SOURCE_DIR_ESM, sf.fileName)
+      fs.remove(filePath)
+      fs.write(filePath, sf.content)
+      d(`did write ${filePath}`)
+    })
+
+    // CJS
+
+    const cjsSourceFiles = [
+      ModelsGenerator.JS.createModuleSpec({
+        gentimeSettings: settings,
+        esm: false,
+        dmmf,
+      }),
+      declarationSourceFile,
+    ]
+
+    fs.remove(OUTPUT_SOURCE_DIR_CJS)
+
+    cjsSourceFiles.forEach((sf) => {
+      const filePath = Path.join(OUTPUT_SOURCE_DIR_CJS, sf.fileName)
+      fs.remove(filePath)
+      fs.write(filePath, sf.content)
+      d(`did write ${filePath}`)
+    })
+  }
+
+  d(`done writing all emitted files`)
+}
+
+/** Transform the given DMMF into JS source code with accompanying TS declarations. */
+export function generateRuntime(dmmf: DMMF.Document, settings: Gentime.Settings): ModuleSpec[] {
+  const sourceFiles: ModuleSpec[] = [
+    ModelsGenerator.JS.createModuleSpec({
+      gentimeSettings: settings,
+      esm: true,
+      dmmf,
+    }),
+    ModelsGenerator.JS.createModuleSpec({
+      gentimeSettings: settings,
+      esm: false,
+      dmmf,
+    }),
+    ModelsGenerator.TS.createModuleSpec(dmmf, settings),
+  ]
+
+  return sourceFiles
+}

src/generator/gentime/settingsSingleton.ts

@@ -82,14 +82,60 @@ export namespace Gentime {
      * @default '@prisma/client'
      */
     prismaClientImportId?: string
+    /**
+     * Where to output the Nexus Prisma runtime and if it should use ESM or CJS module system.
+     *
+     * By default Nexus Prisma runtime is output into its installed node_modules location and supports both ESM and CJS.
+     *
+     * When you explicitly configure this setting Nexus Prisma only supports outputting ESM OR CJS, not both.
+     *
+     * Passing `string` is shorthand for `{ directory: string }`
+     */
+    output?:
+      | string
+      | {
+          /**
+           * The directory to output the Nexus Prisma runtime into.
+           *
+           * If a relative path is given then it is considered relative to the Prisma Schema file.
+           *
+           * By default Nexus Prisma runtime is output into its installed node_modules location.
+           */
+          directory: string
+          /**
+           * The module system to use for the output modules.
+           *
+           * @default 'cjs'
+           */
+          moduleSystem?: 'esm' | 'cjs'
+        }
   }
 
-  export type SettingsData = Setset.InferDataFromInput<SettingsInput>
+  export type SettingsData = Omit<Setset.InferDataFromInput<SettingsInput>, 'output'> & {
+    output?: {
+      directory: string
+      moduleSystem: 'esm' | 'cjs'
+    }
+  }
 
   export type Settings = Setset.Manager<SettingsInput, SettingsData>
 
   export const settings = Setset.create<SettingsInput, SettingsData>({
     fields: {
+      output: {
+        shorthand: (directory) => ({ directory }),
+        fields: {
+          directory: {
+            fixup: (directory) => ({
+              // TODO if relative, make absolute, from PSL file
+              value: directory,
+            }),
+          },
+          moduleSystem: {
+            initial: () => 'cjs',
+          },
+        },
+      },
       projectIdIntToGraphQL: {
         initial: () => 'Int',
       },

src/generator/helpers/JSDocTemplates.ts

@@ -1,6 +1,6 @@
 import { DMMF } from '@prisma/client/runtime'
 import dedent from 'dindist'
-import { PrismaDocumentation } from '../../lib/prisma-documnetation'
+import { PrismaDocumentation } from '../../lib/prisma-documentation'
 import { Gentime } from '../gentime/settingsSingleton'
 
 type JSDoc = string

src/generator/models/declaration.ts

@@ -10,7 +10,7 @@ import { Gentime } from '../gentime/settingsSingleton'
 import { jsDocForEnum, jsDocForField, jsDocForModel } from '../helpers/JSDocTemplates'
 import { ModuleSpec } from '../types'
 
-export function createModuleSpec(dmmf: DMMF.Document, settings: Gentime.Settings): ModuleSpec {
+export const createModuleSpec = (dmmf: DMMF.Document, settings: Gentime.Settings): ModuleSpec => {
   return {
     fileName: 'index.d.ts',
     content: dedent`