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

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

@@ -0,0 +1,114 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createApplicationFiles = void 0;
+const path_1 = require("path");
+const devkit_1 = require("@nx/devkit");
+const js_1 = require("@nx/js");
+const create_application_files_helpers_1 = require("./create-application-files.helpers");
+function createApplicationFiles(host, options) {
+    const offsetFromRoot = (0, devkit_1.offsetFromRoot)(options.appProjectRoot);
+    const layoutTypeSrcPath = (0, devkit_1.joinPathFragments)(offsetFromRoot, options.appProjectRoot, '.next/types/**/*.ts');
+    const layoutTypeDistPath = (0, devkit_1.joinPathFragments)(offsetFromRoot, options.outputPath, '.next/types/**/*.ts');
+    // scope tsconfig to the project directory so that it doesn't include other projects/libs
+    const rootPath = options.rootProject
+        ? options.src
+            ? 'src/'
+            : options.appDir
+                ? 'app/'
+                : 'pages/'
+        : '';
+    const templateVariables = {
+        ...(0, devkit_1.names)(options.name),
+        ...options,
+        dot: '.',
+        tmpl: '',
+        offsetFromRoot,
+        layoutTypeSrcPath,
+        rootPath,
+        layoutTypeDistPath,
+        rootTsConfigPath: (0, js_1.getRelativePathToRootTsConfig)(host, options.appProjectRoot),
+        appContent: (0, create_application_files_helpers_1.createAppJsx)(options.projectName),
+        styleContent: (0, create_application_files_helpers_1.createStyleRules)(),
+        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)(generatedAppFilePath, 'app'), templateVariables);
+        if (options.unitTestRunner === 'none') {
+            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)(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)(generatedAppFilePath, 'app'), templateVariables);
+        }
+        else {
+            (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)(generatedAppFilePath, 'pages'), templateVariables);
+    }
+    if (options.rootProject) {
+        (0, devkit_1.updateJson)(host, 'tsconfig.base.json', (json) => {
+            const appJSON = (0, devkit_1.readJson)(host, 'tsconfig.json');
+            let { extends: _, ...updatedJson } = json;
+            // Don't generate the `paths` object or else workspace libs will not work later.
+            // It'll be generated as needed when a lib is first added.
+            delete json.compilerOptions.paths;
+            updatedJson = {
+                ...devkit_1.updateJson,
+                compilerOptions: {
+                    ...updatedJson.compilerOptions,
+                    ...appJSON.compilerOptions,
+                },
+                include: [
+                    ...new Set([
+                        ...(updatedJson.include || []),
+                        ...(appJSON.include || []),
+                    ]),
+                ],
+                exclude: [
+                    ...new Set([
+                        ...(updatedJson.exclude || []),
+                        ...(appJSON.exclude || []),
+                        `dist/${options.projectName}/**/*`,
+                    ]),
+                ],
+            };
+            return updatedJson;
+        });
+        host.delete('tsconfig.json');
+        host.rename('tsconfig.base.json', 'tsconfig.json');
+    }
+    if (options.unitTestRunner === 'none') {
+        host.delete(`${options.appProjectRoot}/specs/${options.fileName}.spec.tsx`);
+    }
+    // SWC will be disabled if custom babelrc is provided.
+    // Check for `!== false` because `create-nx-workspace` is not passing default values.
+    if (options.swc !== false) {
+        host.delete(`${options.appProjectRoot}/.babelrc`);
+    }
+    if (options.styledModule) {
+        if (options.appDir) {
+            host.delete(`${generatedAppFilePath}/app/page.module.${options.style}`);
+        }
+        else {
+            host.delete(`${generatedAppFilePath}/pages/${options.fileName}.module.${options.style}`);
+        }
+    }
+    if (options.style !== 'styled-components') {
+        host.delete(`${generatedAppFilePath}/pages/_document.tsx`);
+    }
+    if (options.js) {
+        host.delete(`${options.appProjectRoot}/index.d.ts`);
+        (0, devkit_1.toJS)(host);
+        host.delete(`${options.appProjectRoot}/next-env.d.js`);
+    }
+}
+exports.createApplicationFiles = createApplicationFiles;

package/src/generators/application/lib/normalize-options.d.ts

@@ -0,0 +1,14 @@
+import { Tree } from '@nx/devkit';
+import { Schema } from '../schema';
+export interface NormalizedSchema extends Schema {
+    projectName: string;
+    appProjectRoot: string;
+    outputPath: string;
+    e2eProjectName: string;
+    e2eProjectRoot: string;
+    parsedTags: string[];
+    fileName: string;
+    styledModule: null | string;
+    js?: boolean;
+}
+export declare function normalizeOptions(host: Tree, options: Schema): Promise<NormalizedSchema>;

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

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeOptions = void 0;
+const devkit_1 = require("@nx/devkit");
+const project_name_and_root_utils_1 = require("@nx/devkit/src/generators/project-name-and-root-utils");
+const eslint_1 = require("@nx/eslint");
+const assertion_1 = require("@nx/react/src/utils/assertion");
+async function normalizeOptions(host, options) {
+    const { projectName: appProjectName, projectRoot: appProjectRoot, projectNameAndRootFormat, } = await (0, project_name_and_root_utils_1.determineProjectNameAndRootOptions)(host, {
+        name: options.name,
+        projectType: 'application',
+        directory: options.directory,
+        projectNameAndRootFormat: options.projectNameAndRootFormat,
+        rootProject: options.rootProject,
+        callingGenerator: '@nx/next:application',
+    });
+    options.rootProject = appProjectRoot === '.';
+    options.projectNameAndRootFormat = projectNameAndRootFormat;
+    const nxJson = (0, devkit_1.readNxJson)(host);
+    const addPlugin = process.env.NX_ADD_PLUGINS !== 'false' &&
+        nxJson.useInferencePlugins !== false;
+    options.addPlugin ??= addPlugin;
+    const e2eProjectName = options.rootProject ? 'e2e' : `${appProjectName}-e2e`;
+    const e2eProjectRoot = options.rootProject ? 'e2e' : `${appProjectRoot}-e2e`;
+    const name = (0, devkit_1.names)(options.name).fileName;
+    const outputPath = (0, devkit_1.joinPathFragments)('dist', appProjectRoot, ...(options.rootProject ? [name] : []));
+    const parsedTags = options.tags
+        ? options.tags.split(',').map((s) => s.trim())
+        : [];
+    const fileName = 'index';
+    const appDir = options.appDir ?? true;
+    const src = options.src ?? true;
+    const styledModule = /^(css|scss|less)$/.test(options.style)
+        ? null
+        : options.style;
+    (0, assertion_1.assertValidStyle)(options.style);
+    return {
+        ...options,
+        appDir,
+        src,
+        appProjectRoot,
+        e2eProjectName,
+        e2eProjectRoot,
+        e2eTestRunner: options.e2eTestRunner || 'cypress',
+        fileName,
+        linter: options.linter || eslint_1.Linter.EsLint,
+        name,
+        outputPath,
+        parsedTags,
+        projectName: appProjectName,
+        style: options.style || 'css',
+        styledModule,
+        unitTestRunner: options.unitTestRunner || 'jest',
+    };
+}
+exports.normalizeOptions = normalizeOptions;

package/src/generators/application/lib/set-defaults.d.ts

@@ -0,0 +1,3 @@
+import { Tree } from '@nx/devkit';
+import { NormalizedSchema } from './normalize-options';
+export declare function setDefaults(host: Tree, options: NormalizedSchema): void;

package/src/generators/application/lib/set-defaults.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setDefaults = void 0;
+const devkit_1 = require("@nx/devkit");
+function setDefaults(host, options) {
+    const nxJson = (0, devkit_1.readNxJson)(host);
+    nxJson.generators ??= {};
+    nxJson.generators['@nx/next'] ??= {};
+    nxJson.generators['@nx/next'].application ??= {};
+    nxJson.generators['@nx/next'].application.style ??= options.style;
+    nxJson.generators['@nx/next'].application.linter ??= options.linter;
+    (0, devkit_1.updateNxJson)(host, nxJson);
+}
+exports.setDefaults = setDefaults;

package/src/generators/application/lib/show-possible-warnings.d.ts

@@ -0,0 +1,3 @@
+import { Tree } from '@nx/devkit';
+import { NormalizedSchema } from './normalize-options';
+export declare function showPossibleWarnings(tree: Tree, options: NormalizedSchema): void;

package/src/generators/application/lib/show-possible-warnings.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.showPossibleWarnings = void 0;
+const devkit_1 = require("@nx/devkit");
+function showPossibleWarnings(tree, options) {
+    if (options.style === '@emotion/styled' && options.appDir) {
+        devkit_1.logger.warn(`Emotion may not work with the App Router. See: https://nextjs.org/docs/app/building-your-application/styling/css-in-js`);
+    }
+}
+exports.showPossibleWarnings = showPossibleWarnings;

package/src/generators/application/lib/update-cypress-tsconfig.d.ts

@@ -0,0 +1,3 @@
+import { Tree } from '@nx/devkit';
+import { NormalizedSchema } from './normalize-options';
+export declare function updateCypressTsConfig(host: Tree, options: NormalizedSchema): void;

package/src/generators/application/lib/update-cypress-tsconfig.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateCypressTsConfig = void 0;
+const devkit_1 = require("@nx/devkit");
+function updateCypressTsConfig(host, options) {
+    if (options.e2eTestRunner !== 'cypress' || !options.rootProject) {
+        return;
+    }
+    (0, devkit_1.updateJson)(host, `${options.e2eProjectRoot}/tsconfig.json`, (json) => {
+        return {
+            ...json,
+            exclude: [],
+        };
+    });
+}
+exports.updateCypressTsConfig = updateCypressTsConfig;

package/src/generators/application/lib/update-jest-config.d.ts

@@ -0,0 +1,3 @@
+import { NormalizedSchema } from './normalize-options';
+import { Tree } from '@nx/devkit';
+export declare function updateJestConfig(host: Tree, options: NormalizedSchema): void;

package/src/generators/application/lib/update-jest-config.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateJestConfig = void 0;
+function updateJestConfig(host, options) {
+    if (options.unitTestRunner !== 'jest') {
+        return;
+    }
+    const configPath = `${options.appProjectRoot}/jest.config.${options.js ? 'js' : 'ts'}`;
+    const originalContent = host.read(configPath, 'utf-8');
+    const content = originalContent
+        .replace('transform: {', "transform: {\n    '^(?!.*\\\\.(js|jsx|ts|tsx|css|json)$)': '@nx/react/plugins/jest',")
+        .replace(`'babel-jest'`, `['babel-jest', { presets: ['@nx/next/babel'] }]`);
+    host.write(configPath, content);
+}
+exports.updateJestConfig = updateJestConfig;

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

@@ -0,0 +1,24 @@
+import type { ProjectNameAndRootFormat } from '@nx/devkit/src/generators/project-name-and-root-utils';
+import type { Linter } from '@nx/eslint';
+import type { SupportedStyles } from '@nx/react';
+
+export interface Schema {
+  name: string;
+  style?: SupportedStyles;
+  skipFormat?: boolean;
+  directory?: string;
+  projectNameAndRootFormat?: ProjectNameAndRootFormat;
+  tags?: string;
+  unitTestRunner?: 'jest' | 'none';
+  e2eTestRunner?: 'cypress' | 'playwright' | 'none';
+  linter?: Linter;
+  js?: boolean;
+  setParserOptionsProject?: boolean;
+  swc?: boolean;
+  customServer?: boolean;
+  skipPackageJson?: boolean;
+  appDir?: boolean;
+  src?: boolean;
+  rootProject?: boolean;
+  addPlugin?: boolean;
+}

package/src/generators/application/schema.json

@@ -0,0 +1,146 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "cli": "nx",
+  "$id": "NxNextApp",
+  "title": "Create a Next.js Application for Nx",
+  "description": "Create a Next.js Application for Nx.",
+  "type": "object",
+  "properties": {
+    "name": {
+      "description": "The name of the application.",
+      "type": "string",
+      "$default": {
+        "$source": "argv",
+        "index": 0
+      },
+      "x-prompt": "What name would you like to use for the application?",
+      "pattern": "^[a-zA-Z][^:]*$",
+      "x-priority": "important"
+    },
+    "directory": {
+      "description": "The directory of the new application.",
+      "type": "string",
+      "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"
+    },
+    "skipFormat": {
+      "description": "Skip formatting files.",
+      "type": "boolean",
+      "default": false,
+      "x-priority": "internal"
+    },
+    "unitTestRunner": {
+      "type": "string",
+      "enum": ["jest", "none"],
+      "description": "Test runner to use for unit tests.",
+      "default": "jest"
+    },
+    "e2eTestRunner": {
+      "type": "string",
+      "enum": ["cypress", "playwright", "none"],
+      "description": "Test runner to use for end to end (E2E) tests.",
+      "x-prompt": "Which E2E test runner would you like to use?",
+      "default": "cypress"
+    },
+    "tags": {
+      "type": "string",
+      "description": "Add tags to the application (used for linting).",
+      "alias": "t"
+    },
+    "js": {
+      "type": "boolean",
+      "description": "Generate JavaScript files rather than TypeScript files.",
+      "default": false
+    },
+    "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
+    },
+    "swc": {
+      "description": "Enable the Rust-based compiler SWC to compile JS/TS files.",
+      "type": "boolean",
+      "default": true
+    },
+    "customServer": {
+      "description": "Use a custom Express server for the Next.js application.",
+      "type": "boolean",
+      "default": false
+    },
+    "skipPackageJson": {
+      "type": "boolean",
+      "default": false,
+      "description": "Do not add dependencies to `package.json`.",
+      "x-priority": "internal"
+    },
+    "appDir": {
+      "type": "boolean",
+      "default": true,
+      "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",
+      "default": false,
+      "hidden": true,
+      "x-priority": "internal"
+    }
+  },
+  "required": [],
+  "examplesFile": "../../../docs/application-examples.md"
+}

package/src/generators/component/component.d.ts

@@ -0,0 +1,28 @@
+import { Tree } from '@nx/devkit';
+import type { SupportedStyles } from '@nx/react';
+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;
+    /**
+     * @deprecated Provide the `directory` option instead and use the `as-provided` format. This option will be removed in Nx v19.
+     */
+    flat?: boolean;
+    /**
+     * @deprecated Provide the `name` in pascal-case and use the `as-provided` format. This option will be removed in Nx v19.
+     */
+    pascalCaseFiles?: boolean;
+    /**
+     * @deprecated Provide the `directory` in pascal-case and use the `as-provided` format. This option will be removed in Nx v19.
+     */
+    pascalCaseDirectory?: boolean;
+    nameAndDirectoryFormat?: 'as-provided' | 'derived';
+    skipFormat?: boolean;
+}
+export declare function componentGenerator(host: Tree, schema: Schema): Promise<import("@nx/devkit").GeneratorCallback>;
+export declare function componentGeneratorInternal(host: Tree, options: Schema): Promise<import("@nx/devkit").GeneratorCallback>;
+export default componentGenerator;

package/src/generators/component/component.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.componentGeneratorInternal = exports.componentGenerator = void 0;
+const devkit_1 = require("@nx/devkit");
+const react_1 = require("@nx/react");
+const styles_1 = require("../../utils/styles");
+const artifact_name_and_directory_utils_1 = require("@nx/devkit/src/generators/artifact-name-and-directory-utils");
+// TODO(v19): Remove this logic once we no longer derive directory.
+function maybeGetDerivedDirectory(host, options) {
+    if (!options.project)
+        return options.directory;
+    const workspace = (0, devkit_1.getProjects)(host);
+    const projectType = workspace.get(options.project).projectType;
+    return options.directory
+        ? options.directory
+        : projectType === 'application'
+            ? 'components'
+            : undefined;
+}
+async function componentGenerator(host, schema) {
+    return componentGeneratorInternal(host, {
+        nameAndDirectoryFormat: 'derived',
+        ...schema,
+    });
+}
+exports.componentGenerator = componentGenerator;
+/*
+ * This schematic is basically the React one, but for Next we need
+ * extra dependencies for css, sass, less style options.
+ */
+async function componentGeneratorInternal(host, options) {
+    const { artifactName: name, directory, project: projectName, } = await (0, artifact_name_and_directory_utils_1.determineArtifactNameAndDirectoryOptions)(host, {
+        artifactType: 'component',
+        callingGenerator: '@nx/next:component',
+        name: options.name,
+        directory: options.directory,
+        derivedDirectory: maybeGetDerivedDirectory(host, options),
+        flat: options.flat,
+        nameAndDirectoryFormat: options.nameAndDirectoryFormat,
+        project: options.project,
+        fileExtension: 'tsx',
+        pascalCaseFile: options.pascalCaseFiles,
+        pascalCaseDirectory: options.pascalCaseDirectory,
+    });
+    const componentInstall = await (0, react_1.componentGenerator)(host, {
+        ...options,
+        name,
+        nameAndDirectoryFormat: 'as-provided', // already determined the directory so use as is
+        project: undefined,
+        directory,
+        classComponent: false,
+        routing: false,
+        skipFormat: true,
+    });
+    const project = (0, devkit_1.readProjectConfiguration)(host, projectName);
+    const styledInstall = (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)(styledInstall, componentInstall);
+}
+exports.componentGeneratorInternal = componentGeneratorInternal;
+exports.default = componentGenerator;

package/src/generators/component/schema.json

@@ -0,0 +1,125 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "cli": "nx",
+  "$id": "NxNextReactComponent",
+  "title": "Create a React Component for Next",
+  "description": "Create a React Component 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"
+    },
+    "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"
+          }
+        ]
+      }
+    },
+    "skipTests": {
+      "type": "boolean",
+      "description": "When true, does not create `spec.ts` test files for the new component.",
+      "default": false,
+      "x-priority": "internal"
+    },
+    "directory": {
+      "type": "string",
+      "description": "The directory at which to create the component 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"]
+    },
+    "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. This option will be removed in Nx v19."
+    },
+    "pascalCaseFiles": {
+      "type": "boolean",
+      "description": "Use pascal case component file name (e.g. `App.tsx`).",
+      "alias": "P",
+      "default": false,
+      "x-deprecated": "Provide the `name` in pascal-case and use the `as-provided` format. This option will be removed in Nx v19."
+    },
+    "pascalCaseDirectory": {
+      "type": "boolean",
+      "description": "Use pascal case directory name (e.g. `App/App.tsx`).",
+      "alias": "R",
+      "default": false,
+      "x-deprecated": "Provide the `directory` in pascal-case and use the `as-provided` format. This option will be removed in Nx v19."
+    },
+    "skipFormat": {
+      "description": "Skip formatting files.",
+      "type": "boolean",
+      "default": false,
+      "x-priority": "internal"
+    }
+  },
+  "required": ["name"],
+  "examplesFile": "../../../docs/component-examples.md"
+}

package/src/generators/custom-server/custom-server.d.ts

@@ -0,0 +1,3 @@
+import type { Tree } from '@nx/devkit';
+import { CustomServerSchema } from './schema';
+export declare function customServerGenerator(host: Tree, options: CustomServerSchema): Promise<() => void>;