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

package/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2017-2023 Narwhal Technologies Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,68 @@
+<p style="text-align: center;">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-dark.svg">
+    <img alt="Nx - Smart Monorepos · Fast CI" src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-light.svg" width="100%">
+  </picture>
+</p>
+
+<div style="text-align: center;">
+
+[![CircleCI](https://circleci.com/gh/nrwl/nx.svg?style=svg)](https://circleci.com/gh/nrwl/nx)
+[![License](https://img.shields.io/npm/l/@nx/workspace.svg?style=flat-square)]()
+[![NPM Version](https://badge.fury.io/js/%40nrwl%2Fworkspace.svg)](https://www.npmjs.com/@nx/workspace)
+[![Semantic Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)]()
+[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
+[![Join the chat at https://gitter.im/nrwl-nx/community](https://badges.gitter.im/nrwl-nx/community.svg)](https://gitter.im/nrwl-nx/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![Join us on the Official Nx Discord Server](https://img.shields.io/discord/1143497901675401286?label=discord)](https://go.nx.dev/community)
+
+</div>
+
+
+<hr>
+
+# Nx: Smart Monorepos · Fast CI
+
+Nx is a build system with built-in tooling and advanced CI capabilities. It helps you maintain and scale monorepos, both locally and on CI.
+
+This package is a [EsBuild plugin for Nx](https://nx.dev/packages/esbuild).
+
+## Getting Started
+
+### Creating an Nx Workspace
+
+**Using `npx`**
+
+```bash
+npx create-nx-workspace
+```
+
+**Using `npm init`**
+
+```bash
+npm init nx-workspace
+```
+
+**Using `yarn create`**
+
+```bash
+yarn create nx-workspace
+```
+
+### Adding Nx to an Existing Repository
+
+Run:
+
+```bash
+npx nx@latest init
+```
+
+## Documentation & Resources
+
+- [Nx.Dev: Documentation, Guides, Tutorials](https://nx.dev)
+- [Intro to Nx](https://nx.dev/getting-started/intro)
+- [Official Nx YouTube Channel](https://www.youtube.com/@NxDevtools)
+- [Blog Posts About Nx](https://blog.nrwl.io/nx/home)
+
+<p style="text-align: center;"><a href="https://nx.dev/#learning-materials" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-courses-and-videos.svg" 
+width="100%" alt="Nx - Smart Monorepos · Fast CI"></a></p>
+

package/executors.json

@@ -0,0 +1,9 @@
+{
+  "executors": {
+    "esbuild": {
+      "implementation": "./src/executors/esbuild/esbuild.impl",
+      "schema": "./src/executors/esbuild/schema.json",
+      "description": "Bundle a package using EsBuild."
+    }
+  }
+}

package/generators.json

@@ -0,0 +1,19 @@
+{
+  "name": "Nx esbuild",
+  "version": "0.1",
+  "generators": {
+    "init": {
+      "factory": "./src/generators/init/init#esbuildInitGenerator",
+      "schema": "./src/generators/init/schema.json",
+      "description": "Initialize the `@nrwl/esbuild` plugin.",
+      "aliases": ["ng-add"],
+      "hidden": true
+    },
+    "configuration": {
+      "aliases": ["esbuild-project"],
+      "factory": "./src/generators/configuration/configuration",
+      "schema": "./src/generators/configuration/schema.json",
+      "description": "Add esbuild configuration to a project."
+    }
+  }
+}

package/index.d.ts

@@ -0,0 +1,4 @@
+import { configurationGenerator } from './src/generators/configuration/configuration';
+export { configurationGenerator };
+export * from './src/generators/init/init';
+export * from './src/utils/versions';

package/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configurationGenerator = void 0;
+const tslib_1 = require("tslib");
+const configuration_1 = require("./src/generators/configuration/configuration");
+Object.defineProperty(exports, "configurationGenerator", { enumerable: true, get: function () { return configuration_1.configurationGenerator; } });
+// Exported for backwards compatibility in case a plugin is using the old name.
+/** @deprecated Use `configurationGenerator` instead. */
+const esbuildProjectGenerator = configuration_1.configurationGenerator;
+tslib_1.__exportStar(require("./src/generators/init/init"), exports);
+tslib_1.__exportStar(require("./src/utils/versions"), exports);

package/migrations.json

@@ -0,0 +1,51 @@
+{
+  "generators": {
+    "set-generate-package-json": {
+      "cli": "nx",
+      "version": "15.8.7-beta.0",
+      "description": "Set generatePackageJson to true to maintain existing behavior of generating package.json in output path.",
+      "factory": "./src/migrations/update-15-8-7/set-generate-package-json"
+    },
+    "update-16-0-0-add-nx-packages": {
+      "cli": "nx",
+      "version": "16.0.0-beta.1",
+      "description": "Replace @nrwl/esbuild with @nx/esbuild",
+      "implementation": "./src/migrations/update-16-0-0-add-nx-packages/update-16-0-0-add-nx-packages"
+    },
+    "update-16-0-1-set-thirdparty-true": {
+      "version": "16.0.1-beta.0",
+      "description": "Set thirdParty to true to maintain the existing behavior of bundling dependencies.",
+      "cli": "nx",
+      "implementation": "./src/migrations/update-16-0-1-set-thirdparty-true/update-16-0-1-set-thirdparty-true"
+    }
+  },
+  "packageJsonUpdates": {
+    "15.7.0": {
+      "version": "15.7.0-beta.0",
+      "packages": {
+        "esbuild": {
+          "version": "0.17.5",
+          "alwaysAddToPackageJson": false
+        }
+      }
+    },
+    "16.0.0": {
+      "version": "16.0.0-beta.5",
+      "packages": {
+        "esbuild": {
+          "version": "0.17.17",
+          "alwaysAddToPackageJson": false
+        }
+      }
+    },
+    "16.8.0": {
+      "version": "16.8.0-beta.2",
+      "packages": {
+        "esbuild": {
+          "version": "^0.19.2",
+          "alwaysAddToPackageJson": false
+        }
+      }
+    }
+  }
+}

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@nx/esbuild",
+  "version": "0.0.0-pr-22179-271588f",
+  "private": false,
+  "description": "The Nx Plugin for esbuild contains executors and generators that support building applications using esbuild",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/nrwl/nx.git",
+    "directory": "packages/esbuild"
+  },
+  "keywords": [
+    "Monorepo",
+    "EsBuild",
+    "Web",
+    "CLI"
+  ],
+  "main": "./index.js",
+  "typings": "./index.d.ts",
+  "author": "Victor Savkin",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/nrwl/nx/issues"
+  },
+  "homepage": "https://nx.dev",
+  "generators": "./generators.json",
+  "executors": "./executors.json",
+  "ng-update": {
+    "requirements": {},
+    "migrations": "./migrations.json"
+  },
+  "dependencies": {
+    "chalk": "^4.1.0",
+    "fast-glob": "3.2.7",
+    "fs-extra": "^11.1.0",
+    "tslib": "^2.3.0",
+    "tsconfig-paths": "^4.1.2",
+    "@nx/devkit": "0.0.0-pr-22179-271588f",
+    "@nx/js": "0.0.0-pr-22179-271588f",
+    "@nrwl/esbuild": "0.0.0-pr-22179-271588f"
+  },
+  "peerDependencies": {
+    "esbuild": "~0.19.2"
+  },
+  "peerDependenciesMeta": {
+    "esbuild": {
+      "optional": true
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "commonjs"
+}

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

@@ -0,0 +1,7 @@
+import type { ExecutorContext } from '@nx/devkit';
+import { EsBuildExecutorOptions } from './schema';
+export declare function esbuildExecutor(_options: EsBuildExecutorOptions, context: ExecutorContext): AsyncGenerator<{
+    success: boolean;
+    outfile?: string;
+}, any, undefined>;
+export default esbuildExecutor;

package/src/executors/esbuild/esbuild.impl.js

@@ -0,0 +1,181 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.esbuildExecutor = void 0;
+const chalk = require("chalk");
+const devkit_1 = require("@nx/devkit");
+const js_1 = require("@nx/js");
+const esbuild = require("esbuild");
+const normalize_1 = require("./lib/normalize");
+const fs_extra_1 = require("fs-extra");
+const async_iterable_1 = require("@nx/devkit/src/utils/async-iterable");
+const build_esbuild_options_1 = require("./lib/build-esbuild-options");
+const get_extra_dependencies_1 = require("./lib/get-extra-dependencies");
+const path_1 = require("path");
+const BUILD_WATCH_FAILED = `[ ${chalk.red('watch')} ] build finished with errors (see above), watching for changes...`;
+const BUILD_WATCH_SUCCEEDED = `[ ${chalk.green('watch')} ] build succeeded, watching for changes...`;
+async function* esbuildExecutor(_options, context) {
+    process.env.NODE_ENV ??= context.configurationName ?? 'production';
+    const options = (0, normalize_1.normalizeOptions)(_options, context);
+    if (options.deleteOutputPath)
+        (0, fs_extra_1.removeSync)(options.outputPath);
+    const assetsResult = await (0, js_1.copyAssets)(options, context);
+    const externalDependencies = options.external.reduce((acc, name) => {
+        const externalNode = context.projectGraph.externalNodes[`npm:${name}`];
+        if (externalNode) {
+            acc.push({
+                name,
+                outputs: [],
+                node: externalNode,
+            });
+        }
+        return acc;
+    }, []);
+    if (!options.thirdParty) {
+        const thirdPartyDependencies = (0, get_extra_dependencies_1.getExtraDependencies)(context.projectName, context.projectGraph);
+        for (const tpd of thirdPartyDependencies) {
+            options.external.push(tpd.node.data.packageName);
+            externalDependencies.push(tpd);
+        }
+    }
+    let packageJsonResult;
+    if (options.generatePackageJson) {
+        if (context.projectGraph.nodes[context.projectName].type !== 'app') {
+            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 cpjOptions = {
+            ...options,
+            // TODO(jack): make types generate with esbuild
+            skipTypings: true,
+            generateLockfile: true,
+            outputFileExtensionForCjs: (0, build_esbuild_options_1.getOutExtension)('cjs', options),
+            excludeLibsInPackageJson: !options.thirdParty,
+            // TODO(jack): Remove the need to pass updateBuildableProjectDepsInPackageJson option when overrideDependencies or extraDependencies are passed.
+            // Add this back to fix a regression.
+            // See: https://github.com/nrwl/nx/issues/19773
+            updateBuildableProjectDepsInPackageJson: externalDependencies.length > 0,
+        };
+        // If we're bundling third-party packages, then any extra deps from external should be the only deps in package.json
+        if (options.thirdParty && externalDependencies.length > 0) {
+            cpjOptions.overrideDependencies = externalDependencies;
+        }
+        else {
+            cpjOptions.extraDependencies = externalDependencies;
+        }
+        packageJsonResult = await (0, js_1.copyPackageJson)(cpjOptions, context);
+    }
+    if (options.watch) {
+        return yield* (0, async_iterable_1.createAsyncIterable)(async ({ next, done }) => {
+            let hasTypeErrors = false;
+            const disposeFns = await Promise.all(options.format.map(async (format, idx) => {
+                const esbuildOptions = (0, build_esbuild_options_1.buildEsbuildOptions)(format, options, context);
+                const ctx = await esbuild.context({
+                    ...esbuildOptions,
+                    plugins: [
+                        // Only emit info on one of the watch processes.
+                        idx === 0
+                            ? {
+                                name: 'nx-watch-plugin',
+                                setup(build) {
+                                    build.onEnd(async (result) => {
+                                        if (!options.skipTypeCheck) {
+                                            const { errors } = await runTypeCheck(options, context);
+                                            hasTypeErrors = errors.length > 0;
+                                        }
+                                        const success = result.errors.length === 0 && !hasTypeErrors;
+                                        if (!success) {
+                                            devkit_1.logger.info(BUILD_WATCH_FAILED);
+                                        }
+                                        else {
+                                            devkit_1.logger.info(BUILD_WATCH_SUCCEEDED);
+                                        }
+                                        next({
+                                            success,
+                                            // Need to call getOutfile directly in the case of bundle=false and outfile is not set for esbuild.
+                                            outfile: (0, path_1.join)(context.root, (0, build_esbuild_options_1.getOutfile)(format, options, context)),
+                                        });
+                                    });
+                                },
+                            }
+                            : null,
+                        ...(esbuildOptions?.plugins || []),
+                    ].filter(Boolean),
+                });
+                await ctx.watch();
+                return () => ctx.dispose();
+            }));
+            registerCleanupCallback(() => {
+                assetsResult?.stop();
+                packageJsonResult?.stop();
+                disposeFns.forEach((fn) => fn());
+                done(); // return from async iterable
+            });
+        });
+    }
+    else {
+        // Run type-checks first and bail if they don't pass.
+        if (!options.skipTypeCheck) {
+            const { errors } = await runTypeCheck(options, context);
+            if (errors.length > 0) {
+                yield { success: false };
+                return;
+            }
+        }
+        // Emit a build event for each file format.
+        for (let i = 0; i < options.format.length; i++) {
+            const format = options.format[i];
+            const esbuildOptions = (0, build_esbuild_options_1.buildEsbuildOptions)(format, options, context);
+            const buildResult = await esbuild.build(esbuildOptions);
+            if (options.metafile) {
+                const filename = options.format.length === 1
+                    ? 'meta.json'
+                    : `meta.${options.format[i]}.json`;
+                (0, fs_extra_1.writeJsonSync)((0, devkit_1.joinPathFragments)(options.outputPath, filename), buildResult.metafile);
+            }
+            yield {
+                success: buildResult.errors.length === 0,
+                // Need to call getOutfile directly in the case of bundle=false and outfile is not set for esbuild.
+                // This field is needed for `@nx/js:node` executor to work.
+                outfile: (0, path_1.join)(context.root, (0, build_esbuild_options_1.getOutfile)(format, options, context)),
+            };
+        }
+    }
+}
+exports.esbuildExecutor = esbuildExecutor;
+function getTypeCheckOptions(options, context) {
+    const { watch, tsConfig, outputPath } = options;
+    const typeCheckOptions = {
+        // TODO(jack): Add support for d.ts declaration files -- once the `@nx/js:tsc` changes are in we can use the same logic.
+        mode: 'noEmit',
+        tsConfigPath: tsConfig,
+        // outDir: outputPath,
+        workspaceRoot: context.root,
+        rootDir: context.root,
+    };
+    if (watch) {
+        typeCheckOptions.incremental = true;
+        typeCheckOptions.cacheDir = devkit_1.cacheDir;
+    }
+    return typeCheckOptions;
+}
+async function runTypeCheck(options, context) {
+    const { errors, warnings } = await (0, js_1.runTypeCheck)(getTypeCheckOptions(options, context));
+    const hasErrors = errors.length > 0;
+    const hasWarnings = warnings.length > 0;
+    if (hasErrors || hasWarnings) {
+        await (0, js_1.printDiagnostics)(errors, warnings);
+    }
+    return { errors, warnings };
+}
+function registerCleanupCallback(callback) {
+    const wrapped = () => {
+        callback();
+        process.off('SIGINT', wrapped);
+        process.off('SIGTERM', wrapped);
+        process.off('exit', wrapped);
+    };
+    process.on('SIGINT', wrapped);
+    process.on('SIGTERM', wrapped);
+    process.on('exit', wrapped);
+}
+exports.default = esbuildExecutor;

package/src/executors/esbuild/lib/build-esbuild-options.d.ts

@@ -0,0 +1,7 @@
+import * as esbuild from 'esbuild';
+import { ExecutorContext, ProjectGraphProjectNode } from '@nx/devkit';
+import { NormalizedEsBuildExecutorOptions } from '../schema';
+export declare function buildEsbuildOptions(format: 'cjs' | 'esm', options: NormalizedEsBuildExecutorOptions, context: ExecutorContext): esbuild.BuildOptions;
+export declare function getOutExtension(format: 'cjs' | 'esm', options: NormalizedEsBuildExecutorOptions): '.cjs' | '.mjs' | '.js';
+export declare function getOutfile(format: 'cjs' | 'esm', options: NormalizedEsBuildExecutorOptions, context: ExecutorContext): string;
+export declare function getRegisterFileContent(project: ProjectGraphProjectNode, paths: Record<string, string[]>, mainFile: string, outExtension?: string): string;