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

package/src/executors/webpack/schema.json

@@ -0,0 +1,394 @@
+{
+  "version": 2,
+  "outputCapture": "direct-nodejs",
+  "title": "Webpack builder",
+  "description": "Build a project using webpack.",
+  "cli": "nx",
+  "type": "object",
+  "properties": {
+    "crossOrigin": {
+      "type": "string",
+      "description": "The `crossorigin` attribute to use for generated javascript script tags.  One of 'none' | 'anonymous' | 'use-credentials'."
+    },
+    "main": {
+      "type": "string",
+      "description": "The name of the main entry-point file.",
+      "x-completion-type": "file",
+      "x-completion-glob": "**/*@(.js|.ts|.tsx)",
+      "x-priority": "important"
+    },
+    "tsConfig": {
+      "type": "string",
+      "description": "The name of the Typescript configuration file.",
+      "x-completion-type": "file",
+      "x-completion-glob": "tsconfig.*.json",
+      "x-priority": "important"
+    },
+    "compiler": {
+      "type": "string",
+      "description": "The compiler to use.",
+      "enum": ["babel", "swc", "tsc"]
+    },
+    "outputPath": {
+      "type": "string",
+      "description": "The output path of the generated files.",
+      "x-completion-type": "directory",
+      "x-priority": "important"
+    },
+    "target": {
+      "type": "string",
+      "alias": "platform",
+      "description": "Target platform for the build, same as the Webpack target option.",
+      "enum": ["node", "web", "webworker"]
+    },
+    "deleteOutputPath": {
+      "type": "boolean",
+      "description": "Delete the output path before building.",
+      "default": true
+    },
+    "watch": {
+      "type": "boolean",
+      "description": "Enable re-building when files change."
+    },
+    "baseHref": {
+      "type": "string",
+      "description": "Base url for the application being built."
+    },
+    "deployUrl": {
+      "type": "string",
+      "description": "URL where the application will be deployed."
+    },
+    "vendorChunk": {
+      "type": "boolean",
+      "description": "Use a separate bundle containing only vendor libraries."
+    },
+    "commonChunk": {
+      "type": "boolean",
+      "description": "Use a separate bundle containing code used across multiple bundles."
+    },
+    "runtimeChunk": {
+      "type": "boolean",
+      "description": "Use a separate bundle containing the runtime."
+    },
+    "sourceMap": {
+      "description": "Output sourcemaps. Use 'hidden' for use with error reporting tools without generating sourcemap comment.",
+      "oneOf": [
+        {
+          "type": "boolean"
+        },
+        {
+          "type": "string"
+        }
+      ]
+    },
+    "progress": {
+      "type": "boolean",
+      "description": "Log progress to the console while building."
+    },
+    "assets": {
+      "type": "array",
+      "description": "List of static application assets.",
+      "items": {
+        "$ref": "#/definitions/assetPattern"
+      }
+    },
+    "index": {
+      "type": "string",
+      "description": "HTML File which will be contain the application.",
+      "x-completion-type": "file",
+      "x-completion-glob": "**/*@(.html|.htm)"
+    },
+    "scripts": {
+      "type": "array",
+      "description": "External Scripts which will be included before the main application entry.",
+      "items": {
+        "$ref": "#/definitions/extraEntryPoint"
+      }
+    },
+    "styles": {
+      "type": "array",
+      "description": "External Styles which will be included with the application",
+      "items": {
+        "$ref": "#/definitions/extraEntryPoint"
+      }
+    },
+    "namedChunks": {
+      "type": "boolean",
+      "description": "Names the produced bundles according to their entry file."
+    },
+    "outputHashing": {
+      "type": "string",
+      "description": "Define the output filename cache-busting hashing mode.",
+      "enum": ["none", "all", "media", "bundles"]
+    },
+    "stylePreprocessorOptions": {
+      "description": "Options to pass to style preprocessors.",
+      "type": "object",
+      "properties": {
+        "includePaths": {
+          "description": "Paths to include. Paths will be resolved to project root.",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "optimization": {
+      "description": "Enables optimization of the build output.",
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "scripts": {
+              "type": "boolean",
+              "description": "Enables optimization of the scripts output.",
+              "default": true
+            },
+            "styles": {
+              "type": "boolean",
+              "description": "Enables optimization of the styles output.",
+              "default": true
+            }
+          },
+          "additionalProperties": false
+        },
+        {
+          "type": "boolean"
+        }
+      ]
+    },
+    "generatePackageJson": {
+      "type": "boolean",
+      "description": "Generates a `package.json` and pruned lock file with the project's `node_module` dependencies populated for installing in a container. If a `package.json` exists in the project's directory, it will be reused with dependencies populated."
+    },
+    "transformers": {
+      "type": "array",
+      "description": "List of TypeScript Compiler Transfomers Plugins.",
+      "aliases": ["tsPlugins"],
+      "items": {
+        "$ref": "#/definitions/transformerPattern"
+      }
+    },
+    "additionalEntryPoints": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "entryName": {
+            "type": "string",
+            "description": "Name of the additional entry file."
+          },
+          "entryPath": {
+            "type": "string",
+            "description": "Path to the additional entry file.",
+            "x-completion-type": "file",
+            "x-completion-glob": "**/*@(.js|.ts)"
+          }
+        }
+      }
+    },
+    "outputFileName": {
+      "type": "string",
+      "description": "Name of the main output file.",
+      "default": "main.js"
+    },
+    "externalDependencies": {
+      "oneOf": [
+        {
+          "type": "string",
+          "enum": ["none", "all"]
+        },
+        {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      ],
+      "description": "Dependencies to keep external to the bundle. (`all` (default), `none`, or an array of module names)"
+    },
+    "extractCss": {
+      "type": "boolean",
+      "description": "Extract CSS into a `.css` file."
+    },
+    "subresourceIntegrity": {
+      "type": "boolean",
+      "description": "Enables the use of subresource integrity validation."
+    },
+    "polyfills": {
+      "type": "string",
+      "description": "Polyfills to load before application",
+      "x-completion-type": "file",
+      "x-completion-glob": "**/*@(.js|.ts|.tsx)"
+    },
+    "verbose": {
+      "type": "boolean",
+      "description": "Emits verbose output"
+    },
+    "statsJson": {
+      "type": "boolean",
+      "description": "Generates a 'stats.json' file which can be analyzed using tools such as: 'webpack-bundle-analyzer' or `<https://webpack.github.io/analyse>`."
+    },
+    "isolatedConfig": {
+      "type": "boolean",
+      "description": "Do not apply Nx webpack plugins automatically. Plugins need to be applied in the project's webpack.config.js file (e.g. withNx, withReact, etc.).",
+      "default": true,
+      "x-deprecated": "Automatic configuration of Webpack is deprecated in favor of an explicit 'webpack.config.js' file. This option will be removed in Nx 19. See https://nx.dev/recipes/webpack/webpack-config-setup."
+    },
+    "standardWebpackConfigFunction": {
+      "type": "boolean",
+      "description": "Set to true if the webpack config exports a standard webpack function, not an Nx-specific one. See: https://webpack.js.org/configuration/configuration-types/#exporting-a-function",
+      "default": false
+    },
+    "extractLicenses": {
+      "type": "boolean",
+      "description": "Extract all licenses in a separate file, in the case of production builds only."
+    },
+    "memoryLimit": {
+      "type": "number",
+      "description": "Memory limit for type checking service process in `MB`."
+    },
+    "fileReplacements": {
+      "description": "Replace files with other files in the build.",
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "replace": {
+            "type": "string",
+            "description": "The file to be replaced.",
+            "x-completion-type": "file"
+          },
+          "with": {
+            "type": "string",
+            "description": "The file to replace with.",
+            "x-completion-type": "file"
+          }
+        },
+        "additionalProperties": false,
+        "required": ["replace", "with"]
+      }
+    },
+    "buildLibsFromSource": {
+      "type": "boolean",
+      "description": "Read buildable libraries from source instead of building them separately. If set to `false`, the `tsConfig` option must also be set to remap paths.",
+      "default": true
+    },
+    "generateIndexHtml": {
+      "type": "boolean",
+      "description": "Generates `index.html` file to the output path. This can be turned off if using a webpack plugin to generate HTML such as `html-webpack-plugin`."
+    },
+    "postcssConfig": {
+      "type": "string",
+      "description": "Set a path to PostCSS config that applies to the app and all libs. Defaults to `undefined`, which auto-detects postcss.config.js files in each `app`/`lib` directory."
+    },
+    "webpackConfig": {
+      "type": "string",
+      "description": "Path to a function which takes a webpack config, some context and returns the resulting webpack config. See https://nx.dev/guides/customize-webpack",
+      "x-completion-type": "file",
+      "x-completion-glob": "webpack?(*)@(.js|.ts)",
+      "x-priority": "important"
+    },
+    "babelUpwardRootMode": {
+      "type": "boolean",
+      "description": "Whether to set rootmode to upward. See https://babeljs.io/docs/en/options#rootmode"
+    },
+    "babelConfig": {
+      "type": "string",
+      "description": "Path to the babel configuration file of your project. If not provided, Nx will default to the .babelrc file at the root of your project. See https://babeljs.io/docs/en/config-files",
+      "x-completion-type": "file"
+    }
+  },
+  "required": [],
+  "definitions": {
+    "assetPattern": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "glob": {
+              "type": "string",
+              "description": "The pattern to match."
+            },
+            "input": {
+              "type": "string",
+              "description": "The input directory path in which to apply 'glob'. Defaults to the project root."
+            },
+            "ignore": {
+              "description": "An array of globs to ignore.",
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "output": {
+              "type": "string",
+              "description": "Absolute path within the output."
+            }
+          },
+          "additionalProperties": false,
+          "required": ["glob", "input", "output"]
+        },
+        {
+          "type": "string"
+        }
+      ]
+    },
+    "extraEntryPoint": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "input": {
+              "type": "string",
+              "description": "The file to include.",
+              "x-completion-type": "file",
+              "x-completion-glob": "**/*@(.css|.scss|.less|.sass|.styl|.stylus)"
+            },
+            "bundleName": {
+              "type": "string",
+              "description": "The bundle name for this extra entry point."
+            },
+            "inject": {
+              "type": "boolean",
+              "description": "If the bundle will be referenced in the HTML file.",
+              "default": true
+            }
+          },
+          "additionalProperties": false,
+          "required": ["input"]
+        },
+        {
+          "type": "string",
+          "description": "The file to include.",
+          "x-completion-type": "file",
+          "x-completion-glob": "**/*@(.css|.scss|.less|.sass|.styl|.stylus)"
+        }
+      ]
+    },
+    "transformerPattern": {
+      "oneOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "name": {
+              "type": "string"
+            },
+            "options": {
+              "type": "object",
+              "additionalProperties": true
+            }
+          },
+          "additionalProperties": false,
+          "required": ["name"]
+        }
+      ]
+    }
+  },
+  "examplesFile": "../../../docs/webpack-build-executor-examples.md"
+}

package/src/executors/webpack/webpack.impl.d.ts

@@ -0,0 +1,13 @@
+import { ExecutorContext } from '@nx/devkit';
+import type { WebpackExecutorOptions } from './schema';
+export type WebpackExecutorEvent = {
+    success: false;
+    outfile?: string;
+    options?: WebpackExecutorOptions;
+} | {
+    success: true;
+    outfile: string;
+    options?: WebpackExecutorOptions;
+};
+export declare function webpackExecutor(_options: WebpackExecutorOptions, context: ExecutorContext): AsyncGenerator<WebpackExecutorEvent, WebpackExecutorEvent, undefined>;
+export default webpackExecutor;

package/src/executors/webpack/webpack.impl.js

@@ -0,0 +1,125 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.webpackExecutor = void 0;
+const devkit_1 = require("@nx/devkit");
+const rxjs_for_await_1 = require("@nx/devkit/src/utils/rxjs-for-await");
+const rxjs_1 = require("rxjs");
+const operators_1 = require("rxjs/operators");
+const path_1 = require("path");
+const buildable_libs_utils_1 = require("@nx/js/src/utils/buildable-libs-utils");
+const run_webpack_1 = require("./lib/run-webpack");
+const fs_1 = require("../../utils/fs");
+const resolve_user_defined_webpack_config_1 = require("../../utils/webpack/resolve-user-defined-webpack-config");
+const normalize_options_1 = require("./lib/normalize-options");
+const config_1 = require("../../utils/config");
+const with_nx_1 = require("../../utils/with-nx");
+const js_1 = require("@nx/js");
+const with_web_1 = require("../../utils/with-web");
+async function getWebpackConfigs(options, context) {
+    if (options.isolatedConfig && !options.webpackConfig) {
+        throw new Error(`Using "isolatedConfig" without a "webpackConfig" is not supported.`);
+    }
+    let userDefinedWebpackConfig = null;
+    if (options.webpackConfig) {
+        userDefinedWebpackConfig = (0, resolve_user_defined_webpack_config_1.resolveUserDefinedWebpackConfig)(options.webpackConfig, (0, js_1.getRootTsConfigPath)());
+        if (typeof userDefinedWebpackConfig.then === 'function') {
+            userDefinedWebpackConfig = await userDefinedWebpackConfig;
+        }
+    }
+    const config = options.isolatedConfig
+        ? {}
+        : (options.target === 'web'
+            ? (0, config_1.composePluginsSync)((0, with_nx_1.withNx)(options), (0, with_web_1.withWeb)(options))
+            : (0, with_nx_1.withNx)(options))({}, { options, context });
+    if (typeof userDefinedWebpackConfig === 'function' &&
+        ((0, config_1.isNxWebpackComposablePlugin)(userDefinedWebpackConfig) ||
+            !options.standardWebpackConfigFunction)) {
+        // Old behavior, call the Nx-specific webpack config function that user exports
+        return await userDefinedWebpackConfig(config, {
+            options,
+            context,
+            configuration: context.configurationName, // backwards compat
+        });
+    }
+    else if (userDefinedWebpackConfig) {
+        // New behavior, we want the webpack config to export object
+        return userDefinedWebpackConfig;
+    }
+    else {
+        // Fallback case, if we cannot find a webpack config path
+        return config;
+    }
+}
+async function* webpackExecutor(_options, context) {
+    // Default to production build.
+    process.env['NODE_ENV'] ||= 'production';
+    const metadata = context.projectsConfigurations.projects[context.projectName];
+    const sourceRoot = metadata.sourceRoot;
+    const options = (0, normalize_options_1.normalizeOptions)(_options, context.root, metadata.root, sourceRoot);
+    const isScriptOptimizeOn = typeof options.optimization === 'boolean'
+        ? options.optimization
+        : options.optimization && options.optimization.scripts
+            ? options.optimization.scripts
+            : false;
+    process.env.NODE_ENV ||= isScriptOptimizeOn
+        ? 'production'
+        : 'development';
+    process.env.NX_BUILD_LIBS_FROM_SOURCE = `${options.buildLibsFromSource}`;
+    process.env.NX_BUILD_TARGET = (0, devkit_1.targetToTargetString)({
+        project: context.projectName,
+        target: context.targetName,
+        configuration: context.configurationName,
+    });
+    if (options.compiler === 'swc') {
+        try {
+            require.resolve('swc-loader');
+            require.resolve('@swc/core');
+        }
+        catch {
+            devkit_1.logger.error(`Missing SWC dependencies: @swc/core, swc-loader. Make sure you install them first.`);
+            return {
+                success: false,
+                options,
+            };
+        }
+    }
+    if (!options.buildLibsFromSource && context.targetName) {
+        const { dependencies } = (0, buildable_libs_utils_1.calculateProjectBuildableDependencies)(context.taskGraph, context.projectGraph, context.root, context.projectName, context.targetName, context.configurationName);
+        options.tsConfig = (0, buildable_libs_utils_1.createTmpTsConfig)(options.tsConfig, context.root, metadata.root, dependencies);
+        process.env.NX_TSCONFIG_PATH = options.tsConfig;
+    }
+    // Delete output path before bundling
+    if (options.deleteOutputPath && options.outputPath) {
+        (0, fs_1.deleteOutputDir)(context.root, options.outputPath);
+    }
+    if (options.generatePackageJson && metadata.projectType !== 'application') {
+        devkit_1.logger.warn((0, devkit_1.stripIndents) `The project ${context.projectName} is using the 'generatePackageJson' option which is deprecated for library projects. It should only be used for applications.
+        For libraries, configure the project to use the '@nx/dependency-checks' ESLint rule instead (https://nx.dev/packages/eslint-plugin/documents/dependency-checks).`);
+    }
+    const configs = await getWebpackConfigs(options, context);
+    return yield* (0, rxjs_for_await_1.eachValueFrom)((0, rxjs_1.of)(configs).pipe((0, operators_1.mergeMap)((config) => (Array.isArray(config) ? (0, rxjs_1.from)(config) : (0, rxjs_1.of)(config))), 
+    // Run build sequentially and bail when first one fails.
+    (0, operators_1.mergeScan)((acc, config) => {
+        if (!acc.hasErrors()) {
+            return (0, run_webpack_1.runWebpack)(config).pipe((0, operators_1.tap)((stats) => {
+                console.info(stats.toString(config.stats));
+            }));
+        }
+        else {
+            return (0, rxjs_1.of)();
+        }
+    }, { hasErrors: () => false }, 1), 
+    // Collect build results as an array.
+    (0, operators_1.bufferCount)(Array.isArray(configs) ? configs.length : 1), (0, operators_1.switchMap)(async (results) => {
+        const success = results.every((result) => Boolean(result) && !result.hasErrors());
+        // TODO(jack): This should read output from webpack config if provided.
+        // The outfile is only used by NestJS, where `@nx/js:node` executor requires it to run the file.
+        return {
+            success,
+            outfile: (0, path_1.resolve)(context.root, options.outputPath, options.outputFileName),
+            options,
+        };
+    })));
+}
+exports.webpackExecutor = webpackExecutor;
+exports.default = webpackExecutor;

package/src/generators/configuration/configuration.d.ts

@@ -0,0 +1,5 @@
+import { GeneratorCallback, Tree } from '@nx/devkit';
+import { ConfigurationGeneratorSchema } from './schema';
+export declare function configurationGenerator(tree: Tree, options: ConfigurationGeneratorSchema): Promise<GeneratorCallback>;
+export declare function configurationGeneratorInternal(tree: Tree, options: ConfigurationGeneratorSchema): Promise<GeneratorCallback>;
+export default configurationGenerator;