bunup 0.13.4 → 0.13.5

package/dist/cli/index.js

@@ -24,7 +24,7 @@ import {
 import { loadConfig } from "coffi";
 import pc3 from "picocolors";
 // packages/bunup/package.json
-var version = "0.11.30";
+var version = "0.13.5";
 
 // packages/bunup/src/watch.ts
 import path from "path";

package/dist/index.d.ts

@@ -1,4 +1,468 @@
-import { Arrayable, BuildContext, BuildMeta, BuildOptions, BuildOutput, BuildOutputFile, BunupPlugin, DefineConfigItem, DefineWorkspaceItem, WithOptional } from "./shared/bunup-s6gfzz2v";
+import { GenerateDtsOptions } from "@bunup/dts";
+import { BunPlugin } from "bun";
+type MaybePromise<T> = Promise<T> | T;
+type WithOptional<
+	T,
+	K extends keyof T
+> = Omit<T, K> & Partial<Pick<T, K>>;
+type Arrayable<T> = T | T[];
+type DefineConfigItem = WithOptional<BuildOptions, "outDir" | "format" | "entry">;
+type DefineWorkspaceItem = {
+	name: string
+	root: string
+	config: DefineConfigItem | DefineConfigItem[]
+};
+type PackageJson = {
+	/** The parsed content of the package.json file */
+	data: Record<string, any> | null
+	/** The path to the package.json file */
+	path: string | null
+};
+/**
+* Represents the meta data of the build
+*/
+type BuildMeta = {
+	/** The package.json file */
+	packageJson: PackageJson
+	/** The root directory of the build */
+	rootDir: string
+};
+type BuildOutputFile = {
+	/**
+	* The entry point for which this file was generated
+	*
+	* Undefined for non-entry point files (e.g., assets, sourcemaps, chunks)
+	*/
+	entrypoint: string | undefined
+	/** The kind of the file */
+	kind: "entry-point" | "chunk" | "asset" | "sourcemap" | "bytecode"
+	/** Absolute path to the generated file */
+	fullPath: string
+	/** Path to the generated file relative to the root directory */
+	pathRelativeToRootDir: string
+	/** Path to the generated file relative to the output directory */
+	pathRelativeToOutdir: string
+	/** Whether the file is a dts file */
+	dts: boolean
+	/** The format of the output file */
+	format: Format
+};
+/**
+* Represents the output of a build operation
+*/
+type BuildOutput = {
+	/** Array of generated files with their paths and contents */
+	files: BuildOutputFile[]
+};
+/**
+* Context provided to build hooks
+*/
+type BuildContext = {
+	/** The build options that were used */
+	options: BuildOptions
+	/** The output of the build */
+	output: BuildOutput
+	/** The meta data of the build */
+	meta: BuildMeta
+};
+/**
+* Hooks that can be implemented by Bunup plugins
+*/
+type BunupPluginHooks = {
+	/**
+	* Called when a build is successfully completed
+	* @param ctx Build context containing options and output
+	*/
+	onBuildDone?: (ctx: BuildContext) => MaybePromise<void>
+	/**
+	* Called before a build starts
+	* @param options Build options that will be used
+	*/
+	onBuildStart?: (options: BuildOptions) => MaybePromise<void>
+};
+/**
+* Represents a Bunup-specific plugin
+*/
+type BunupPlugin = {
+	/** Optional name for the plugin */
+	name?: string
+	/** The hooks implemented by this plugin */
+	hooks: BunupPluginHooks
+};
+type Loader = "js" | "jsx" | "ts" | "tsx" | "json" | "toml" | "file" | "napi" | "wasm" | "text" | "css" | "html";
+type Define = Record<string, string>;
+type Sourcemap = "none" | "linked" | "inline" | "external" | "linked" | boolean;
+type Format = "esm" | "cjs" | "iife";
+type Target = "bun" | "node" | "browser";
+type External = (string | RegExp)[];
+type Env = "inline" | "disable" | `${string}*` | Record<string, string>;
+type CSSOptions = {
+	/**
+	* Generate TypeScript definitions for CSS modules.
+	*
+	* @see https://bunup.dev/docs/guide/css#css-modules-and-typescript
+	*/
+	typedModules?: boolean
+};
+type OnSuccess = ((options: Partial<BuildOptions>) => MaybePromise<void> | (() => void)) | string | {
+	/**
+	* The shell command to execute after a successful build
+	*/
+	cmd: string
+	/**
+	* Additional options for the command execution
+	*/
+	options?: {
+		/**
+		* Working directory for the command
+		*/
+		cwd?: string
+		/**
+		* Environment variables to pass to the command
+		* @default process.env
+		*/
+		env?: Record<string, string | undefined>
+		/**
+		* Maximum time in milliseconds the command is allowed to run
+		*/
+		timeout?: number
+		/**
+		* Signal to use when killing the process
+		* @default 'SIGTERM'
+		*/
+		killSignal?: NodeJS.Signals | number
+	}
+};
+type ReportOptions = {
+	/**
+	* Enable gzip compression size calculation.
+	*
+	* Note: For huge output files, this may slow down the build process. In this case, consider disabling this option.
+	*
+	* @default true
+	*/
+	gzip?: boolean
+	/**
+	* Enable brotli compression size calculation.
+	*
+	* Note: For huge output files, this may slow down the build process. In this case, consider disabling this option.
+	*
+	* @default false
+	*/
+	brotli?: boolean
+	/**
+	* Maximum bundle size in bytes. Will warn if exceeded.
+	*
+	* @default undefined
+	*/
+	maxBundleSize?: number
+};
+interface BuildOptions {
+	/**
+	* Name of the build configuration
+	* Used for logging and identification purposes
+	*/
+	name?: string;
+	/**
+	* Entry point files for the build
+	*
+	* This can be:
+	* - A string path to a file
+	* - An array of file paths
+	*
+	* @see https://bunup.dev/docs/guide/options#entry-points
+	*/
+	entry: string | string[];
+	/**
+	* Output directory for the bundled files
+	* Defaults to 'dist' if not specified
+	*/
+	outDir: string;
+	/**
+	* Output formats for the bundle
+	* Can include 'esm', 'cjs', and/or 'iife'
+	* Defaults to 'esm' if not specified
+	*/
+	format: Format | Format[];
+	/**
+	* Whether to enable all minification options
+	* When true, enables minifyWhitespace, minifyIdentifiers, and minifySyntax
+	*/
+	minify?: boolean;
+	/**
+	* Whether to enable code splitting
+	* Defaults to true for ESM format, false for CJS format
+	*/
+	splitting?: boolean;
+	/**
+	* Whether to minify whitespace in the output
+	* Removes unnecessary whitespace to reduce file size
+	*/
+	minifyWhitespace?: boolean;
+	/**
+	* Whether to minify identifiers in the output
+	* Renames variables and functions to shorter names
+	*/
+	minifyIdentifiers?: boolean;
+	/**
+	* Whether to minify syntax in the output
+	* Optimizes code structure for smaller file size
+	*/
+	minifySyntax?: boolean;
+	/**
+	* Whether to watch for file changes and rebuild automatically
+	*/
+	watch?: boolean;
+	/**
+	* package.json `exports` conditions used when resolving imports
+	*
+	* Equivalent to `--conditions` in `bun build` or `bun run`.
+	*
+	* https://nodejs.org/api/packages.html#exports
+	*/
+	conditions?: string | string[];
+	/**
+	* Whether to generate TypeScript declaration files (.d.ts)
+	* When set to true, generates declaration files for all entry points
+	* Can also be configured with GenerateDtsOptions for more control
+	*/
+	dts?: boolean | (Pick<GenerateDtsOptions, "resolve" | "splitting" | "minify"> & {
+		entry?: string | string[]
+	});
+	/**
+	* Path to a preferred tsconfig.json file to use for declaration generation
+	*
+	* If not specified, the tsconfig.json in the project root will be used.
+	* This option allows you to use a different TypeScript configuration
+	* specifically for declaration file generation.
+	*
+	* @example
+	* preferredTsconfigPath: './tsconfig.build.json'
+	*/
+	preferredTsconfigPath?: string;
+	/**
+	* External packages that should not be bundled
+	* Useful for dependencies that should be kept as external imports
+	*/
+	external?: External;
+	/**
+	* Packages that should be bundled even if they are in external
+	* Useful for dependencies that should be included in the bundle
+	*/
+	noExternal?: External;
+	/**
+	* The target environment for the bundle.
+	* Can be 'browser', 'bun', 'node', etc.
+	* Defaults to 'node' if not specified.
+	*
+	* Bun target is for generating bundles that are intended to be run by the Bun runtime. In many cases,
+	* it isn't necessary to bundle server-side code; you can directly execute the source code
+	* without modification. However, bundling your server code can reduce startup times and
+	* improve running performance.
+	*
+	* All bundles generated with `target: "bun"` are marked with a special `// @bun` pragma, which
+	* indicates to the Bun runtime that there's no need to re-transpile the file before execution.
+	*/
+	target?: Target;
+	/**
+	* Whether to clean the output directory before building
+	* When true, removes all files in the outDir before starting a new build
+	* Defaults to true if not specified
+	*/
+	clean?: boolean;
+	/**
+	* Specifies the type of sourcemap to generate
+	* Can be 'none', 'linked', 'external', or 'inline'
+	* Can also be a boolean - when true, it will use 'inline'
+	*
+	* @see https://bun.sh/docs/bundler#sourcemap
+	*
+	* @default 'none'
+	*
+	* @example
+	* sourcemap: 'linked'
+	* // or
+	* sourcemap: true // equivalent to 'inline'
+	*/
+	sourcemap?: Sourcemap;
+	/**
+	* Define global constants for the build
+	* These values will be replaced at build time
+	*
+	* @see https://bun.sh/docs/bundler#define
+	*
+	* @example
+	* define: {
+	*   'process.env.NODE_ENV': '"production"',
+	*   'PACKAGE_VERSION': '"1.0.0"'
+	* }
+	*/
+	define?: Define;
+	/**
+	* A callback or command to run after a successful build.
+	*
+	* If a function is provided, it can optionally return a cleanup function
+	* that will be called when the operation is cancelled.
+	*
+	* @example
+	* onSuccess: (options) => {
+	*   const server = startServer();
+	*   return () => server.close();
+	* }
+	*
+	* @example
+	* onSuccess: "echo Build completed!"
+	*
+	* @example
+	* onSuccess: {
+	*   cmd: "bun run dist/server.js",
+	*   options: { env: { ...process.env, FOO: "bar" } }
+	* }
+	*/
+	onSuccess?: OnSuccess;
+	/**
+	* A banner to be added to the final bundle, this can be a directive like "use client" for react or a comment block such as a license for the code.
+	*
+	* @see https://bun.sh/docs/bundler#banner
+	*
+	* @example
+	* banner: '"use client";'
+	*/
+	banner?: string;
+	/**
+	* A footer to be added to the final bundle, this can be something like a comment block for a license or just a fun easter egg.
+	*
+	* @see https://bun.sh/docs/bundler#footer
+	*
+	* @example
+	* footer: '// built with love in SF'
+	*/
+	footer?: string;
+	/**
+	* Remove function calls from a bundle. For example, `drop: ["console"]` will remove all calls to `console.log`. Arguments to calls will also be removed, regardless of if those arguments may have side effects. Dropping `debugger` will remove all `debugger` statements.
+	*
+	* @see https://bun.sh/docs/bundler#drop
+	*
+	* @example
+	* drop: ["console", "debugger", "anyIdentifier.or.propertyAccess"]
+	*/
+	drop?: string[];
+	/**
+	* A map of file extensions to [built-in loader names](https://bun.sh/docs/bundler/loaders#built-in-loaders). This can be used to quickly customize how certain files are loaded.
+	*
+	* @see https://bun.sh/docs/bundler#loader
+	*
+	* @example
+	* loader: {
+	*   ".png": "dataurl",
+	*   ".txt": "file",
+	* }
+	*/
+	loader?: { [k in string] : Loader };
+	/**
+	* Disable logging during the build process. When set to true, no logs will be printed to the console.
+	*
+	* @default false
+	*/
+	silent?: boolean;
+	/**
+	* You can specify a prefix to be added to specific import paths in your bundled code
+	*
+	* Used for assets, external modules, and chunk files when splitting is enabled
+	*
+	* @see https://bunup.dev/docs/guide/options#public-path for more information
+	*
+	* @example
+	* publicPath: 'https://cdn.example.com/'
+	*/
+	publicPath?: string;
+	/**
+	* Controls how environment variables are handled during bundling.
+	*
+	* Can be one of:
+	* - `"inline"`: Replaces all `process.env.FOO` references in your code with the actual values
+	*   of those environment variables at the time the build runs.
+	* - `"disable"`: Disables environment variable injection entirely, leaving `process.env.*` as-is.
+	* - A string ending in `*`: Only inlines environment variables matching the given prefix.
+	*   For example, `"MY_PUBLIC_*"` will inline variables like `MY_PUBLIC_API_URL`.
+	* - An object of key-value pairs: Replaces both `process.env.KEY` and `import.meta.env.KEY`
+	*   with the provided values, regardless of the runtime environment.
+	*
+	* Note: Values are injected at build time. Secrets or private keys should be excluded
+	* from inlining when targeting browser environments.
+	*
+	* @see https://bun.sh/docs/bundler#env to learn more about inline, disable, prefix, and object modes
+	*
+	* @example
+	* // Inline all environment variables available at build time
+	* env: "inline"
+	*
+	* // Disable all environment variable injection
+	* env: "disable"
+	*
+	* // Only inline environment variables with a specific prefix
+	* env: "PUBLIC_*"
+	*
+	* // Provide specific environment variables manually
+	* env: { API_URL: "https://api.example.com", DEBUG: "false" }
+	*/
+	env?: Env;
+	/**
+	* Whether to enable shims for Node.js globals and ESM/CJS interoperability.
+	*
+	* @default false
+	*/
+	shims?: boolean;
+	/**
+	* Configuration for the build report that shows file sizes and compression stats.
+	*/
+	report?: ReportOptions;
+	/**
+	* Ignore dead code elimination/tree-shaking annotations such as @__PURE__ and package.json
+	* "sideEffects" fields. This should only be used as a temporary workaround for incorrect
+	* annotations in libraries.
+	*/
+	ignoreDCEAnnotations?: boolean;
+	/**
+	* Force emitting @__PURE__ annotations even if minify.whitespace is true.
+	*/
+	emitDCEAnnotations?: boolean;
+	/**
+	* Plugins to extend the build process functionality
+	*
+	* The Plugin type uses a discriminated union pattern with the 'type' field
+	* to support different plugin systems. Both "bun" and "bunup" plugins are supported.
+	*
+	* Each plugin type has its own specific plugin implementation:
+	* - "bun": Uses Bun's native plugin system (BunPlugin)
+	* - "bunup": Uses bunup's own plugin system with lifecycle hooks
+	*
+	* This architecture allows for extensibility as more plugin systems are added.
+	*
+	* @see https://bunup.dev/docs/advanced/plugin-development for more information on plugins
+	*
+	* @example
+	* plugins: [
+	* 	myBunPlugin(),
+	*   {
+	*     name: "my-bunup-plugin",
+	*     hooks: {
+	*       onBuildStart: (options) => {
+	*         console.log('Build started with options:', options)
+	*       },
+	*       onBuildDone: ({ options, output }) => {
+	*         console.log('Build completed with output:', output)
+	*       }
+	*     }
+	*   }
+	* ]
+	*/
+	plugins?: (BunupPlugin | BunPlugin)[];
+	/**
+	* Options for CSS handling in the build process.
+	*/
+	css?: CSSOptions;
+}
 declare function build(userOptions: Partial<BuildOptions>, rootDir?: string): Promise<BuildOutput>;
 declare function defineConfig(options: Arrayable<DefineConfigItem>): Arrayable<DefineConfigItem>;
 declare function defineWorkspace(options: WithOptional<DefineWorkspaceItem, "config">[], sharedOptions?: Partial<DefineConfigItem>): DefineWorkspaceItem[];