Skip create-root-layout for Turbopack (#61191)

## What?

Creating a root layout automatically when one can't be found won't be
supported in the first version of Turbopack.

<!-- Thanks for opening a PR! Your contribution is much appreciated.
To make sure your PR is handled as smoothly as possible we request that
you follow the checklist sections below.
Choose the right checklist for the change(s) that you're making:

## For Contributors

### Improving Documentation

- Run `pnpm prettier-fix` to fix formatting issues before opening the
PR.
- Read the Docs Contribution Guide to ensure your contribution follows
the docs guidelines:
https://nextjs.org/docs/community/contribution-guide

### Adding or Updating Examples

- The "examples guidelines" are followed from our contributing doc
https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md
- Make sure the linting passes by running `pnpm build && pnpm lint`. See
https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md

### Fixing a bug

- Related issues linked using `fixes #number`
- Tests added. See:
https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md

### Adding a feature

- Implements an existing feature request or RFC. Make sure the feature
request has been accepted for implementation before opening a PR. (A
discussion must be opened, see
https://github.com/vercel/next.js/discussions/new?category=ideas)
- Related issues/discussions are linked using `fixes #number`
- e2e tests added
(https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs)
- Documentation added
- Telemetry added. In case of a feature if it's used or not.
- Errors have a helpful link attached, see
https://github.com/vercel/next.js/blob/canary/contributing.md


## For Maintainers

- Minimal description (aim for explaining to someone not on the team to
understand the PR)
- When linking to a Slack thread, you might want to share details of the
conclusion
- Link both the Linear (Fixes NEXT-xxx) and the GitHub issues
- Add review comments if necessary to explain to the reviewer the logic
behind a change

### What?

### Why?

### How?

Closes NEXT-
Fixes #

-->


Closes NEXT-2249

test/e2e/app-dir/create-root-layout/create-root-layout.test.ts

@@ -3,49 +3,102 @@ import { createNext, FileRef } from 'e2e-utils'
 import { NextInstance } from 'test/lib/next-modes/base'
 import { check } from 'next-test-utils'
 import stripAnsi from 'strip-ansi'
+;(process.env.TURBOPACK ? describe.skip : describe)(
+  'app-dir create root layout',
+  () => {
+    const isDev = (global as any).isNextDev
+
+    if ((global as any).isNextDeploy) {
+      it('should skip next deploy for now', () => {})
+      return
+    }
+
+    let next: NextInstance
+
+    if (isDev) {
+      describe('page.js', () => {
+        describe('root layout in app', () => {
+          beforeAll(async () => {
+            next = await createNext({
+              files: {
+                app: new FileRef(path.join(__dirname, 'app')),
+                'next.config.js': new FileRef(
+                  path.join(__dirname, 'next.config.js')
+                ),
+              },
+            })
+          })
+          afterAll(() => next.destroy())
 
-describe('app-dir create root layout', () => {
-  const isDev = (global as any).isNextDev
+          it('create root layout', async () => {
+            const outputIndex = next.cliOutput.length
+            const browser = await next.browser('/route')
 
-  if ((global as any).isNextDeploy) {
-    it('should skip next deploy for now', () => {})
-    return
-  }
+            expect(await browser.elementById('page-text').text()).toBe(
+              'Hello world!'
+            )
 
-  let next: NextInstance
+            await check(
+              () => stripAnsi(next.cliOutput.slice(outputIndex)),
+              /did not have a root layout/
+            )
+            expect(stripAnsi(next.cliOutput.slice(outputIndex))).toMatch(
+              'Your page app/route/page.js did not have a root layout. We created app/layout.js for you.'
+            )
 
-  if (isDev) {
-    describe('page.js', () => {
-      describe('root layout in app', () => {
-        beforeAll(async () => {
-          next = await createNext({
-            files: {
-              app: new FileRef(path.join(__dirname, 'app')),
-              'next.config.js': new FileRef(
-                path.join(__dirname, 'next.config.js')
-              ),
-            },
+            expect(await next.readFile('app/layout.js')).toMatchInlineSnapshot(`
+            "export const metadata = {
+              title: 'Next.js',
+              description: 'Generated by Next.js',
+            }
+
+            export default function RootLayout({ children }) {
+             return (
+                <html lang="en">
+                  <body>{children}</body>
+                </html>
+              )
+            }
+            "
+          `)
           })
         })
-        afterAll(() => next.destroy())
 
-        it('create root layout', async () => {
-          const outputIndex = next.cliOutput.length
-          const browser = await next.browser('/route')
+        describe('root layout in route group', () => {
+          beforeAll(async () => {
+            next = await createNext({
+              files: {
+                app: new FileRef(path.join(__dirname, 'app-group-layout')),
+                'next.config.js': new FileRef(
+                  path.join(__dirname, 'next.config.js')
+                ),
+              },
+              dependencies: {
+                react: 'latest',
+                'react-dom': 'latest',
+              },
+            })
+          })
+          afterAll(() => next.destroy())
 
-          expect(await browser.elementById('page-text').text()).toBe(
-            'Hello world!'
-          )
+          it('create root layout', async () => {
+            const outputIndex = next.cliOutput.length
+            const browser = await next.browser('/')
 
-          await check(
-            () => stripAnsi(next.cliOutput.slice(outputIndex)),
-            /did not have a root layout/
-          )
-          expect(stripAnsi(next.cliOutput.slice(outputIndex))).toMatch(
-            'Your page app/route/page.js did not have a root layout. We created app/layout.js for you.'
-          )
+            expect(await browser.elementById('page-text').text()).toBe(
+              'Hello world'
+            )
 
-          expect(await next.readFile('app/layout.js')).toMatchInlineSnapshot(`
+            await check(
+              () => stripAnsi(next.cliOutput.slice(outputIndex)),
+              /did not have a root layout/
+            )
+            expect(stripAnsi(next.cliOutput.slice(outputIndex))).toInclude(
+              'Your page app/(group)/page.js did not have a root layout. We created app/(group)/layout.js for you.'
+            )
+
+            expect(await next.readFile('app/(group)/layout.js'))
+              .toMatchInlineSnapshot(`
             "export const metadata = {
               title: 'Next.js',
               description: 'Generated by Next.js',
@@ -60,44 +113,46 @@ describe('app-dir create root layout', () => {
             }
             "
           `)
+          })
         })
-      })
 
-      describe('root layout in route group', () => {
-        beforeAll(async () => {
-          next = await createNext({
-            files: {
-              app: new FileRef(path.join(__dirname, 'app-group-layout')),
-              'next.config.js': new FileRef(
-                path.join(__dirname, 'next.config.js')
-              ),
-            },
-            dependencies: {
-              react: 'latest',
-              'react-dom': 'latest',
-            },
+        describe('find available dir', () => {
+          beforeAll(async () => {
+            next = await createNext({
+              files: {
+                app: new FileRef(
+                  path.join(__dirname, 'app-find-available-dir')
+                ),
+                'next.config.js': new FileRef(
+                  path.join(__dirname, 'next.config.js')
+                ),
+              },
+              dependencies: {
+                react: 'latest',
+                'react-dom': 'latest',
+              },
+            })
           })
-        })
-        afterAll(() => next.destroy())
+          afterAll(() => next.destroy())
 
-        it('create root layout', async () => {
-          const outputIndex = next.cliOutput.length
-          const browser = await next.browser('/')
+          it('create root layout', async () => {
+            const outputIndex = next.cliOutput.length
+            const browser = await next.browser('/route/second/inner')
 
-          expect(await browser.elementById('page-text').text()).toBe(
-            'Hello world'
-          )
+            expect(await browser.elementById('page-text').text()).toBe(
+              'Hello world'
+            )
 
-          await check(
-            () => stripAnsi(next.cliOutput.slice(outputIndex)),
-            /did not have a root layout/
-          )
-          expect(stripAnsi(next.cliOutput.slice(outputIndex))).toInclude(
-            'Your page app/(group)/page.js did not have a root layout. We created app/(group)/layout.js for you.'
-          )
+            await check(
+              () => stripAnsi(next.cliOutput.slice(outputIndex)),
+              /did not have a root layout/
+            )
+            expect(stripAnsi(next.cliOutput.slice(outputIndex))).toInclude(
+              'Your page app/(group)/route/second/inner/page.js did not have a root layout. We created app/(group)/route/second/layout.js for you.'
+            )
 
-          expect(await next.readFile('app/(group)/layout.js'))
-            .toMatchInlineSnapshot(`
+            expect(await next.readFile('app/(group)/route/second/layout.js'))
+              .toMatchInlineSnapshot(`
             "export const metadata = {
               title: 'Next.js',
               description: 'Generated by Next.js',
@@ -112,94 +167,42 @@ describe('app-dir create root layout', () => {
             }
             "
           `)
+          })
         })
       })
 
-      describe('find available dir', () => {
+      describe('page.tsx', () => {
         beforeAll(async () => {
           next = await createNext({
             files: {
-              app: new FileRef(path.join(__dirname, 'app-find-available-dir')),
+              'app/page.tsx': new FileRef(
+                path.join(__dirname, 'app/route/page.js')
+              ),
               'next.config.js': new FileRef(
                 path.join(__dirname, 'next.config.js')
               ),
             },
-            dependencies: {
-              react: 'latest',
-              'react-dom': 'latest',
-            },
           })
         })
         afterAll(() => next.destroy())
 
         it('create root layout', async () => {
           const outputIndex = next.cliOutput.length
-          const browser = await next.browser('/route/second/inner')
+          const browser = await next.browser('/')
 
           expect(await browser.elementById('page-text').text()).toBe(
-            'Hello world'
+            'Hello world!'
           )
 
           await check(
             () => stripAnsi(next.cliOutput.slice(outputIndex)),
             /did not have a root layout/
           )
           expect(stripAnsi(next.cliOutput.slice(outputIndex))).toInclude(
-            'Your page app/(group)/route/second/inner/page.js did not have a root layout. We created app/(group)/route/second/layout.js for you.'
+            'Your page app/page.tsx did not have a root layout. We created app/layout.tsx for you.'
           )
 
-          expect(await next.readFile('app/(group)/route/second/layout.js'))
-            .toMatchInlineSnapshot(`
-            "export const metadata = {
-              title: 'Next.js',
-              description: 'Generated by Next.js',
-            }
-
-            export default function RootLayout({ children }) {
-             return (
-                <html lang="en">
-                  <body>{children}</body>
-                </html>
-              )
-            }
-            "
-          `)
-        })
-      })
-    })
-
-    describe('page.tsx', () => {
-      beforeAll(async () => {
-        next = await createNext({
-          files: {
-            'app/page.tsx': new FileRef(
-              path.join(__dirname, 'app/route/page.js')
-            ),
-            'next.config.js': new FileRef(
-              path.join(__dirname, 'next.config.js')
-            ),
-          },
-        })
-      })
-      afterAll(() => next.destroy())
-
-      it('create root layout', async () => {
-        const outputIndex = next.cliOutput.length
-        const browser = await next.browser('/')
-
-        expect(await browser.elementById('page-text').text()).toBe(
-          'Hello world!'
-        )
-
-        await check(
-          () => stripAnsi(next.cliOutput.slice(outputIndex)),
-          /did not have a root layout/
-        )
-        expect(stripAnsi(next.cliOutput.slice(outputIndex))).toInclude(
-          'Your page app/page.tsx did not have a root layout. We created app/layout.tsx for you.'
-        )
-
-        expect(await next.readFile('app/layout.tsx')).toMatchInlineSnapshot(`
+          expect(await next.readFile('app/layout.tsx')).toMatchInlineSnapshot(`
           "export const metadata = {
             title: 'Next.js',
             description: 'Generated by Next.js',
@@ -218,33 +221,34 @@ describe('app-dir create root layout', () => {
           }
           "
         `)
-      })
-    })
-  } else {
-    describe('build', () => {
-      it('should break the build if a page is missing root layout', async () => {
-        const next = await createNext({
-          skipStart: true,
-          files: {
-            'app/page.js': new FileRef(
-              path.join(__dirname, 'app/route/page.js')
-            ),
-            'next.config.js': new FileRef(
-              path.join(__dirname, 'next.config.js')
-            ),
-          },
-          dependencies: {
-            react: 'latest',
-            'react-dom': 'latest',
-          },
         })
+      })
+    } else {
+      describe('build', () => {
+        it('should break the build if a page is missing root layout', async () => {
+          const next = await createNext({
+            skipStart: true,
+            files: {
+              'app/page.js': new FileRef(
+                path.join(__dirname, 'app/route/page.js')
+              ),
+              'next.config.js': new FileRef(
+                path.join(__dirname, 'next.config.js')
+              ),
+            },
+            dependencies: {
+              react: 'latest',
+              'react-dom': 'latest',
+            },
+          })
 
-        await expect(next.start()).rejects.toThrow('next build failed')
-        expect(stripAnsi(next.cliOutput)).toInclude(
-          "page.js doesn't have a root layout. To fix this error, make sure every page has a root layout."
-        )
-        await next.destroy()
+          await expect(next.start()).rejects.toThrow('next build failed')
+          expect(stripAnsi(next.cliOutput)).toInclude(
+            "page.js doesn't have a root layout. To fix this error, make sure every page has a root layout."
+          )
+          await next.destroy()
+        })
       })
-    })
+    }
   }
-})
+)