@nx/esbuild 20.1.0-canary.20241026-f84b6e5 → 20.1.0-canary.20241029-4b70d1b

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/esbuild",
-  "version": "20.1.0-canary.20241026-f84b6e5",
+  "version": "20.1.0-canary.20241029-4b70d1b",
   "private": false,
   "description": "The Nx Plugin for esbuild contains executors and generators that support building applications using esbuild",
   "repository": {
@@ -31,8 +31,8 @@
     "migrations": "./migrations.json"
   },
   "dependencies": {
-    "@nx/devkit": "20.1.0-canary.20241026-f84b6e5",
-    "@nx/js": "20.1.0-canary.20241026-f84b6e5",
+    "@nx/devkit": "20.1.0-canary.20241029-4b70d1b",
+    "@nx/js": "20.1.0-canary.20241029-4b70d1b",
     "fast-glob": "3.2.7",
     "picocolors": "^1.1.0",
     "tsconfig-paths": "^4.1.2",

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

@@ -2,6 +2,6 @@ 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 getOutExtension(format: 'cjs' | 'esm', options: Pick<NormalizedEsBuildExecutorOptions, 'userDefinedBuildOptions'>): '.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;

package/src/executors/esbuild/lib/normalize.js

@@ -10,12 +10,12 @@ const pc = require("picocolors");
 function normalizeOptions(options, context) {
     const isTsSolutionSetup = (0, ts_solution_setup_1.isUsingTsSolutionSetup)();
     if (isTsSolutionSetup && options.generatePackageJson) {
-        throw new Error(`Setting 'generatePackageJson: true' is not allowed with the current TypeScript setup. Please update the 'package.json' file at the project root as needed and don't set the 'generatePackageJson' option.`);
+        throw new Error(`Setting 'generatePackageJson: true' is not supported with the current TypeScript setup. Update the 'package.json' file at the project root as needed and unset the 'generatePackageJson' option.`);
     }
     const tsConfig = (0, js_1.readTsConfig)(options.tsConfig);
     // If we're not generating package.json file, then copy it as-is as an asset when not using ts solution setup.
     const assets = options.generatePackageJson || isTsSolutionSetup
-        ? options.assets
+        ? options.assets ?? []
         : [
             ...options.assets,
             (0, devkit_1.joinPathFragments)(context.projectGraph.nodes[context.projectName].data.root, 'package.json'),

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

@@ -5,7 +5,7 @@ type Compiler = 'babel' | 'swc';
 
 export interface EsBuildExecutorOptions {
   additionalEntryPoints?: string[];
-  assets: (AssetGlob | string)[];
+  assets?: (AssetGlob | string)[];
   bundle?: boolean;
   declaration?: boolean;
   declarationRootDir?: string;
@@ -32,7 +32,8 @@ export interface EsBuildExecutorOptions {
 
 export interface NormalizedEsBuildExecutorOptions
   extends Omit<EsBuildExecutorOptions, 'esbuildOptions' | 'esbuildConfig'> {
+  assets: (AssetGlob | string)[];
   singleEntry: boolean;
   external: string[];
-  userDefinedBuildOptions: esbuild.BuildOptions;
+  userDefinedBuildOptions: esbuild.BuildOptions | undefined;
 }

package/src/generators/configuration/configuration.js

@@ -2,19 +2,24 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.configurationGenerator = configurationGenerator;
 const devkit_1 = require("@nx/devkit");
+const target_defaults_utils_1 = require("@nx/devkit/src/generators/target-defaults-utils");
+const js_1 = require("@nx/js");
 const get_import_path_1 = require("@nx/js/src/utils/get-import-path");
 const ts_solution_setup_1 = require("@nx/js/src/utils/typescript/ts-solution-setup");
+const posix_1 = require("node:path/posix");
+const devkit_internals_1 = require("nx/src/devkit-internals");
+const build_esbuild_options_1 = require("../../executors/esbuild/lib/build-esbuild-options");
 const init_1 = require("../init/init");
-const target_defaults_utils_1 = require("@nx/devkit/src/generators/target-defaults-utils");
 async function configurationGenerator(tree, options) {
-    (0, ts_solution_setup_1.assertNotUsingTsSolutionSetup)(tree, 'esbuild', 'configuration');
     const task = await (0, init_1.esbuildInitGenerator)(tree, {
         ...options,
         skipFormat: true,
     });
     options.buildTarget ??= 'build';
+    const isTsSolutionSetup = (0, ts_solution_setup_1.isUsingTsSolutionSetup)(tree);
     checkForTargetConflicts(tree, options);
-    addBuildTarget(tree, options);
+    addBuildTarget(tree, options, isTsSolutionSetup);
+    updatePackageJson(tree, options, isTsSolutionSetup);
     await (0, devkit_1.formatFiles)(tree);
     return task;
 }
@@ -26,40 +31,44 @@ function checkForTargetConflicts(tree, options) {
         throw new Error(`Project "${options.project}" already has a ${options.buildTarget} target. Pass --skipValidation to ignore this error.`);
     }
 }
-function addBuildTarget(tree, options) {
+function addBuildTarget(tree, options, isTsSolutionSetup) {
     (0, target_defaults_utils_1.addBuildTargetDefaults)(tree, '@nx/esbuild:esbuild', options.buildTarget);
     const project = (0, devkit_1.readProjectConfiguration)(tree, options.project);
-    const packageJsonPath = (0, devkit_1.joinPathFragments)(project.root, 'package.json');
-    if (!tree.exists(packageJsonPath)) {
-        const importPath = options.importPath || (0, get_import_path_1.getImportPath)(tree, options.project);
-        (0, devkit_1.writeJson)(tree, packageJsonPath, {
-            name: importPath,
-            version: '0.0.1',
-        });
-    }
     const prevBuildOptions = project.targets?.[options.buildTarget]?.options;
     const tsConfig = prevBuildOptions?.tsConfig ?? getTsConfigFile(tree, options);
+    let outputPath = prevBuildOptions?.outputPath;
+    if (!outputPath) {
+        outputPath = isTsSolutionSetup
+            ? (0, devkit_1.joinPathFragments)(project.root, 'dist')
+            : (0, devkit_1.joinPathFragments)('dist', project.root === '.' ? options.project : project.root);
+    }
     const buildOptions = {
         main: prevBuildOptions?.main ?? getMainFile(tree, options),
-        outputPath: prevBuildOptions?.outputPath ??
-            (0, devkit_1.joinPathFragments)('dist', project.root === '.' ? options.project : project.root),
+        outputPath,
         outputFileName: 'main.js',
         tsConfig,
-        assets: [],
         platform: options.platform,
+        format: options.format,
     };
-    if (options.platform === 'browser') {
-        buildOptions.outputHashing = 'all';
-        buildOptions.minify = true;
+    if (isTsSolutionSetup) {
+        buildOptions.declarationRootDir =
+            project.sourceRoot ?? tree.exists(`${project.root}/src`)
+                ? `${project.root}/src`
+                : project.root;
     }
-    if (tree.exists((0, devkit_1.joinPathFragments)(project.root, 'README.md'))) {
-        buildOptions.assets = [
-            {
+    else {
+        buildOptions.assets = [];
+        if (tree.exists((0, devkit_1.joinPathFragments)(project.root, 'README.md'))) {
+            buildOptions.assets.push({
                 glob: `${project.root}/README.md`,
                 input: '.',
                 output: '.',
-            },
-        ];
+            });
+        }
+    }
+    if (options.platform === 'browser') {
+        buildOptions.outputHashing = 'all';
+        buildOptions.minify = true;
     }
     (0, devkit_1.updateProjectConfiguration)(tree, options.project, {
         ...project,
@@ -82,6 +91,69 @@ function addBuildTarget(tree, options) {
         },
     });
 }
+function updatePackageJson(tree, options, isTsSolutionSetup) {
+    const project = (0, devkit_1.readProjectConfiguration)(tree, options.project);
+    const packageJsonPath = (0, posix_1.join)(project.root, 'package.json');
+    let packageJson;
+    if (tree.exists(packageJsonPath)) {
+        if (!isTsSolutionSetup) {
+            return;
+        }
+        packageJson = (0, devkit_1.readJson)(tree, packageJsonPath);
+    }
+    else {
+        packageJson = {
+            name: (0, get_import_path_1.getImportPath)(tree, options.project),
+            version: '0.0.1',
+        };
+    }
+    if (isTsSolutionSetup) {
+        const nxJson = (0, devkit_1.readNxJson)(tree);
+        const projectTarget = project.targets[options.buildTarget];
+        const mergedTarget = (0, devkit_internals_1.mergeTargetConfigurations)(projectTarget, (projectTarget.executor
+            ? nxJson.targetDefaults?.[projectTarget.executor]
+            : undefined) ?? nxJson.targetDefaults?.[options.buildTarget]);
+        const { declarationRootDir = '.', main, outputPath, outputFileName, 
+        // the executor option defaults to [esm]
+        format = ['esm'], esbuildOptions, } = mergedTarget.options;
+        // can't use the declarationRootDir as rootDir because it only affects the typings,
+        // not the runtime entry point
+        packageJson = (0, js_1.getUpdatedPackageJsonContent)(packageJson, {
+            main,
+            outputPath,
+            projectRoot: project.root,
+            generateExportsField: true,
+            packageJsonPath,
+            format,
+            outputFileName,
+            outputFileExtensionForCjs: (0, build_esbuild_options_1.getOutExtension)('cjs', {
+                // there's very little chance that the user would have defined a custom esbuild config
+                // since that's an Nx specific file that we're not generating here and we're setting up
+                // the build for esbuild now
+                userDefinedBuildOptions: esbuildOptions,
+            }),
+            outputFileExtensionForEsm: (0, build_esbuild_options_1.getOutExtension)('esm', {
+                userDefinedBuildOptions: esbuildOptions,
+            }),
+        });
+        if (declarationRootDir !== (0, posix_1.dirname)(main)) {
+            // the declaration file entry point will be output to a location
+            // different than the runtime entry point, adjust accodingly
+            const outputDir = (0, js_1.getOutputDir)({
+                main,
+                outputPath,
+                projectRoot: project.root,
+                packageJsonPath,
+                rootDir: declarationRootDir,
+            });
+            const mainFile = (0, posix_1.basename)(options.main).replace(/\.[tj]s$/, '');
+            const typingsFile = `${outputDir}${mainFile}.d.ts`;
+            packageJson.types = typingsFile;
+            packageJson.exports['.'].types = typingsFile;
+        }
+    }
+    (0, devkit_1.writeJson)(tree, packageJsonPath, packageJson);
+}
 function getMainFile(tree, options) {
     const project = (0, devkit_1.readProjectConfiguration)(tree, options.project);
     const candidates = [

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

@@ -1,3 +1,5 @@
+import type { SupportedFormat } from '@nx/js';
+
 export interface EsBuildProjectSchema {
   project: string;
   main?: string;
@@ -10,4 +12,5 @@ export interface EsBuildProjectSchema {
   esbuildConfig?: string;
   platform?: 'node' | 'browser' | 'neutral';
   buildTarget?: string;
+  format?: SupportedFormat[];
 }

package/src/generators/configuration/schema.json

@@ -60,6 +60,15 @@
       "description": "The build target to add.",
       "type": "string",
       "default": "build"
+    },
+    "format": {
+      "description": "The format to build the library (esm or cjs).",
+      "type": "array",
+      "items": {
+        "type": "string",
+        "enum": ["esm", "cjs"]
+      },
+      "default": ["esm"]
     }
   },
   "required": [],

package/src/generators/init/init.js

@@ -2,11 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.esbuildInitGenerator = esbuildInitGenerator;
 const devkit_1 = require("@nx/devkit");
-const ts_solution_setup_1 = require("@nx/js/src/utils/typescript/ts-solution-setup");
 const versions_1 = require("@nx/js/src/utils/versions");
 const versions_2 = require("../../utils/versions");
 async function esbuildInitGenerator(tree, schema) {
-    (0, ts_solution_setup_1.assertNotUsingTsSolutionSetup)(tree, 'esbuild', 'init');
     let installTask = () => { };
     if (!schema.skipPackageJson) {
         installTask = (0, devkit_1.addDependenciesToPackageJson)(tree, {}, {