@nx/next 0.0.0-pr-22179-271588f

package/src/generators/library/schema.json

@@ -0,0 +1,156 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "cli": "nx",
+  "$id": "NxReactLibrary",
+  "title": "Create a React Library for Nx",
+  "description": "Create a React Library for an Nx workspace.",
+  "type": "object",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "Library name",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      },
+      "x-prompt": "What name would you like to use for the library?",
+      "pattern": "(?:^@[a-zA-Z0-9-*~][a-zA-Z0-9-*._~]*\\/[a-zA-Z0-9-~][a-zA-Z0-9-._~]*|^[a-zA-Z][^:]*)$",
+      "x-priority": "important"
+    },
+    "directory": {
+      "type": "string",
+      "description": "A directory where the lib is placed.",
+      "alias": "dir",
+      "x-priority": "important"
+    },
+    "projectNameAndRootFormat": {
+      "description": "Whether to generate the project name and root directory as provided (`as-provided`) or generate them composing their values and taking the configured layout into account (`derived`).",
+      "type": "string",
+      "enum": ["as-provided", "derived"]
+    },
+    "style": {
+      "description": "The file extension to be used for style files.",
+      "type": "string",
+      "default": "css",
+      "alias": "s",
+      "x-prompt": {
+        "message": "Which stylesheet format would you like to use?",
+        "type": "list",
+        "items": [
+          { "value": "css", "label": "CSS" },
+          {
+            "value": "scss",
+            "label": "SASS(.scss)       [ https://sass-lang.com          ]"
+          },
+          {
+            "value": "less",
+            "label": "LESS              [ https://lesscss.org            ]"
+          },
+          {
+            "value": "styled-components",
+            "label": "styled-components [ https://styled-components.com ]"
+          },
+          {
+            "value": "@emotion/styled",
+            "label": "emotion           [ https://emotion.sh            ]"
+          },
+          {
+            "value": "styled-jsx",
+            "label": "styled-jsx        [ https://www.npmjs.com/package/styled-jsx ]"
+          },
+          {
+            "value": "none",
+            "label": "None"
+          }
+        ]
+      }
+    },
+    "linter": {
+      "description": "The tool to use for running lint checks.",
+      "type": "string",
+      "enum": ["eslint"],
+      "default": "eslint"
+    },
+    "unitTestRunner": {
+      "type": "string",
+      "enum": ["jest", "vitest", "none"],
+      "description": "Test runner to use for unit tests."
+    },
+    "tags": {
+      "type": "string",
+      "description": "Add tags to the library (used for linting).",
+      "alias": "t"
+    },
+    "skipFormat": {
+      "description": "Skip formatting files.",
+      "type": "boolean",
+      "default": false
+    },
+    "skipTsConfig": {
+      "type": "boolean",
+      "default": false,
+      "description": "Do not update tsconfig.json for development experience."
+    },
+    "pascalCaseFiles": {
+      "type": "boolean",
+      "description": "Use pascal case component file name (e.g. `App.tsx`).",
+      "alias": "P",
+      "default": false
+    },
+    "routing": {
+      "type": "boolean",
+      "description": "Generate library with routes."
+    },
+    "appProject": {
+      "type": "string",
+      "description": "The application project to add the library route to.",
+      "alias": "a"
+    },
+    "publishable": {
+      "type": "boolean",
+      "description": "Create a publishable library."
+    },
+    "buildable": {
+      "type": "boolean",
+      "default": false,
+      "description": "Generate a buildable library."
+    },
+    "importPath": {
+      "type": "string",
+      "description": "The library name used to import it, like `@myorg/my-awesome-lib`."
+    },
+    "component": {
+      "type": "boolean",
+      "description": "Generate a default component.",
+      "default": true
+    },
+    "js": {
+      "type": "boolean",
+      "description": "Generate JavaScript files rather than TypeScript files.",
+      "default": false
+    },
+    "globalCss": {
+      "type": "boolean",
+      "description": "When true, the stylesheet is generated using global CSS instead of CSS modules (e.g. file is `*.css` rather than `*.module.css`).",
+      "default": false
+    },
+    "strict": {
+      "type": "boolean",
+      "description": "Whether to enable tsconfig strict mode or not.",
+      "default": true
+    },
+    "setParserOptionsProject": {
+      "type": "boolean",
+      "description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
+      "default": false
+    },
+    "skipPackageJson": {
+      "type": "boolean",
+      "default": false,
+      "description": "Do not add dependencies to `package.json`.",
+      "x-priority": "internal"
+    }
+  },
+  "required": ["name"],
+  "examplesFile": "../../../docs/library-examples.md"
+}

package/src/generators/page/page.d.ts

@@ -0,0 +1,5 @@
+import { Tree } from '@nx/devkit';
+import { Schema } from './schema';
+export declare function pageGenerator(host: Tree, schema: Schema): Promise<import("@nx/devkit").GeneratorCallback>;
+export declare function pageGeneratorInternal(host: Tree, schema: Schema): Promise<import("@nx/devkit").GeneratorCallback>;
+export default pageGenerator;

package/src/generators/page/page.js

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pageGeneratorInternal = exports.pageGenerator = void 0;
+const react_1 = require("@nx/react");
+const devkit_1 = require("@nx/devkit");
+const styles_1 = require("../../utils/styles");
+const artifact_name_and_directory_utils_1 = require("@nx/devkit/src/generators/artifact-name-and-directory-utils");
+async function pageGenerator(host, schema) {
+    return pageGeneratorInternal(host, {
+        nameAndDirectoryFormat: 'derived',
+        ...schema,
+    });
+}
+exports.pageGenerator = pageGenerator;
+/*
+ * This schematic is basically the React component one, but for Next we need
+ * extra dependencies for css, sass, less style options, and make sure
+ * it is under `pages` folder.
+ */
+async function pageGeneratorInternal(host, schema) {
+    const options = await normalizeOptions(host, schema);
+    const componentTask = await (0, react_1.componentGenerator)(host, {
+        ...options,
+        isNextPage: true,
+        nameAndDirectoryFormat: 'as-provided', // already determined the directory so use as is
+        export: false,
+        classComponent: false,
+        routing: false,
+        skipTests: !options.withTests,
+        skipFormat: true,
+    });
+    const project = (0, devkit_1.readProjectConfiguration)(host, options.projectName);
+    const styledTask = (0, styles_1.addStyleDependencies)(host, {
+        style: options.style,
+        swc: !host.exists((0, devkit_1.joinPathFragments)(project.root, '.babelrc')),
+    });
+    if (!options.skipFormat) {
+        await (0, devkit_1.formatFiles)(host);
+    }
+    return (0, devkit_1.runTasksInSerial)(componentTask, styledTask);
+}
+exports.pageGeneratorInternal = pageGeneratorInternal;
+async function normalizeOptions(host, options) {
+    let isAppRouter;
+    let derivedDirectory;
+    let routerDirectory;
+    if (options.project) {
+        // Legacy behavior, detect app vs page router from specified project.
+        // TODO(v19): remove this logic
+        const project = (0, devkit_1.readProjectConfiguration)(host, options.project);
+        // app/ is a reserved folder in nextjs so it is safe to check it's existence
+        isAppRouter =
+            host.exists(`${project.root}/app`) ||
+                host.exists(`${project.root}/src/app`);
+        routerDirectory = isAppRouter ? 'app' : 'pages';
+        derivedDirectory = options.directory
+            ? `${routerDirectory}/${options.directory}`
+            : `${routerDirectory}`;
+    }
+    else {
+        // Get the project name first so we can determine the router directory
+        const { project: determinedProjectName } = await (0, artifact_name_and_directory_utils_1.determineArtifactNameAndDirectoryOptions)(host, {
+            artifactType: 'page',
+            callingGenerator: '@nx/next:page',
+            name: options.name,
+            directory: options.directory,
+        });
+        const project = (0, devkit_1.readProjectConfiguration)(host, determinedProjectName);
+        // app/ is a reserved folder in nextjs so it is safe to check it's existence
+        isAppRouter =
+            host.exists(`${project.root}/app`) ||
+                host.exists(`${project.root}/src/app`);
+        routerDirectory = isAppRouter ? 'app' : 'pages';
+        // New behavior, use directory as is without detecting whether we're using app or pages router.
+        derivedDirectory = options.directory;
+    }
+    const { artifactName: name, project: projectName, fileName, directory, } = await (0, artifact_name_and_directory_utils_1.determineArtifactNameAndDirectoryOptions)(host, {
+        artifactType: 'page',
+        callingGenerator: '@nx/next:page',
+        name: options.name,
+        fileName: isAppRouter ? 'page' : 'index',
+        directory: options.directory,
+        derivedDirectory,
+        flat: options.flat,
+        nameAndDirectoryFormat: options.nameAndDirectoryFormat,
+        project: options.project,
+        fileExtension: 'tsx',
+    });
+    return {
+        ...options,
+        directory,
+        fileName,
+        projectName,
+    };
+}
+exports.default = pageGenerator;

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

@@ -0,0 +1,20 @@
+import { SupportedStyles } from '@nx/react';
+
+export interface Schema {
+  name: string;
+  /**
+   * @deprecated Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v19.
+   */
+  project?: string;
+  style: SupportedStyles;
+  directory?: string;
+  fileName?: string;
+  withTests?: boolean;
+  js?: boolean;
+  /**
+   * @deprecated Provide the `directory` option instead and use the `as-provided` format. This option will be removed in Nx v19.
+   */
+  flat?: boolean;
+  skipFormat?: boolean;
+  nameAndDirectoryFormat?: 'as-provided' | 'derived';
+}

package/src/generators/page/schema.json

@@ -0,0 +1,111 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "cli": "nx",
+  "$id": "NxNextReactPage",
+  "title": "Create a Page for Next",
+  "description": "Create a Page for Next.",
+  "type": "object",
+  "properties": {
+    "project": {
+      "type": "string",
+      "description": "The name of the project.",
+      "alias": "p",
+      "$default": {
+        "$source": "projectName"
+      },
+      "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. The project will be determined from the directory provided. It will be removed in Nx v19."
+    },
+    "name": {
+      "type": "string",
+      "description": "The name of the component.",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      },
+      "x-prompt": "What name would you like to use for the component?",
+      "x-priority": "important"
+    },
+    "directory": {
+      "type": "string",
+      "description": "The directory at which to create the page file. When `--nameAndDirectoryFormat=as-provided`, it will be relative to the current working directory. Otherwise, it will be relative to the project root.",
+      "alias": "dir",
+      "x-priority": "important"
+    },
+    "nameAndDirectoryFormat": {
+      "description": "Whether to generate the component in the directory as provided, relative to the current working directory and ignoring the project (`as-provided`) or generate it using the project and directory relative to the workspace root (`derived`).",
+      "type": "string",
+      "enum": ["as-provided", "derived"]
+    },
+    "style": {
+      "description": "The file extension to be used for style files.",
+      "type": "string",
+      "alias": "s",
+      "default": "css",
+      "x-prompt": {
+        "message": "Which stylesheet format would you like to use?",
+        "type": "list",
+        "items": [
+          {
+            "value": "css",
+            "label": "CSS"
+          },
+          {
+            "value": "scss",
+            "label": "SASS(.scss)       [ https://sass-lang.com          ]"
+          },
+          {
+            "value": "less",
+            "label": "LESS              [ https://lesscss.org            ]"
+          },
+          {
+            "value": "styled-components",
+            "label": "styled-components [ https://styled-components.com ]"
+          },
+          {
+            "value": "@emotion/styled",
+            "label": "emotion           [ https://emotion.sh            ]"
+          },
+          {
+            "value": "styled-jsx",
+            "label": "styled-jsx        [ https://www.npmjs.com/package/styled-jsx ]"
+          },
+          {
+            "value": "none",
+            "label": "None"
+          }
+        ]
+      },
+      "x-priority": "important"
+    },
+    "withTests": {
+      "type": "boolean",
+      "description": "When true, creates a `spec.ts` test file for the new page.",
+      "default": false
+    },
+    "export": {
+      "type": "boolean",
+      "description": "When true, the component is exported from the project `index.ts` (if it exists).",
+      "alias": "e",
+      "default": false
+    },
+    "js": {
+      "type": "boolean",
+      "description": "Generate JavaScript files rather than TypeScript files.",
+      "default": false
+    },
+    "flat": {
+      "type": "boolean",
+      "description": "Create component at the source root rather than its own directory.",
+      "default": false,
+      "x-deprecated": "Provide the `directory` option instead and use the `as-provided` format. It will be removed in Nx v19."
+    },
+    "skipFormat": {
+      "description": "Skip formatting files.",
+      "type": "boolean",
+      "default": false,
+      "x-priority": "internal"
+    }
+  },
+  "required": ["name"],
+  "examplesFile": "../../../docs/page-examples.md"
+}

package/src/migrations/update-15-8-8/add-style-packages.d.ts

@@ -0,0 +1,3 @@
+import { Tree } from '@nx/devkit';
+export declare function update(tree: Tree): Promise<import("@nx/devkit").GeneratorCallback>;
+export default update;

package/src/migrations/update-15-8-8/add-style-packages.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.update = void 0;
+const devkit_1 = require("@nx/devkit");
+async function update(tree) {
+    const projects = (0, devkit_1.getProjects)(tree);
+    const missingDeps = {};
+    for (const [, config] of projects) {
+        if (config.targets?.build?.executor === '@nrwl/next:build' &&
+            tree.exists((0, devkit_1.joinPathFragments)(config.root, 'next.config.js'))) {
+            const nextConfigContent = tree.read((0, devkit_1.joinPathFragments)(config.root, 'next.config.js'), 'utf-8');
+            if (nextConfigContent.includes('@nrwl/next/plugins/with-less')) {
+                missingDeps['less'] = '3.12.2';
+            }
+            if (nextConfigContent.includes('@nrwl/next/plugins/with-stylus')) {
+                missingDeps['stylus'] = '^0.55.0';
+            }
+        }
+    }
+    return (0, devkit_1.addDependenciesToPackageJson)(tree, {}, missingDeps);
+}
+exports.update = update;
+exports.default = update;

package/src/migrations/update-16-0-0-add-nx-packages/update-16-0-0-add-nx-packages.d.ts

@@ -0,0 +1,2 @@
+import { Tree } from '@nx/devkit';
+export default function replacePackage(tree: Tree): Promise<void>;

package/src/migrations/update-16-0-0-add-nx-packages/update-16-0-0-add-nx-packages.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const devkit_1 = require("@nx/devkit");
+const replace_package_1 = require("@nx/devkit/src/utils/replace-package");
+async function replacePackage(tree) {
+    await (0, replace_package_1.replaceNrwlPackageWithNxPackage)(tree, '@nrwl/next', '@nx/next');
+    await (0, devkit_1.formatFiles)(tree);
+}
+exports.default = replacePackage;

package/src/migrations/update-16-3-0/remove-root-build-option.d.ts

@@ -0,0 +1,2 @@
+import { Tree } from '@nx/devkit';
+export default function update(tree: Tree): Promise<void>;

package/src/migrations/update-16-3-0/remove-root-build-option.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const devkit_1 = require("@nx/devkit");
+const executor_options_utils_1 = require("@nx/devkit/src/generators/executor-options-utils");
+async function update(tree) {
+    (0, executor_options_utils_1.forEachExecutorOptions)(tree, '@nx/next:build', (options, projectName, targetName) => {
+        const projectConfig = (0, devkit_1.readProjectConfiguration)(tree, projectName);
+        delete projectConfig.targets[targetName].options.root;
+        (0, devkit_1.updateProjectConfiguration)(tree, projectName, projectConfig);
+    });
+    (0, executor_options_utils_1.forEachExecutorOptions)(tree, '@nrwl/next:build', (options, projectName, targetName) => {
+        const projectConfig = (0, devkit_1.readProjectConfiguration)(tree, projectName);
+        delete projectConfig.targets[targetName].options.root;
+        (0, devkit_1.updateProjectConfiguration)(tree, projectName, projectConfig);
+    });
+}
+exports.default = update;

package/src/migrations/update-16-4-0/update-nx-next-dependency.d.ts

@@ -0,0 +1,2 @@
+import { Tree } from '@nx/devkit';
+export default function update(tree: Tree): Promise<void>;

package/src/migrations/update-16-4-0/update-nx-next-dependency.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const devkit_1 = require("@nx/devkit");
+async function update(tree) {
+    if (tree.exists('./package.json')) {
+        (0, devkit_1.updateJson)(tree, 'package.json', (packageJson) => {
+            if (packageJson.dependencies['@nx/next']) {
+                packageJson.devDependencies['@nx/next'] =
+                    packageJson.dependencies['@nx/next'];
+                delete packageJson.dependencies['@nx/next'];
+            }
+            return packageJson;
+        });
+    }
+    await (0, devkit_1.formatFiles)(tree);
+}
+exports.default = update;

package/src/migrations/update-17-2-7/remove-eslint-rules-patch.d.ts

@@ -0,0 +1,2 @@
+import { Tree } from '@nx/devkit';
+export default function update(tree: Tree): Promise<void>;

package/src/migrations/update-17-2-7/remove-eslint-rules-patch.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const devkit_1 = require("@nx/devkit");
+const eslint_file_1 = require("@nx/eslint/src/generators/utils/eslint-file");
+async function update(tree) {
+    const projects = (0, devkit_1.getProjects)(tree);
+    projects.forEach((project) => {
+        if (!(0, eslint_file_1.isEslintConfigSupported)(tree, project.root))
+            return;
+        (0, eslint_file_1.updateOverrideInLintConfig)(tree, project.root, (o) => o.rules?.['@next/next/no-html-link-for-pages'] &&
+            o.files?.includes('**/*.*'), (o) => undefined);
+    });
+    await (0, devkit_1.formatFiles)(tree);
+}
+exports.default = update;

package/src/plugins/plugin.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="node" />
+import { CreateDependencies, CreateNodes } from '@nx/devkit';
+export interface NextPluginOptions {
+    buildTargetName?: string;
+    devTargetName?: string;
+    startTargetName?: string;
+    serveStaticTargetName?: string;
+}
+export declare const createDependencies: CreateDependencies;
+export declare const createNodes: CreateNodes<NextPluginOptions>;
+export declare function loadEsmModule<T>(modulePath: string | URL): Promise<T>;