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

package/src/generators/application/files/common/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "<%= rootTsConfigPath %>",
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.app.json"
+    }
+  ]
+}

package/src/generators/application/files/common/webpack.config.js__tmpl__

@@ -0,0 +1,35 @@
+<% if (webpackPluginOptions) { %>
+const { NxWebpackPlugin } = require('@nx/webpack');
+const { join } = require('path');
+
+module.exports = {
+  output: {
+    path: join(__dirname, '<%= offset %><%= webpackPluginOptions.outputPath %>'),
+  },
+  plugins: [
+    new NxWebpackPlugin({
+      target: 'node',
+      compiler: 'tsc',
+      main: '<%= webpackPluginOptions.main %>',
+      tsConfig: '<%= webpackPluginOptions.tsConfig %>',
+      assets: <%- JSON.stringify(webpackPluginOptions.assets) %>,
+      optimization: false,
+      outputHashing: 'none',
+    })
+  ],
+};
+<% } else { %>
+const { composePlugins, withNx} = require('@nx/webpack');
+
+// Nx plugins for webpack.
+module.exports = composePlugins(
+  withNx({
+    target: 'node',
+  }),
+  (config) => {
+    // Update the webpack config as needed here.
+    // e.g. `config.plugins.push(new MyPlugin())`
+    return config;
+  }
+);
+<% } %>

package/src/generators/application/files/express/src/main.ts__tmpl__

@@ -0,0 +1,14 @@
+import express from 'express';
+
+const host = process.env.HOST ?? 'localhost';
+const port = process.env.PORT ? Number(process.env.PORT) : <%= port %>;
+
+const app = express();
+
+app.get('/', (req, res) => {
+    res.send({ 'message': 'Hello API'});
+});
+
+app.listen(port, host, () => {
+    console.log(`[ ready ] http://${host}:${port}`);
+});

package/src/generators/application/files/fastify/src/app/app.spec.ts__tmpl__

@@ -0,0 +1,20 @@
+import Fastify, { FastifyInstance } from 'fastify';
+import { app } from './app';
+
+describe('GET /', () => {
+  let server: FastifyInstance;
+
+  beforeEach(() => {
+    server = Fastify();
+    server.register(app);
+  });
+
+  it('should respond with a message', async () => {
+    const response = await server.inject({
+      method: 'GET',
+      url: '/'
+    });
+
+    expect(response.json()).toEqual({ message: 'Hello API' })
+  });
+});

package/src/generators/application/files/fastify/src/app/app.ts__tmpl__

@@ -0,0 +1,27 @@
+import * as path from 'path';
+import { FastifyInstance } from 'fastify';
+import AutoLoad from '@fastify/autoload';
+
+/* eslint-disable-next-line */
+export interface AppOptions { }
+
+export async function app(fastify: FastifyInstance, opts: AppOptions) {
+  // Place here your custom code!
+
+  // Do not touch the following lines
+
+  // This loads all plugins defined in plugins
+  // those should be support plugins that are reused
+  // through your application
+  fastify.register(AutoLoad, {
+    dir: path.join(__dirname, 'plugins'),
+    options: { ...opts },
+  });
+
+  // This loads all plugins defined in routes
+  // define your routes in one of these
+  fastify.register(AutoLoad, {
+    dir: path.join(__dirname, 'routes'),
+    options: { ...opts },
+  });
+}

package/src/generators/application/files/fastify/src/app/plugins/sensible.ts__tmpl__

@@ -0,0 +1,12 @@
+import { FastifyInstance } from 'fastify';
+import fp from 'fastify-plugin';
+import sensible from '@fastify/sensible';
+
+/**
+ * This plugins adds some utilities to handle http errors
+ *
+ * @see https://github.com/fastify/fastify-sensible
+ */
+export default fp(async function(fastify: FastifyInstance) {
+  fastify.register(sensible);
+});

package/src/generators/application/files/fastify/src/app/routes/root.ts__tmpl__

@@ -0,0 +1,7 @@
+import { FastifyInstance } from 'fastify';
+
+export default async function(fastify: FastifyInstance) {
+  fastify.get('/', async function() {
+    return { message: 'Hello API' };
+  });
+}

package/src/generators/application/files/fastify/src/main.ts__tmpl__

@@ -0,0 +1,23 @@
+import Fastify from 'fastify';
+import { app } from './app/app';
+
+const host = process.env.HOST ?? 'localhost';
+const port = process.env.PORT ? Number(process.env.PORT) : <%= port %>;
+
+// Instantiate Fastify with some config
+const server = Fastify({
+  logger: true,
+});
+
+// Register your application as a normal plugin.
+server.register(app);
+
+// Start listening.
+server.listen({ port, host }, (err) => {
+  if (err) {
+    server.log.error(err);
+    process.exit(1);
+  } else {
+    console.log(`[ ready ] http://${host}:${port}`);
+  }
+});

package/src/generators/application/files/koa/src/main.ts__tmpl__

@@ -0,0 +1,14 @@
+import koa from 'koa';
+
+const host = process.env.HOST ?? 'localhost';
+const port = process.env.PORT ? Number(process.env.PORT) : <%= port %>;
+
+const app = new koa();
+
+app.use(async ctx =>{
+    ctx.body = { 'message': 'Hello API'};
+});
+
+app.listen(port, host, () => {
+    console.log(`[ ready ] http://${host}:${port}`);
+});

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

@@ -0,0 +1,31 @@
+import type { ProjectNameAndRootFormat } from '@nx/devkit/src/generators/project-name-and-root-utils';
+import type { Linter } from '@nx/eslint';
+
+export interface Schema {
+  name: string;
+  skipFormat?: boolean;
+  skipPackageJson?: boolean;
+  directory?: string;
+  projectNameAndRootFormat?: ProjectNameAndRootFormat;
+  unitTestRunner?: 'jest' | 'none';
+  e2eTestRunner?: 'jest' | 'none';
+  linter?: Linter;
+  tags?: string;
+  frontendProject?: string;
+  swcJest?: boolean;
+  /** @deprecated use `swcJest` instead */
+  babelJest?: boolean;
+  js?: boolean;
+  pascalCaseFiles?: boolean;
+  setParserOptionsProject?: boolean;
+  standaloneConfig?: boolean;
+  bundler?: 'esbuild' | 'webpack';
+  framework?: NodeJsFrameWorks;
+  port?: number;
+  rootProject?: boolean;
+  docker?: boolean;
+  isNest?: boolean;
+  addPlugin?: boolean;
+}
+
+export type NodeJsFrameWorks = 'express' | 'koa' | 'fastify' | 'nest' | 'none';

package/src/generators/application/schema.json

@@ -0,0 +1,136 @@
+{
+  "$schema": "https://json-schema.org/schema",
+  "cli": "nx",
+  "$id": "SchematicsNxNodeApp",
+  "title": "Nx Application Options Schema",
+  "description": "Nx Application Options Schema.",
+  "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 node application?",
+      "x-priority": "important",
+      "pattern": "^[a-zA-Z][^:]*$"
+    },
+    "directory": {
+      "description": "The directory of the new application.",
+      "type": "string",
+      "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"]
+    },
+    "skipFormat": {
+      "description": "Skip formatting files",
+      "type": "boolean",
+      "default": false,
+      "x-priority": "internal"
+    },
+    "skipPackageJson": {
+      "type": "boolean",
+      "default": false,
+      "description": "Do not add dependencies to `package.json`.",
+      "x-priority": "internal"
+    },
+    "linter": {
+      "description": "The tool to use for running lint checks.",
+      "type": "string",
+      "enum": ["eslint"],
+      "default": "eslint"
+    },
+    "unitTestRunner": {
+      "type": "string",
+      "enum": ["jest", "none"],
+      "description": "Test runner to use for unit tests.",
+      "default": "jest"
+    },
+    "tags": {
+      "type": "string",
+      "description": "Add tags to the application (used for linting)."
+    },
+    "frontendProject": {
+      "type": "string",
+      "description": "Frontend project that needs to access this application. This sets up proxy configuration.",
+      "x-priority": "important",
+      "x-dropdown": "projects"
+    },
+    "swcJest": {
+      "type": "boolean",
+      "description": "Use `@swc/jest` instead `ts-jest` for faster test compilation.",
+      "default": false
+    },
+    "babelJest": {
+      "type": "boolean",
+      "description": "Use `babel` instead `ts-jest`.",
+      "default": false,
+      "x-deprecated": "Use --swcJest instead for faster compilation"
+    },
+    "pascalCaseFiles": {
+      "type": "boolean",
+      "description": "Use pascal case file names.",
+      "alias": "P",
+      "default": false
+    },
+    "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
+    },
+    "standaloneConfig": {
+      "description": "Split the project configuration into `<projectRoot>/project.json` rather than including it inside `workspace.json`.",
+      "type": "boolean",
+      "default": true,
+      "x-deprecated": "Nx only supports standaloneConfig"
+    },
+    "bundler": {
+      "description": "Bundler which is used to package the application",
+      "type": "string",
+      "enum": ["esbuild", "webpack"],
+      "default": "esbuild",
+      "x-priority": "important"
+    },
+    "framework": {
+      "description": "Generate the node application using a framework",
+      "type": "string",
+      "enum": ["express", "fastify", "koa", "nest", "none"],
+      "default": "none",
+      "x-prompt": "Which framework do you want to use?",
+      "x-priority": "important"
+    },
+    "port": {
+      "description": "The port which the server will be run on",
+      "type": "number",
+      "default": 3000
+    },
+    "rootProject": {
+      "description": "Create node application at the root of the workspace",
+      "type": "boolean",
+      "default": false,
+      "hidden": true,
+      "x-priority": "internal"
+    },
+    "e2eTestRunner": {
+      "type": "string",
+      "enum": ["jest", "none"],
+      "description": "Test runner to use for end to end (e2e) tests",
+      "default": "jest"
+    },
+    "docker": {
+      "type": "boolean",
+      "description": "Add a docker build target"
+    }
+  },
+  "required": ["name"]
+}

package/src/generators/e2e-project/e2e-project.d.ts

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

package/src/generators/e2e-project/e2e-project.js

@@ -0,0 +1,123 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.e2eProjectGeneratorInternal = exports.e2eProjectGenerator = 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 global_eslint_config_1 = require("@nx/eslint/src/generators/init/global-eslint-config");
+const path = require("path");
+const versions_1 = require("../../utils/versions");
+const eslint_file_1 = require("@nx/eslint/src/generators/utils/eslint-file");
+const log_show_project_command_1 = require("@nx/devkit/src/utils/log-show-project-command");
+async function e2eProjectGenerator(host, options) {
+    return await e2eProjectGeneratorInternal(host, {
+        addPlugin: false,
+        projectNameAndRootFormat: 'derived',
+        ...options,
+    });
+}
+exports.e2eProjectGenerator = e2eProjectGenerator;
+async function e2eProjectGeneratorInternal(host, _options) {
+    const tasks = [];
+    const options = await normalizeOptions(host, _options);
+    const appProject = (0, devkit_1.readProjectConfiguration)(host, options.project);
+    // TODO(@ndcunningham): This is broken.. the outputs are wrong.. and this isn't using the jest generator
+    (0, devkit_1.addProjectConfiguration)(host, options.e2eProjectName, {
+        root: options.e2eProjectRoot,
+        implicitDependencies: [options.project],
+        projectType: 'application',
+        targets: {
+            e2e: {
+                executor: '@nx/jest:jest',
+                outputs: ['{workspaceRoot}/coverage/{e2eProjectRoot}'],
+                options: {
+                    jestConfig: `${options.e2eProjectRoot}/jest.config.ts`,
+                    passWithNoTests: true,
+                },
+            },
+        },
+    });
+    if (options.projectType === 'server') {
+        (0, devkit_1.generateFiles)(host, path.join(__dirname, 'files/server/common'), options.e2eProjectRoot, {
+            ...options,
+            ...(0, devkit_1.names)(options.rootProject ? 'server' : options.project),
+            offsetFromRoot: (0, devkit_1.offsetFromRoot)(options.e2eProjectRoot),
+            tmpl: '',
+        });
+        if (options.isNest) {
+            (0, devkit_1.generateFiles)(host, path.join(__dirname, 'files/server/nest'), options.e2eProjectRoot, {
+                ...options,
+                ...(0, devkit_1.names)(options.rootProject ? 'server' : options.project),
+                offsetFromRoot: (0, devkit_1.offsetFromRoot)(options.e2eProjectRoot),
+                tmpl: '',
+            });
+        }
+    }
+    else if (options.projectType === 'cli') {
+        const mainFile = appProject.targets.build?.options?.outputPath;
+        (0, devkit_1.generateFiles)(host, path.join(__dirname, 'files/cli'), options.e2eProjectRoot, {
+            ...options,
+            ...(0, devkit_1.names)(options.rootProject ? 'cli' : options.project),
+            mainFile,
+            offsetFromRoot: (0, devkit_1.offsetFromRoot)(options.e2eProjectRoot),
+            tmpl: '',
+        });
+    }
+    // axios is more than likely used in the application code, so install it as a regular dependency.
+    const installTask = (0, devkit_1.addDependenciesToPackageJson)(host, { axios: versions_1.axiosVersion }, {});
+    tasks.push(installTask);
+    if (options.linter === eslint_1.Linter.EsLint) {
+        const linterTask = await (0, eslint_1.lintProjectGenerator)(host, {
+            project: options.e2eProjectName,
+            linter: eslint_1.Linter.EsLint,
+            skipFormat: true,
+            tsConfigPaths: [
+                (0, devkit_1.joinPathFragments)(options.e2eProjectRoot, 'tsconfig.json'),
+            ],
+            setParserOptionsProject: false,
+            skipPackageJson: false,
+            rootProject: options.rootProject,
+            addPlugin: options.addPlugin,
+        });
+        tasks.push(linterTask);
+        if (options.rootProject && (0, eslint_file_1.isEslintConfigSupported)(host)) {
+            (0, eslint_file_1.addPluginsToLintConfig)(host, options.e2eProjectRoot, '@nx');
+            (0, eslint_file_1.replaceOverridesInLintConfig)(host, options.e2eProjectRoot, [
+                global_eslint_config_1.typeScriptOverride,
+                global_eslint_config_1.javaScriptOverride,
+            ]);
+        }
+    }
+    if (!options.skipFormat) {
+        await (0, devkit_1.formatFiles)(host);
+    }
+    tasks.push(() => {
+        (0, log_show_project_command_1.logShowProjectCommand)(options.e2eProjectName);
+    });
+    return (0, devkit_1.runTasksInSerial)(...tasks);
+}
+exports.e2eProjectGeneratorInternal = e2eProjectGeneratorInternal;
+async function normalizeOptions(tree, options) {
+    const { projectName: e2eProjectName, projectRoot: e2eProjectRoot } = await (0, project_name_and_root_utils_1.determineProjectNameAndRootOptions)(tree, {
+        name: options.name ?? `${options.project}-e2e`,
+        projectType: 'library',
+        directory: options.rootProject ? 'e2e' : options.directory,
+        projectNameAndRootFormat: options.rootProject
+            ? 'as-provided'
+            : options.projectNameAndRootFormat,
+        // this is an internal generator, don't save defaults
+        callingGenerator: null,
+    });
+    const nxJson = (0, devkit_1.readNxJson)(tree);
+    const addPlugin = process.env.NX_ADD_PLUGINS !== 'false' &&
+        nxJson.useInferencePlugins !== false;
+    return {
+        addPlugin,
+        ...options,
+        e2eProjectRoot,
+        e2eProjectName,
+        port: options.port ?? 3000,
+        rootProject: !!options.rootProject,
+    };
+}
+exports.default = e2eProjectGenerator;

package/src/generators/e2e-project/files/cli/jest.config.ts__tmpl__

@@ -0,0 +1,14 @@
+/* eslint-disable */
+export default {
+  displayName: '<%= e2eProjectName %>',
+  preset: '<%= offsetFromRoot %>/jest.preset.js',
+  setupFiles: ['<rootDir>/src/test-setup.ts'],
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.[tj]s$': ['ts-jest', {
+      tsconfig: '<rootDir>/tsconfig.spec.json',
+    }],
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '<%= offsetFromRoot %>/coverage/<%= e2eProjectName %>',
+};

package/src/generators/e2e-project/files/cli/src/__fileName__/__fileName__.spec.ts__tmpl__

@@ -0,0 +1,13 @@
+import { execSync } from 'child_process';
+import { join } from 'path';
+
+describe('CLI tests', () => {
+  it('should print a message', () => {
+    const cliPath = join(process.cwd(), "<%= mainFile %>");
+
+    const output = execSync(`node ${cliPath}`).toString();
+
+    expect(output).toMatch(/Hello World/);
+  });
+});
+

package/src/generators/e2e-project/files/cli/src/test-setup.ts__tmpl__

@@ -0,0 +1 @@
+//

package/src/generators/e2e-project/files/cli/tsconfig.json__tmpl__

@@ -0,0 +1,13 @@
+{
+  "extends": "<%= offsetFromRoot %><% if (rootProject) { %>tsconfig.json<% } else { %>tsconfig.base.json<% } %>",
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ],
+  "compilerOptions": {
+    "esModuleInterop": true
+  }
+}

package/src/generators/e2e-project/files/cli/tsconfig.spec.json__tmpl__

@@ -0,0 +1,12 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "<%= offsetFromRoot %>/dist/out-tsc",
+    "module": "commonjs",
+    "types": ["jest", "node"]
+  },
+  "include": [
+    "jest.config.ts",
+    "src/**/*.ts"
+  ]
+}

package/src/generators/e2e-project/files/server/common/jest.config.ts__tmpl__

@@ -0,0 +1,16 @@
+/* eslint-disable */
+export default {
+  displayName: '<%= e2eProjectName %>',
+  preset: '<%= offsetFromRoot %>jest.preset.js',
+  globalSetup: '<rootDir>/src/support/global-setup.ts',
+  globalTeardown: '<rootDir>/src/support/global-teardown.ts',
+  setupFiles: ['<rootDir>/src/support/test-setup.ts'],
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.[tj]s$': ['ts-jest', {
+      tsconfig: '<rootDir>/tsconfig.spec.json',
+    }],
+  },
+  moduleFileExtensions: ['ts', 'js', 'html'],
+  coverageDirectory: '<%= offsetFromRoot %>coverage/<%= e2eProjectName %>',
+};

package/src/generators/e2e-project/files/server/common/src/__fileName__/__fileName__.spec.ts__tmpl__

@@ -0,0 +1,10 @@
+import axios from 'axios';
+
+describe('GET /', () => {
+  it('should return a message', async () => {
+    const res = await axios.get(`/`);
+
+    expect(res.status).toBe(200);
+    expect(res.data).toEqual({ message: 'Hello API' });
+  });
+})

package/src/generators/e2e-project/files/server/common/src/support/global-setup.ts__tmpl__

@@ -0,0 +1,11 @@
+/* eslint-disable */
+var __TEARDOWN_MESSAGE__: string;
+
+module.exports = async function() {
+  // Start services that that the app needs to run (e.g. database, docker-compose, etc.).
+  console.log('\nSetting up...\n');
+
+  // Hint: Use `globalThis` to pass variables to global teardown.
+  globalThis.__TEARDOWN_MESSAGE__ = '\nTearing down...\n';
+};
+

package/src/generators/e2e-project/files/server/common/src/support/global-teardown.ts__tmpl__

@@ -0,0 +1,7 @@
+/* eslint-disable */
+
+module.exports = async function() {
+  // Put clean up logic here (e.g. stopping services, docker-compose, etc.).
+  // Hint: `globalThis` is shared between setup and teardown.
+  console.log(globalThis.__TEARDOWN_MESSAGE__);
+};

package/src/generators/e2e-project/files/server/common/src/support/test-setup.ts__tmpl__

@@ -0,0 +1,10 @@
+/* eslint-disable */
+
+import axios from 'axios';
+
+module.exports = async function() {
+  // Configure axios for tests to use.
+  const host = process.env.HOST ?? 'localhost';
+  const port = process.env.PORT ?? '<%= port %>';
+  axios.defaults.baseURL = `http://${host}:${port}`;
+};

package/src/generators/e2e-project/files/server/common/tsconfig.json__tmpl__

@@ -0,0 +1,13 @@
+{
+  "extends": "<%= offsetFromRoot %><% if (rootProject) { %>tsconfig.json<% } else { %>tsconfig.base.json<% } %>",
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ],
+  "compilerOptions": {
+    "esModuleInterop": true
+  }
+}

package/src/generators/e2e-project/files/server/common/tsconfig.spec.json__tmpl__

@@ -0,0 +1,12 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "<%= offsetFromRoot %>dist/out-tsc",
+    "module": "commonjs",
+    "types": ["jest", "node"]
+  },
+  "include": [
+    "jest.config.ts",
+    "src/**/*.ts"
+  ]
+}

package/src/generators/e2e-project/files/server/nest/src/__fileName__/__fileName__.spec.ts__tmpl__

@@ -0,0 +1,10 @@
+import axios from 'axios';
+
+describe('GET /api', () => {
+  it('should return a message', async () => {
+    const res = await axios.get(`/api`);
+
+    expect(res.status).toBe(200);
+    expect(res.data).toEqual({ message: 'Hello API' });
+  });
+})

package/src/generators/e2e-project/schema.d.ts

@@ -0,0 +1,15 @@
+import type { ProjectNameAndRootFormat } from '@nx/devkit/src/generators/project-name-and-root-utils';
+
+export interface Schema {
+  project: string;
+  projectType: 'server' | 'cli';
+  directory?: string;
+  projectNameAndRootFormat?: ProjectNameAndRootFormat;
+  name?: string;
+  port?: number;
+  linter?: 'eslint' | 'none';
+  rootProject?: boolean;
+  isNest?: boolean;
+  skipFormat?: boolean;
+  addPlugin?: boolean;
+}