improve: expose projectRoot setting in createTestContext (#1324)

* improve: expose projectRoot setting in createTestContext

* chore(docs): update CreateTestContextOptions

* chore(jsdoc): document projectRoot param for createTestContext

Author: luhagel

src/testing/testing.ts

@@ -24,7 +24,7 @@ export interface TestContextCore {
 }
 
 declare global {
-  interface NexusTestContextApp extends TestContextAppCore {}
+  interface NexusTestContextApp extends TestContextAppCore { }
 
   interface NexusTestContextRoot {
     app: NexusTestContextApp
@@ -40,6 +40,14 @@ export interface CreateTestContextOptions {
    * You should typically use this if you're using `nexus dev --entrypoint` or `nexus build --entrypoint`.
    */
   entrypointPath?: string
+  /**
+   * Nexus usually determines the project root by the first `package.json` found while traversing up the file system.
+   * In some cases, e.g. usage in a monorepo, this might not always be correct.
+   * For those cases, you can specify the `projectRoot` manually.
+   *
+   * Example: `await createTestContext({ projectRoot: path.join(__dirname, '../..') })`
+   */
+  projectRoot?: string
 }
 
 /**
@@ -68,15 +76,15 @@ export async function createTestContext(opts?: CreateTestContextOptions): Promis
   process.env.NEXUS_STAGE = 'dev'
 
   // todo figure out some caching system here, e.g. imagine jest --watch mode
-  const layout = rightOrFatal(await Layout.create({ entrypointPath: opts?.entrypointPath }))
+  const layout = rightOrFatal(await Layout.create({ entrypointPath: opts?.entrypointPath, projectRoot: opts?.projectRoot }))
   const pluginManifests = await PluginWorktime.getUsedPlugins(layout)
   const randomPort = await getPort({ port: getPort.makeRange(4000, 6000) })
   const privateApp = app as PrivateApp
 
   const forcedServerSettings = {
     port: randomPort,
     playground: false, // Disable playground during tests
-    startMessage() {}, // Make server silent
+    startMessage() { }, // Make server silent
   }
 
   // todo remove these settings hacks once we have https://github.com/graphql-nexus/nexus/issues/758

website/content/040-api/02-nexus-testing.mdx

@@ -54,6 +54,14 @@ export interface CreateTestContextOptions {
    * You should typically use this if you're using `nexus dev --entrypoint` or `nexus build --entrypoint`.
    */
   entrypointPath?: string
+  /**
+   * Nexus usually determines the project root by the first `package.json` found while traversing up the file system.
+   * In some cases, e.g. usage in a monorepo, this might not always be correct.
+   * For those cases, you can specify the `projectRoot` manually.
+   * 
+   * Example: `await createTestContext({ projectRoot: path.join(__dirname, '../..') })`
+   */
+  projectRoot?: string
 }
 ```