@storm-software/esbuild 0.37.0 → 0.38.0

package/README.md

@@ -21,7 +21,7 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages
 
 <h3 align="center">💻 Visit <a href="https://stormsoftware.com" target="_blank">stormsoftware.com</a> to stay up to date with this developer</h3><br />
 
-[![Version](https://img.shields.io/badge/version-0.36.5-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with Fumadocs](https://img.shields.io/badge/documented_with-fumadocs-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://fumadocs.vercel.app/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-ops/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
+[![Version](https://img.shields.io/badge/version-0.37.1-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with Fumadocs](https://img.shields.io/badge/documented_with-fumadocs-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://fumadocs.vercel.app/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-ops/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
 
 <!-- prettier-ignore-start -->
 <!-- markdownlint-disable -->
@@ -40,6 +40,7 @@ This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages
 
 <!-- START doctoc -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
 ## Table of Contents
 
 - [Storm ESBuild Package](#storm-esbuild-package)

package/bin/esbuild.ts

@@ -0,0 +1,297 @@
+#!/usr/bin/env node
+
+import type { StormWorkspaceConfig } from "@storm-software/config";
+import { getConfig } from "@storm-software/config-tools/get-config";
+import {
+  getStopwatch,
+  writeFatal,
+  writeInfo,
+  writeSuccess
+} from "@storm-software/config-tools/logger/console";
+import { findWorkspaceRootSafe } from "@storm-software/config-tools/utilities/find-workspace-root";
+import {
+  exitWithError,
+  exitWithSuccess,
+  handleProcess
+} from "@storm-software/config-tools/utilities/process-handler";
+import { Command, Option } from "commander";
+import { Format } from "esbuild";
+import { build } from "../src/build";
+import { clean } from "../src/clean";
+import { ESBuildCLIOptions } from "../src/types";
+
+async function createProgram(config: StormWorkspaceConfig) {
+  try {
+    writeInfo("⚡ Running Storm ESBuild pipeline", config);
+
+    const root = findWorkspaceRootSafe();
+    process.env.STORM_WORKSPACE_ROOT ??= root;
+    process.env.NX_WORKSPACE_ROOT_PATH ??= root;
+    if (root) {
+      process.chdir(root);
+    }
+
+    const program = new Command("storm-esbuild");
+    program.version("1.0.0", "-v --version", "display CLI version");
+
+    program
+      .description("⚡ Run the Storm ESBuild pipeline")
+      .showHelpAfterError()
+      .showSuggestionAfterError();
+
+    const projectRootOption = new Option(
+      "-p --project-root <path>",
+      "The path to the root of the project to build. This path is defined relative to the workspace root."
+    ).makeOptionMandatory(true);
+
+    const sourceRootOption = new Option(
+      "-s --source-root <path>",
+      "The path of the project's source folder to build"
+    );
+
+    const nameOption = new Option(
+      "-n --name <value>",
+      "The name of the project to build"
+    );
+
+    const outputPathOption = new Option(
+      "-o --output-path <path>",
+      "The path of the project's source folder to build"
+    ).default("dist/{projectRoot}");
+
+    const platformOption = new Option(
+      "-p --platform <value>",
+      "The platform to build the distribution for"
+    )
+      .choices(["node", "neutral", "browser"])
+      .default("node");
+
+    const formatOption = new Option(
+      "-f, --format <value...>",
+      "The format to build the distribution in"
+    )
+      .choices(["esm", "cjs", "iife"])
+      .argParser<string[]>((value: string, previous: string[]) => {
+        if (previous === undefined) {
+          return [value];
+        } else if (!previous.includes(value)) {
+          previous.push(value);
+        }
+
+        return previous;
+      })
+      .default("esm");
+
+    const cleanOption = new Option(
+      "-c --clean",
+      "Should the output directory be cleaned before building"
+    ).default(true);
+
+    const noCleanOption = new Option(
+      "--no-clean",
+      "Should the output directory be cleaned before building"
+    ).default(false);
+
+    const bundleOption = new Option(
+      "-b --bundle",
+      "Should the output be bundled"
+    ).default(true);
+
+    const noBundleOption = new Option(
+      "--no-bundle",
+      "Should the output be bundled"
+    ).default(false);
+
+    const targetOption = new Option(
+      "-t --target <value>",
+      "The target to build the distribution for"
+    )
+      .choices([
+        "ESNext",
+        "ES2015",
+        "ES2016",
+        "ES2017",
+        "ES2018",
+        "ES2019",
+        "ES2020",
+        "ES2021",
+        "ES2022",
+        "ES2023"
+      ])
+      .default("ESNext");
+
+    const watchOption = new Option(
+      "-w --watch",
+      "Should the build process watch for changes"
+    ).default(false);
+
+    const modeOption = new Option(
+      "-m --mode",
+      "What mode should the build process run in"
+    ).default("production");
+
+    const bannerOption = new Option(
+      "--banner <value>",
+      "The banner to prepend to the output"
+    );
+
+    const footerOption = new Option(
+      "--footer <value>",
+      "The footer to prepend to the output"
+    );
+
+    const splittingOption = new Option(
+      "--splitting",
+      "Should the output be split into multiple files"
+    ).default(true);
+
+    const treeShakingOption = new Option(
+      "--treeshake",
+      "Should tree shaking be enabled"
+    ).default(true);
+
+    const generatePackageJsonOption = new Option(
+      "--generate-package-json",
+      "Should a package.json be generated for the output"
+    ).default(true);
+
+    // const emitOnAllOption = new Option(
+    //   "--emit-on-all",
+    //   "Should the output be emitted on all platforms"
+    // ).default(false);
+
+    const metafileOption = new Option(
+      "--metafile",
+      "Should a metafile be generated for the output"
+    ).default(true);
+
+    const minifyOption = new Option(
+      "--minify",
+      "Should the output be minified"
+    ).default(true);
+
+    const includeSrcOption = new Option(
+      "--include-src",
+      "Should the source files be included in the output"
+    ).default(false);
+
+    const injectShimsOption = new Option(
+      "--shims",
+      "Should shims be injected into the output"
+    ).default(true);
+
+    const dtsOption = new Option(
+      "--dts",
+      "Should typescript type declarations be emitted for the output"
+    ).default(true);
+
+    program
+      .command("build", { isDefault: true })
+      .alias("bundle")
+      .description(
+        "Run a TypeScript build using ESBuild, API-Extractor, and TSC (for type generation)."
+      )
+      .addOption(nameOption)
+      .addOption(projectRootOption)
+      .addOption(sourceRootOption)
+      .addOption(outputPathOption)
+      .addOption(platformOption)
+      .addOption(formatOption)
+      .addOption(targetOption)
+      .addOption(bundleOption)
+      .addOption(noBundleOption)
+      .addOption(cleanOption)
+      .addOption(noCleanOption)
+      .addOption(watchOption)
+      .addOption(modeOption)
+      .addOption(bannerOption)
+      .addOption(footerOption)
+      .addOption(splittingOption)
+      .addOption(treeShakingOption)
+      .addOption(generatePackageJsonOption)
+      .addOption(metafileOption)
+      .addOption(minifyOption)
+      .addOption(includeSrcOption)
+      .addOption(injectShimsOption)
+      .addOption(dtsOption)
+      .action(buildAction(config));
+
+    program
+      .command("clean")
+      .alias("clear")
+      .description(
+        "Clean the output directory of the project. This command will remove the 'dist' folder."
+      )
+      .addOption(nameOption)
+      .action(cleanAction(config));
+
+    return program;
+  } catch (e) {
+    writeFatal(
+      `A fatal error occurred while running the program: ${e.message}`,
+      config
+    );
+    process.exit(1);
+  }
+}
+
+const buildAction =
+  (config: StormWorkspaceConfig) => async (options: ESBuildCLIOptions) => {
+    try {
+      await build({
+        ...options,
+        format: options.format as Format
+      });
+    } catch (e) {
+      writeFatal(
+        `A fatal error occurred while cleaning the ESBuild output directory: ${e.message}`,
+        config
+      );
+
+      exitWithError(config);
+      process.exit(1);
+    }
+  };
+
+const cleanAction =
+  (config: StormWorkspaceConfig) =>
+  async (options: { output: string; name?: string }) => {
+    try {
+      await clean(options.name, options.output, config);
+    } catch (e) {
+      writeFatal(
+        `A fatal error occurred while cleaning the ESBuild output directory: ${e.message}`,
+        config
+      );
+
+      exitWithError(config);
+      process.exit(1);
+    }
+  };
+
+void (async () => {
+  const config = await getConfig();
+  const stopwatch = getStopwatch("Storm ESBuild executable");
+
+  try {
+    handleProcess(config);
+
+    const program = await createProgram(config);
+    await program.parseAsync(process.argv);
+
+    writeSuccess(
+      `🎉  Storm ESBuild executable has completed successfully!`,
+      config
+    );
+    exitWithSuccess(config);
+  } catch (error) {
+    writeFatal(
+      `A fatal error occurred while running Storm ESBuild executable: \n\n${error.message}`,
+      config
+    );
+    exitWithError(config);
+    process.exit(1);
+  } finally {
+    stopwatch();
+  }
+})();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storm-software/esbuild",
-  "version": "0.37.0",
+  "version": "0.38.0",
   "type": "module",
   "description": "A package containing `esbuild` utilities for building Storm Software libraries and applications",
   "repository": {
@@ -239,9 +239,9 @@
   "dependencies": {
     "@nx/devkit": "20.8.0",
     "@nx/js": "20.8.0",
-    "@storm-software/build-tools": "0.146.0",
-    "@storm-software/config": "1.115.0",
-    "@storm-software/config-tools": "1.165.0",
+    "@storm-software/build-tools": "0.147.0",
+    "@storm-software/config": "1.116.0",
+    "@storm-software/config-tools": "1.166.0",
     "chokidar": "^4.0.3",
     "commander": "^12.1.0",
     "defu": "6.1.4",

package/dist/chunk-BYH4XDRH.cjs

@@ -1,6 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});// package.json
-var version = "8.4.0";
-
-
-
-exports.version = version;

package/dist/chunk-GZSSIGNC.cjs

@@ -1,153 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } else { var newObj = {}; if (obj != null) { for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { newObj[key] = obj[key]; } } } newObj.default = obj; return newObj; } }
-
-var _chunkBYH4XDRHjs = require('./chunk-BYH4XDRH.cjs');
-
-
-var _chunkTWFEYLU4js = require('./chunk-TWFEYLU4.cjs');
-
-// src/cli-main.ts
-var _cac = require('cac');
-
-// node_modules/.pnpm/flat@6.0.1/node_modules/flat/index.js
-function isBuffer(obj) {
-  return obj && obj.constructor && typeof obj.constructor.isBuffer === "function" && obj.constructor.isBuffer(obj);
-}
-function keyIdentity(key) {
-  return key;
-}
-function flatten(target, opts) {
-  opts = opts || {};
-  const delimiter = opts.delimiter || ".";
-  const maxDepth = opts.maxDepth;
-  const transformKey = opts.transformKey || keyIdentity;
-  const output = {};
-  function step(object, prev, currentDepth) {
-    currentDepth = currentDepth || 1;
-    Object.keys(object).forEach(function(key) {
-      const value = object[key];
-      const isarray = opts.safe && Array.isArray(value);
-      const type = Object.prototype.toString.call(value);
-      const isbuffer = isBuffer(value);
-      const isobject = type === "[object Object]" || type === "[object Array]";
-      const newKey = prev ? prev + delimiter + transformKey(key) : transformKey(key);
-      if (!isarray && !isbuffer && isobject && Object.keys(value).length && (!opts.maxDepth || currentDepth < maxDepth)) {
-        return step(value, newKey, currentDepth + 1);
-      }
-      output[newKey] = value;
-    });
-  }
-  step(target);
-  return output;
-}
-
-// src/cli-main.ts
-function ensureArray(input) {
-  return Array.isArray(input) ? input : input.split(",");
-}
-async function main(options = {}) {
-  const cli = _cac.cac.call(void 0, "tsup");
-  cli.command("[...files]", "Bundle files", {
-    ignoreOptionDefaultValue: true
-  }).option("--entry.* <file>", "Use a key-value pair as entry files").option("-d, --out-dir <dir>", "Output directory", { default: "dist" }).option("--format <format>", 'Bundle format, "cjs", "iife", "esm"', {
-    default: "cjs"
-  }).option("--minify [terser]", "Minify bundle").option("--minify-whitespace", "Minify whitespace").option("--minify-identifiers", "Minify identifiers").option("--minify-syntax", "Minify syntax").option(
-    "--keep-names",
-    "Keep original function and class names in minified code"
-  ).option("--target <target>", 'Bundle target, "es20XX" or "esnext"', {
-    default: "es2017"
-  }).option(
-    "--legacy-output",
-    "Output different formats to different folder instead of using different extensions"
-  ).option("--dts [entry]", "Generate declaration file").option("--dts-resolve", "Resolve externals types used for d.ts files").option("--dts-only", "Emit declaration files only").option(
-    "--experimental-dts [entry]",
-    "Generate declaration file (experimental)"
-  ).option(
-    "--sourcemap [inline]",
-    "Generate external sourcemap, or inline source: --sourcemap inline"
-  ).option(
-    "--watch [path]",
-    'Watch mode, if path is not specified, it watches the current folder ".". Repeat "--watch" for more than one path'
-  ).option("--ignore-watch <path>", "Ignore custom paths in watch mode").option(
-    "--onSuccess <command>",
-    "Execute command after successful build, specially useful for watch mode"
-  ).option("--env.* <value>", "Define compile-time env variables").option(
-    "--inject <file>",
-    "Replace a global variable with an import from another file"
-  ).option("--define.* <value>", "Define compile-time constants").option(
-    "--external <name>",
-    "Mark specific packages / package.json (dependencies and peerDependencies) as external"
-  ).option("--global-name <name>", "Global variable name for iife format").option("--jsxFactory <jsxFactory>", "Name of JSX factory function", {
-    default: "React.createElement"
-  }).option("--jsxFragment <jsxFragment>", "Name of JSX fragment function", {
-    default: "React.Fragment"
-  }).option("--replaceNodeEnv", "Replace process.env.NODE_ENV").option("--no-splitting", "Disable code splitting").option("--clean", "Clean output directory").option(
-    "--silent",
-    'Suppress non-error logs (excluding "onSuccess" process output)'
-  ).option("--pure <express>", "Mark specific expressions as pure").option("--metafile", "Emit esbuild metafile (a JSON file)").option("--platform <platform>", "Target platform", {
-    default: "node"
-  }).option("--loader <ext=loader>", "Specify the loader for a file extension").option("--tsconfig <filename>", "Use a custom tsconfig").option("--config <filename>", "Use a custom config file").option("--no-config", "Disable config file").option("--shims", "Enable cjs and esm shims").option("--inject-style", "Inject style tag to document head").option(
-    "--treeshake [strategy]",
-    'Using Rollup for treeshaking instead, "recommended" or "smallest" or "safest"'
-  ).option("--publicDir [dir]", "Copy public directory to output directory").option(
-    "--killSignal <signal>",
-    'Signal to kill child process, "SIGTERM" or "SIGKILL"'
-  ).option("--cjsInterop", "Enable cjs interop").action(async (files, flags) => {
-    const { build } = await Promise.resolve().then(() => _interopRequireWildcard(require("./index.js")));
-    Object.assign(options, {
-      ...flags
-    });
-    if (!options.entry && files.length > 0) {
-      options.entry = files.map(_chunkTWFEYLU4js.slash);
-    }
-    if (flags.format) {
-      const format = ensureArray(flags.format);
-      options.format = format;
-    }
-    if (flags.external) {
-      const external = ensureArray(flags.external);
-      options.external = external;
-    }
-    if (flags.target) {
-      options.target = flags.target.includes(",") ? flags.target.split(",") : flags.target;
-    }
-    if (flags.dts || flags.dtsResolve || flags.dtsOnly) {
-      options.dts = {};
-      if (typeof flags.dts === "string") {
-        options.dts.entry = flags.dts;
-      }
-      if (flags.dtsResolve) {
-        options.dts.resolve = flags.dtsResolve;
-      }
-      if (flags.dtsOnly) {
-        options.dts.only = true;
-      }
-    }
-    if (flags.inject) {
-      const inject = ensureArray(flags.inject);
-      options.inject = inject;
-    }
-    if (flags.define) {
-      const define = flatten(flags.define);
-      options.define = define;
-    }
-    if (flags.loader) {
-      const loader = ensureArray(flags.loader);
-      options.loader = loader.reduce((result, item) => {
-        const parts = item.split("=");
-        return {
-          ...result,
-          [parts[0]]: parts[1]
-        };
-      }, {});
-    }
-    await build(options);
-  });
-  cli.help();
-  cli.version(_chunkBYH4XDRHjs.version);
-  cli.parse(process.argv, { run: false });
-  await cli.runMatchedCommand();
-}
-
-
-
-exports.main = main;

package/dist/chunk-JZ25TPTY.cjs

@@ -1,42 +0,0 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }// src/errors.ts
-var _worker_threads = require('worker_threads');
-var _picocolors = require('picocolors'); var _picocolors2 = _interopRequireDefault(_picocolors);
-var PrettyError = class extends Error {
-  constructor(message) {
-    super(message);
-    this.name = this.constructor.name;
-    if (typeof Error.captureStackTrace === "function") {
-      Error.captureStackTrace(this, this.constructor);
-    } else {
-      this.stack = new Error(message).stack;
-    }
-  }
-};
-function handleError(error) {
-  if (error.loc) {
-    console.error(
-      _picocolors2.default.bold(
-        _picocolors2.default.red(
-          `Error parsing: ${error.loc.file}:${error.loc.line}:${error.loc.column}`
-        )
-      )
-    );
-  }
-  if (error.frame) {
-    console.error(_picocolors2.default.red(error.message));
-    console.error(_picocolors2.default.dim(error.frame));
-  } else if (error instanceof PrettyError) {
-    console.error(_picocolors2.default.red(error.message));
-  } else {
-    console.error(_picocolors2.default.red(error.stack));
-  }
-  process.exitCode = 1;
-  if (!_worker_threads.isMainThread && _worker_threads.parentPort) {
-    _worker_threads.parentPort.postMessage("error");
-  }
-}
-
-
-
-
-exports.PrettyError = PrettyError; exports.handleError = handleError;