feat(nextjs): Add standalone Nextjs option to react selection when ru…

…nning CNW
nrwl · Apr 18, 2023 · b1fb447 · b1fb447
1 parent 5769256
commit b1fb447
Show file tree

Hide file tree

Showing 32 changed files with 279 additions and 29 deletions.
diff --git a/docs/generated/cli/create-nx-workspace.md b/docs/generated/cli/create-nx-workspace.md
@@ -25,6 +25,12 @@ Default: `false`
 
 Show all prompts
 
+### appDir
+
+Type: `boolean`
+
+Add Experimental app/ layout for next.js
+
 ### appName
 
 Type: `string`
@@ -129,7 +135,7 @@ Package manager to use
 
 Type: `string`
 
-Customizes the initial content of your workspace. Default presets include: ["apps", "empty", "core", "npm", "ts", "web-components", "angular-monorepo", "angular-standalone", "react-monorepo", "react-standalone", "react-native", "expo", "next", "nest", "express", "react", "angular", "node-standalone"]. To build your own see https://nx.dev/packages/nx-plugin#preset
+Customizes the initial content of your workspace. Default presets include: ["apps", "empty", "core", "npm", "ts", "web-components", "angular-monorepo", "angular-standalone", "react-monorepo", "react-standalone", "nextjs-standalone", "react-native", "expo", "next", "nest", "express", "react", "angular", "node-standalone"]. To build your own see https://nx.dev/packages/nx-plugin#preset
 
 ### routing
 

diff --git a/docs/generated/packages/next/generators/application.json b/docs/generated/packages/next/generators/application.json
@@ -121,6 +121,13 @@
         "default": false,
         "description": "Enable experimental app directory for the project",
         "x-prompt": "Do you want to use experimental app/ in this project?"
+      },
+      "rootProject": {
+        "description": "Create an application at the root of the workspace.",
+        "type": "boolean",
+        "default": false,
+        "hidden": true,
+        "x-priority": "internal"
       }
     },
     "required": [],

diff --git a/docs/generated/packages/next/generators/init.json b/docs/generated/packages/next/generators/init.json
@@ -36,6 +36,13 @@
         "default": false,
         "description": "Do not add dependencies to `package.json`.",
         "x-priority": "internal"
+      },
+      "rootProject": {
+        "description": "Create an application at the root of the workspace.",
+        "type": "boolean",
+        "default": false,
+        "hidden": true,
+        "x-priority": "internal"
       }
     },
     "required": [],

diff --git a/docs/generated/packages/nx/documents/create-nx-workspace.md b/docs/generated/packages/nx/documents/create-nx-workspace.md
@@ -25,6 +25,12 @@ Default: `false`
 
 Show all prompts
 
+### appDir
+
+Type: `boolean`
+
+Add Experimental app/ layout for next.js
+
 ### appName
 
 Type: `string`
@@ -129,7 +135,7 @@ Package manager to use
 
 Type: `string`
 
-Customizes the initial content of your workspace. Default presets include: ["apps", "empty", "core", "npm", "ts", "web-components", "angular-monorepo", "angular-standalone", "react-monorepo", "react-standalone", "react-native", "expo", "next", "nest", "express", "react", "angular", "node-standalone"]. To build your own see https://nx.dev/packages/nx-plugin#preset
+Customizes the initial content of your workspace. Default presets include: ["apps", "empty", "core", "npm", "ts", "web-components", "angular-monorepo", "angular-standalone", "react-monorepo", "react-standalone", "nextjs-standalone", "react-native", "expo", "next", "nest", "express", "react", "angular", "node-standalone"]. To build your own see https://nx.dev/packages/nx-plugin#preset
 
 ### routing
 

diff --git a/docs/generated/packages/workspace/generators/new.json b/docs/generated/packages/workspace/generators/new.json
@@ -68,6 +68,11 @@
         "description": "The framework which the application is using",
         "type": "string",
         "enum": ["express", "koa", "fastify", "nest", "none"]
+      },
+      "appDir": {
+        "description": "Enable experimental app directory for the project",
+        "type": "boolean",
+        "default": false
       }
     },
     "additionalProperties": true,

diff --git a/docs/generated/packages/workspace/generators/preset.json b/docs/generated/packages/workspace/generators/preset.json
@@ -80,6 +80,11 @@
         "description": "Generate a Dockerfile",
         "type": "boolean",
         "default": false
+      },
+      "appDir": {
+        "description": "Enable experimental app directory for the project",
+        "type": "boolean",
+        "default": false
       }
     },
     "presets": []

diff --git a/e2e/next/src/next.test.ts b/e2e/next/src/next.test.ts
@@ -21,7 +21,6 @@ import {
 } from '@nrwl/e2e/utils';
 import * as http from 'http';
 import { checkApp } from './utils';
-import { removeSync } from 'fs-extra';
 
 describe('Next.js Applications', () => {
   let proj: string;
@@ -426,6 +425,27 @@ describe('Next.js Applications', () => {
       checkExport: false,
     });
   }, 300_000);
+
+  it('should create a generate a next.js app with app layout enabled', async () => {
+    const appName = uniq('app');
+
+    runCLI(
+      `generate @nrwl/next:app ${appName} --style=css --appDir --no-interactive`
+    );
+
+    checkFilesExist(`apps/${appName}/app/api/hello/route.ts`);
+    checkFilesExist(`apps/${appName}/app/page.tsx`);
+    checkFilesExist(`apps/${appName}/app/layout.tsx`);
+    checkFilesExist(`apps/${appName}/app/global.css`);
+    checkFilesExist(`apps/${appName}/app/page.module.css`);
+
+    await checkApp(appName, {
+      checkUnitTest: false,
+      checkLint: false,
+      checkE2E: false,
+      checkExport: false,
+    });
+  }, 300_000);
 });
 
 function getData(port, path = ''): Promise<any> {

diff --git a/packages/create-nx-workspace/bin/create-nx-workspace.ts b/packages/create-nx-workspace/bin/create-nx-workspace.ts
@@ -39,6 +39,7 @@ interface Arguments extends CreateWorkspaceOptions {
   framework: Framework;
   standaloneApi: boolean;
   docker: boolean;
+  appDir: boolean;
   routing: boolean;
   bundler: Bundler;
 }
@@ -104,6 +105,10 @@ export const commandsObject: yargs.Argv<Arguments> = yargs
           .option('docker', {
             describe: chalk.dim`Generate a Dockerfile with your node-server`,
             type: 'boolean',
+          })
+          .option('appDir', {
+            describe: chalk.dim`Add Experimental app/ layout for next.js`,
+            type: 'boolean',
           }),
         withNxCloud,
         withCI,
@@ -180,6 +185,7 @@ async function normalizeArgsMiddleware(
       framework,
       bundler,
       docker,
+      appDir,
       routing,
       standaloneApi;
 
@@ -209,7 +215,7 @@ async function normalizeArgsMiddleware(
         if (monorepoStyle === 'package-based') {
           preset = 'npm';
         } else if (monorepoStyle === 'react') {
-          preset = Preset.ReactStandalone;
+          preset = await determineReactFramework(argv);
         } else if (monorepoStyle === 'angular') {
           preset = Preset.AngularStandalone;
         } else if (monorepoStyle === 'node-standalone') {
@@ -228,7 +234,8 @@ async function normalizeArgsMiddleware(
       if (
         preset === Preset.ReactStandalone ||
         preset === Preset.AngularStandalone ||
-        preset === Preset.NodeStandalone
+        preset === Preset.NodeStandalone ||
+        preset === Preset.NextJsStandalone
       ) {
         appName =
           argv.appName ?? argv.name ?? (await determineAppName(preset, argv));
@@ -241,6 +248,10 @@ async function normalizeArgsMiddleware(
           }
         }
 
+        if (preset === Preset.NextJsStandalone) {
+          appDir = await isAppDir(argv);
+        }
+
         if (preset === Preset.ReactStandalone) {
           bundler = await determineBundler(argv);
         }
@@ -291,6 +302,7 @@ async function normalizeArgsMiddleware(
       ci,
       bundler,
       docker,
+      appDir,
     });
   } catch (e) {
     console.error(e);
@@ -363,27 +375,27 @@ async function determineMonorepoStyle(): Promise<string> {
         {
           name: 'package-based',
           message:
-            'Package-based monorepo: Nx makes it fast, but lets you run things your way.',
+            'Package-based monorepo:      Nx makes it fast, but lets you run things your way.',
         },
         {
           name: 'integrated',
           message:
-            'Integrated monorepo:    Nx configures your favorite frameworks and lets you focus on shipping features.',
+            'Integrated monorepo:         Nx configures your favorite frameworks and lets you focus on shipping features.',
         },
         {
           name: 'react',
           message:
-            'Standalone React app:   Nx configures Vite (or Webpack), ESLint, and Cypress.',
+            'Standalone React app:        Nx configures a React app with an optional framework (e.g. Next.js).',
         },
         {
           name: 'angular',
           message:
-            'Standalone Angular app: Nx configures Jest, ESLint and Cypress.',
+            'Standalone Angular app:      Nx configures Jest, ESLint and Cypress.',
         },
         {
           name: 'node-standalone',
           message:
-            'Standalone Node app:    Nx configures a framework (ex. Express), esbuild, ESlint and Jest.',
+            'Standalone Node app:         Nx configures a framework (e.g. Express), esbuild, ESlint and Jest.',
         },
       ],
     },
@@ -582,6 +594,64 @@ async function determineDockerfile(
   }
 }
 
+async function determineReactFramework(parsedArgs: yargs.Arguments<Arguments>) {
+  if (parsedArgs.framework) {
+    return parsedArgs.framework === 'next.js'
+      ? Preset.NextJsStandalone
+      : Preset.ReactStandalone;
+  }
+  return enquirer
+    .prompt<{ framework: 'none' | 'next.js' }>([
+      {
+        name: 'framework',
+        message: 'What framework would you like to use?',
+        type: 'autocomplete',
+        choices: [
+          {
+            name: 'none',
+            message: 'None',
+            hint: 'I only want React',
+          },
+          {
+            name: 'next.js',
+            message: 'Next.js [https://nextjs.org/]',
+          },
+        ],
+        initial: 'none' as any,
+      },
+    ])
+    .then((choice) =>
+      choice.framework === 'next.js'
+        ? Preset.NextJsStandalone
+        : Preset.ReactStandalone
+    );
+}
+
+async function isAppDir(parsedArgs: yargs.Arguments<Arguments>) {
+  if (parsedArgs.appDir === undefined) {
+    return enquirer
+      .prompt<{ appDir: 'Yes' | 'No' }>([
+        {
+          name: 'appDir',
+          message: 'Do you want to use experimental app/ in this project?',
+          type: 'autocomplete',
+          choices: [
+            {
+              name: 'No',
+            },
+            {
+              name: 'Yes',
+            },
+          ],
+          initial: 'No' as any,
+        },
+      ])
+      .then((choice) => choice.appDir === 'Yes');
+  } else {
+    return Promise.resolve(parsedArgs.appDir);
+  }
+}
+
 async function determineStyle(
   preset: Preset,
   parsedArgs: yargs.Arguments<Arguments>
@@ -617,9 +687,12 @@ async function determineStyle(
   ];
 
   if (
-    [Preset.ReactMonorepo, Preset.ReactStandalone, Preset.NextJs].includes(
-      preset
-    )
+    [
+      Preset.ReactMonorepo,
+      Preset.ReactStandalone,
+      Preset.NextJs,
+      Preset.NextJsStandalone,
+    ].includes(preset)
   ) {
     choices.push(
       {

diff --git a/packages/create-nx-workspace/src/utils/preset/point-to-tutorial-and-course.ts b/packages/create-nx-workspace/src/utils/preset/point-to-tutorial-and-course.ts
@@ -31,6 +31,7 @@ export function pointToTutorialAndCourse(preset: Preset) {
       break;
     case Preset.ReactMonorepo:
     case Preset.NextJs:
+    case Preset.NextJsStandalone:
       output.addVerticalSeparator();
       output.note({
         title,

diff --git a/packages/create-nx-workspace/src/utils/preset/preset.ts b/packages/create-nx-workspace/src/utils/preset/preset.ts
@@ -9,6 +9,7 @@ export enum Preset {
   AngularStandalone = 'angular-standalone',
   ReactMonorepo = 'react-monorepo',
   ReactStandalone = 'react-standalone',
+  NextJsStandalone = 'nextjs-standalone',
   ReactNative = 'react-native',
   Expo = 'expo',
   NextJs = 'next',

diff --git a/packages/next/src/generators/application/files/app/page.tsx__tmpl__ b/packages/next/src/generators/application/files/app/page.tsx__tmpl__
@@ -11,7 +11,7 @@
 const StyledPage = styled.div`<%- pageStyleContent %>`;
 <% }%>
 
-export async function Index() {
+export default async function Index() {
   /*
    * Replace the elements below with your own.
    *
@@ -23,6 +23,4 @@ export async function Index() {
       <%- appContent %>
     </<%= wrapper %>>
   );
-};
-
-export default Index;
+};
diff --git a/...application/files/common/.babelrc__tmpl__ → ...s/application/files/common/__dot__babelrc b/...application/files/common/.babelrc__tmpl__ → ...s/application/files/common/__dot__babelrc
diff --git a/packages/next/src/generators/application/files/common/tsconfig.json__tmpl__ b/packages/next/src/generators/application/files/common/tsconfig.json__tmpl__
@@ -11,7 +11,8 @@
     "noEmit": true,
     "resolveJsonModule": true,
     "isolatedModules": true,
-    "incremental": true
+    "incremental": true,
+    "plugins": [{ "name": "next" }]
   },
   "include": ["**/*.ts", "**/*.tsx", "**/*.js", "**/*.jsx", "next-env.d.ts"],
   "exclude": ["node_modules", "jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"]

diff --git a/packages/next/src/generators/application/lib/add-cypress.ts b/packages/next/src/generators/application/lib/add-cypress.ts
@@ -15,7 +15,7 @@ export async function addCypress(host: Tree, options: NormalizedSchema) {
   return cypressProjectGenerator(host, {
     ...options,
     linter: Linter.EsLint,
-    name: `${options.name}-e2e`,
+    name: options.e2eProjectName,
     directory: options.directory,
     project: options.projectName,
     skipFormat: true,