@nx/next 17.3.0-beta.5 → 17.3.0-beta.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/next",
-  "version": "17.3.0-beta.5",
+  "version": "17.3.0-beta.8",
   "private": false,
   "description": "The Next.js plugin for Nx contains executors and generators for managing Next.js applications and libraries within an Nx workspace. It provides:\n\n\n- Scaffolding for creating, building, serving, linting, and testing Next.js applications.\n\n- Integration with building, serving, and exporting a Next.js application.\n\n- Integration with React libraries within the workspace. \n\nWhen using Next.js in Nx, you get the out-of-the-box support for TypeScript, Cypress, and Jest. No need to configure anything: watch mode, source maps, and typings just work.",
   "repository": {
@@ -34,7 +34,7 @@
     "next": ">=13.0.0"
   },
   "dependencies": {
-    "@nx/devkit": "17.3.0-beta.5",
+    "@nx/devkit": "17.3.0-beta.8",
     "@babel/plugin-proposal-decorators": "^7.22.7",
     "@svgr/webpack": "^8.0.1",
     "chalk": "^4.1.0",
@@ -45,12 +45,12 @@
     "url-loader": "^4.1.1",
     "tslib": "^2.3.0",
     "webpack-merge": "^5.8.0",
-    "@nx/js": "17.3.0-beta.5",
-    "@nx/eslint": "17.3.0-beta.5",
-    "@nx/react": "17.3.0-beta.5",
-    "@nx/web": "17.3.0-beta.5",
-    "@nx/workspace": "17.3.0-beta.5",
-    "@nrwl/next": "17.3.0-beta.5"
+    "@nx/js": "17.3.0-beta.8",
+    "@nx/eslint": "17.3.0-beta.8",
+    "@nx/react": "17.3.0-beta.8",
+    "@nx/web": "17.3.0-beta.8",
+    "@nx/workspace": "17.3.0-beta.8",
+    "@nrwl/next": "17.3.0-beta.8"
   },
   "publishConfig": {
     "access": "public"

package/plugins/with-nx.js

@@ -1,43 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.withNx = exports.forNextVersion = exports.getAliasForProject = exports.getNextConfig = void 0;
-const baseNXEnvironmentVariables = [
-    'NX_BASE',
-    'NX_CACHE_DIRECTORY',
-    'NX_CACHE_PROJECT_GRAPH',
-    'NX_DAEMON',
-    'NX_DEFAULT_PROJECT',
-    'NX_HEAD',
-    'NX_PERF_LOGGING',
-    'NX_PROFILE',
-    'NX_PROJECT_GRAPH_CACHE_DIRECTORY',
-    'NX_INVOKED_BY_RUNNER',
-    'NX_PROJECT_GRAPH_MAX_WORKERS',
-    'NX_RUNNER',
-    'NX_SKIP_NX_CACHE',
-    'NX_TASKS_RUNNER',
-    'NX_TASKS_RUNNER_DYNAMIC_OUTPUT',
-    'NX_VERBOSE_LOGGING',
-    'NX_DRY_RUN',
-    'NX_INTERACTIVE',
-    'NX_GENERATE_QUIET',
-    'NX_PREFER_TS_NODE',
-    'NX_TASK_TARGET_PROJECT',
-    'NX_TASK_TARGET_TARGET',
-    'NX_TASK_TARGET_CONFIGURATION',
-    'NX_CLI_SET',
-    'NX_LOAD_DOT_ENV_FILES',
-    'NX_WORKSPACE_ROOT',
-    'NX_TASK_HASH',
-    'NX_NEXT_DIR',
-    'NX_NEXT_OUTPUT_PATH',
-    'NX_E2E_RUN_E2E',
-    'NX_E2E_CI_CACHE_KEY',
-    'NX_MAPPINGS',
-    'NX_FILE_TO_RUN',
-    'NX_NEXT_PUBLIC_DIR',
-    'NX_CYPRESS_COMPONENT_TEST',
-];
 function regexEqual(x, y) {
     return (x instanceof RegExp &&
         y instanceof RegExp &&
@@ -296,9 +259,6 @@ function getNextConfig(nextConfig = {}, context = getWithNxContext()) {
     };
 }
 exports.getNextConfig = getNextConfig;
-function getNonBaseVariables(oldEnv) {
-    return Object.keys(oldEnv).filter((env) => !baseNXEnvironmentVariables.includes(env));
-}
 function getNxEnvironmentVariables() {
     return Object.keys(process.env)
         .filter((env) => /^NX_/i.test(env))
@@ -307,7 +267,6 @@ function getNxEnvironmentVariables() {
         return env;
     }, {});
 }
-let hasWarnedAboutDeprecatedEnvVariables = false;
 /**
  * TODO(v18)
  * @deprecated Use Next.js 9.4+ built-in support for environment variables. Reference https://nextjs.org/docs/pages/api-reference/next-config-js/env
@@ -322,11 +281,6 @@ function addNxEnvVariables(config) {
             .map(([name, value]) => [`process.env.${name}`, `"${value}"`])
             .filter(([name]) => !maybeDefinePlugin.definitions[name])
             .forEach(([name, value]) => (maybeDefinePlugin.definitions[name] = value));
-        const vars = getNonBaseVariables(env);
-        if (vars.length > 0 && !hasWarnedAboutDeprecatedEnvVariables) {
-            hasWarnedAboutDeprecatedEnvVariables = true;
-            console.warn(`Warning, in Nx 18 environment variables starting with NX_ will not be available in the browser, and currently will not work with @nx/next:server executor.\nPlease rename the following environment variables: ${vars.join(', ')} using Next.js' built-in support for environment variables. Reference https://nextjs.org/docs/pages/api-reference/next-config-js/env`);
-        }
     }
 }
 function getAliasForProject(node, paths) {

package/src/executors/server/custom-server.impl.js

@@ -17,7 +17,7 @@ async function* serveExecutor(options, context) {
 }
 exports.default = serveExecutor;
 async function* runCustomServer(root, options, context) {
-    process.env.NX_NEXT_DIR = root;
+    process.env.NX_NEXT_DIR ??= root;
     process.env.NX_NEXT_PUBLIC_DIR = (0, path_1.join)(root, 'public');
     const baseUrl = `http://${options.hostname || 'localhost'}:${options.port}`;
     const customServerBuild = await (0, devkit_1.runExecutor)((0, devkit_1.parseTargetString)(options.customServerTarget, context), {

package/src/executors/server/server.impl.js

@@ -8,14 +8,15 @@ const create_cli_options_1 = require("../../utils/create-cli-options");
 const async_iterable_1 = require("@nx/devkit/src/utils/async-iterable");
 const wait_for_port_open_1 = require("@nx/web/src/utils/wait-for-port-open");
 async function* serveExecutor(options, context) {
+    const buildOptions = (0, devkit_1.readTargetOptions)((0, devkit_1.parseTargetString)(options.buildTarget, context), context);
+    const projectRoot = context.workspace.projects[context.projectName].root;
+    // This is required for the default custom server to work. See the @nx/next:app generator.
+    const nextDir = (0, path_1.resolve)(context.root, buildOptions.outputPath);
+    process.env.NX_NEXT_DIR ??= options.dev ? projectRoot : nextDir;
     if (options.customServerTarget) {
         return yield* (0, custom_server_impl_1.default)(options, context);
     }
-    const buildOptions = (0, devkit_1.readTargetOptions)((0, devkit_1.parseTargetString)(options.buildTarget, context), context);
-    const projectRoot = context.workspace.projects[context.projectName].root;
     const { keepAliveTimeout, hostname } = options;
-    // This is required for the default custom server to work. See the @nx/next:app generator.
-    process.env.NX_NEXT_DIR = projectRoot;
     // Cast to any to overwrite NODE_ENV
     process.env.NODE_ENV = process.env.NODE_ENV
         ? process.env.NODE_ENV
@@ -29,7 +30,6 @@ async function* serveExecutor(options, context) {
     if (keepAliveTimeout && !options.dev) {
         args.push(`--keepAliveTimeout=${keepAliveTimeout}`);
     }
-    const nextDir = (0, path_1.resolve)(context.root, buildOptions.outputPath);
     const mode = options.dev ? 'dev' : 'start';
     const turbo = options.turbo && options.dev ? '--turbo' : '';
     const experimentalHttps = options.experimentalHttps && options.dev ? '--experimental-https' : '';

package/src/generators/application/files/common/specs/__fileName__.spec.tsx__tmpl__

@@ -1,8 +1,10 @@
 import React from 'react';
 import { render } from '@testing-library/react';
-
+<% if (src) { %>
+import Index from '../src/pages/index';
+<% } else { %>
 import Index from '../pages/index';
-
+<% } %>
 describe('Index', () => {
   it('should render successfully', () => {
     const { baseElement } = render(<Index />);

package/src/generators/application/files/pages/__fileName__.tsx__tmpl__

@@ -25,6 +25,6 @@ export function Index() {
       <%- appContent %>
     </<%= wrapper %>>
   );
-};
+}
 
 export default Index;

package/src/generators/application/lib/add-project.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.addProject = void 0;
 const devkit_1 = require("@nx/devkit");
+const add_build_target_defaults_1 = require("@nx/devkit/src/generators/add-build-target-defaults");
 function addProject(host, options) {
     const targets = {};
     // Check if plugin exists in nx.json and if it doesn't then we can continue
@@ -11,6 +12,7 @@ function addProject(host, options) {
         ? p === '@nx/next/plugin'
         : p.plugin === '@nx/next/plugin');
     if (!hasPlugin) {
+        (0, add_build_target_defaults_1.addBuildTargetDefaults)(host, '@nx/next:build');
         targets.build = {
             executor: '@nx/next:build',
             outputs: ['{options.outputPath}'],

package/src/generators/application/lib/create-application-files.js

@@ -23,23 +23,26 @@ function createApplicationFiles(host, options) {
         pageStyleContent: `.page {}`,
         stylesExt: options.style === 'less' ? options.style : 'css',
     };
+    const generatedAppFilePath = options.src
+        ? (0, path_1.join)(options.appProjectRoot, 'src')
+        : options.appProjectRoot;
     (0, devkit_1.generateFiles)(host, (0, path_1.join)(__dirname, '../files/common'), options.appProjectRoot, templateVariables);
     if (options.appDir) {
-        (0, devkit_1.generateFiles)(host, (0, path_1.join)(__dirname, '../files/app'), (0, path_1.join)(options.appProjectRoot, 'app'), templateVariables);
+        (0, devkit_1.generateFiles)(host, (0, path_1.join)(__dirname, '../files/app'), (0, path_1.join)(generatedAppFilePath, 'app'), templateVariables);
         // RSC is not possible to unit test without extra helpers for data fetching. Leaving it to the user to figure out.
         host.delete((0, devkit_1.joinPathFragments)(options.appProjectRoot, 'specs', `index.spec.${options.js ? 'jsx' : 'tsx'}`));
         if (options.style === 'styled-components') {
-            (0, devkit_1.generateFiles)(host, (0, path_1.join)(__dirname, '../files/app-styled-components'), (0, path_1.join)(options.appProjectRoot, 'app'), templateVariables);
+            (0, devkit_1.generateFiles)(host, (0, path_1.join)(__dirname, '../files/app-styled-components'), (0, path_1.join)(generatedAppFilePath, 'app'), templateVariables);
         }
         else if (options.style === 'styled-jsx') {
-            (0, devkit_1.generateFiles)(host, (0, path_1.join)(__dirname, '../files/app-styled-jsx'), (0, path_1.join)(options.appProjectRoot, 'app'), templateVariables);
+            (0, devkit_1.generateFiles)(host, (0, path_1.join)(__dirname, '../files/app-styled-jsx'), (0, path_1.join)(generatedAppFilePath, 'app'), templateVariables);
         }
         else {
-            (0, devkit_1.generateFiles)(host, (0, path_1.join)(__dirname, '../files/app-default-layout'), (0, path_1.join)(options.appProjectRoot, 'app'), templateVariables);
+            (0, devkit_1.generateFiles)(host, (0, path_1.join)(__dirname, '../files/app-default-layout'), (0, path_1.join)(generatedAppFilePath, 'app'), templateVariables);
         }
     }
     else {
-        (0, devkit_1.generateFiles)(host, (0, path_1.join)(__dirname, '../files/pages'), (0, path_1.join)(options.appProjectRoot, 'pages'), templateVariables);
+        (0, devkit_1.generateFiles)(host, (0, path_1.join)(__dirname, '../files/pages'), (0, path_1.join)(generatedAppFilePath, 'pages'), templateVariables);
     }
     if (options.rootProject) {
         (0, devkit_1.updateJson)(host, 'tsconfig.base.json', (json) => {
@@ -83,14 +86,14 @@ function createApplicationFiles(host, options) {
     }
     if (options.styledModule) {
         if (options.appDir) {
-            host.delete(`${options.appProjectRoot}/app/page.module.${options.style}`);
+            host.delete(`${generatedAppFilePath}/app/page.module.${options.style}`);
         }
         else {
-            host.delete(`${options.appProjectRoot}/pages/${options.fileName}.module.${options.style}`);
+            host.delete(`${generatedAppFilePath}/pages/${options.fileName}.module.${options.style}`);
         }
     }
     if (options.style !== 'styled-components') {
-        host.delete(`${options.appProjectRoot}/pages/_document.tsx`);
+        host.delete(`${generatedAppFilePath}/pages/_document.tsx`);
     }
     if (options.js) {
         host.delete(`${options.appProjectRoot}/index.d.ts`);

package/src/generators/application/lib/normalize-options.js

@@ -25,6 +25,7 @@ async function normalizeOptions(host, options) {
         : [];
     const fileName = 'index';
     const appDir = options.appDir ?? true;
+    const src = options.src ?? true;
     const styledModule = /^(css|scss|less)$/.test(options.style)
         ? null
         : options.style;
@@ -32,6 +33,7 @@ async function normalizeOptions(host, options) {
     return {
         ...options,
         appDir,
+        src,
         appProjectRoot,
         e2eProjectName,
         e2eProjectRoot,

package/src/generators/application/schema.d.ts

@@ -18,5 +18,6 @@ export interface Schema {
   customServer?: boolean;
   skipPackageJson?: boolean;
   appDir?: boolean;
+  src?: boolean;
   rootProject?: boolean;
 }

package/src/generators/application/schema.json

@@ -127,6 +127,12 @@
       "description": "Enable the App Router for this project.",
       "x-prompt": "Would you like to use the App Router (recommended)?"
     },
+    "src": {
+      "type": "boolean",
+      "default": true,
+      "description": "Generate a `src` directory for the project.",
+      "x-prompt": "Would you like to use `src/` directory?"
+    },
     "rootProject": {
       "description": "Create an application at the root of the workspace.",
       "type": "boolean",

package/src/generators/init/init.js

@@ -2,7 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.nextInitGenerator = void 0;
 const devkit_1 = require("@nx/devkit");
+const update_package_scripts_1 = require("@nx/devkit/src/utils/update-package-scripts");
 const versions_1 = require("@nx/react/src/utils/versions");
+const plugin_1 = require("../../plugins/plugin");
 const add_gitignore_entry_1 = require("../../utils/add-gitignore-entry");
 const versions_2 = require("../../utils/versions");
 const add_plugin_1 = require("./lib/add-plugin");
@@ -15,7 +17,7 @@ function updateDependencies(host, schema) {
         'react-dom': versions_1.reactDomVersion,
     }, {
         '@nx/next': versions_2.nxVersion,
-    }));
+    }, undefined, schema.keepExistingVersions));
     return (0, devkit_1.runTasksInSerial)(...tasks);
 }
 async function nextInitGenerator(host, schema) {
@@ -27,6 +29,9 @@ async function nextInitGenerator(host, schema) {
     if (!schema.skipPackageJson) {
         installTask = updateDependencies(host, schema);
     }
+    if (schema.updatePackageScripts) {
+        await (0, update_package_scripts_1.updatePackageScripts)(host, plugin_1.createNodes);
+    }
     return installTask;
 }
 exports.nextInitGenerator = nextInitGenerator;

package/src/generators/init/schema.d.ts

@@ -1,4 +1,6 @@
 export interface InitSchema {
   skipFormat?: boolean;
   skipPackageJson?: boolean;
+  keepExistingVersions?: boolean;
+  updatePackageScripts?: boolean;
 }

package/src/generators/init/schema.json

@@ -16,6 +16,18 @@
       "default": false,
       "description": "Do not add dependencies to `package.json`.",
       "x-priority": "internal"
+    },
+    "keepExistingVersions": {
+      "type": "boolean",
+      "x-priority": "internal",
+      "description": "Keep existing dependencies versions",
+      "default": false
+    },
+    "updatePackageScripts": {
+      "type": "boolean",
+      "x-priority": "internal",
+      "description": "Update `package.json` scripts with inferred targets",
+      "default": false
     }
   },
   "required": []