bunup 0.1.28 → 0.1.29

package/README.md

@@ -1,8 +1,4 @@
-# Bunup
-
-A extremely fast, zero-config bundler for TypeScript & JavaScript, powered by [Bun](https://bun.sh) and [oxc](https://oxc.rs/).
-
-![Demo](/demo.gif)
+![Og](https://bunup.arshadyaseen.com/og.png)
 
 ## Benchmarks
 
@@ -17,38 +13,18 @@ Bunup outperforms other popular bundlers by a significant margin:
 
 _Lower build time is better. Benchmark run on the same code with identical output formats._
 
-## Table of Contents
+## Prerequisites
 
-1. [Quick Start](#quick-start)
-2. [Configuration](#configuration)
-    - [Configuration File](#configuration-file)
-    - [CLI Options](#cli-options)
-3. [Entry Points](#entry-points)
-4. [Output Formats](#output-formats)
-5. [TypeScript Declarations](#typescript-declarations)
-6. [External Dependencies](#external-dependencies)
-7. [Code Splitting](#code-splitting)
-8. [Minification](#minification)
-9. [Watch Mode](#watch-mode)
-10. [API Reference](#api-reference)
-11. [Examples](#examples)
+Bunup requires [Bun](https://bun.sh) to be installed on your system. Bun is a fast all-in-one JavaScript runtime that powers Bunup's exceptional performance. Without Bun, Bunup cannot execute as it leverages Bun's bundling capabilities and runtime environment.
+
+To install Bun, please visit the [official Bun installation page](https://bun.sh/docs/installation).
 
 ## Quick Start
 
 ### Installation
 
 ```bash
-# Install bunup
 npm install --save-dev bunup
-
-# Or with yarn
-yarn add --dev bunup
-
-# Or with pnpm
-pnpm add --save-dev bunup
-
-# Or with bun
-bun add --dev bunup
 ```
 
 ### Basic Usage
@@ -65,7 +41,7 @@ export function greet(name: string): string {
 Bundle it with bunup:
 
 ```bash
-bunup --entry src/index.ts
+bunup src/index.ts
 ```
 
 This will create a bundled output in the `dist` directory.
@@ -78,7 +54,7 @@ Add a build script to your `package.json`:
 {
     "name": "my-package",
     "scripts": {
-        "build": "bunup --entry src/index.ts --format esm,cjs --dts"
+        "build": "bunup src/index.ts --format esm,cjs --dts"
     }
 }
 ```
@@ -105,491 +81,12 @@ export default defineConfig({
 });
 ```
 
-## Configuration
-
-### Configuration File
-
-Bunup supports configuration files in multiple formats:
-
-- `bunup.config.ts`
-- `bunup.config.js`
-- `bunup.config.mjs`
-- `bunup.config.cjs`
-- `bunup.config.json`
-- `bunup.config.jsonc`
-
-Example configuration:
-
-```typescript
-import {defineConfig} from 'bunup';
-
-export default defineConfig({
-    // Name for this build configuration (used in logs)
-    name: 'my-library',
-
-    // Entry points (can be an array or object)
-    entry: ['src/index.ts', 'src/cli.ts'],
-
-    // Output directory
-    outDir: 'dist',
-
-    // Output formats
-    format: ['esm', 'cjs'],
-
-    // TypeScript declaration generation
-    dts: true,
-
-    // Target environment
-    target: 'node',
-
-    // Minification options
-    minify: true,
-
-    // External dependencies
-    external: ['react', 'react-dom'],
-
-    // Clean output directory before build
-    clean: true,
-});
-```
-
-You can also export an array of configurations:
-
-```typescript
-export default defineConfig([
-    {
-        name: 'node',
-        entry: ['src/index.ts'],
-        format: ['cjs'],
-        target: 'node',
-    },
-    {
-        name: 'browser',
-        entry: ['src/index.ts'],
-        format: ['esm', 'iife'],
-        target: 'browser',
-    },
-]);
-```
-
-### CLI Options
-
-Bunup supports various command-line options:
-
-| Option                  | Alias | Description                                    |
-| ----------------------- | ----- | ---------------------------------------------- |
-| `--entry <path>`        |       | Entry file path                                |
-| `--entry.<name> <path>` |       | Named entry file path                          |
-| `--out-dir <dir>`       | `-o`  | Output directory                               |
-| `--format <formats>`    | `-f`  | Output formats (comma-separated: esm,cjs,iife) |
-| `--minify`              | `-m`  | Enable all minification options                |
-| `--minify-whitespace`   | `-mw` | Minify whitespace                              |
-| `--minify-identifiers`  | `-mi` | Minify identifiers                             |
-| `--minify-syntax`       | `-ms` | Minify syntax                                  |
-| `--watch`               | `-w`  | Watch mode                                     |
-| `--dts`                 | `-d`  | Generate TypeScript declarations               |
-| `--external <deps>`     | `-e`  | External dependencies (comma-separated)        |
-| `--no-external <deps>`  | `-ne` | Force include dependencies (comma-separated)   |
-| `--target <target>`     | `-t`  | Target environment (node, browser, bun)        |
-| `--clean`               | `-c`  | Clean output directory before build            |
-| `--splitting`           | `-s`  | Enable code splitting                          |
-| `--name <name>`         | `-n`  | Name for this build configuration              |
-
-Examples:
-
-```bash
-# Basic usage
-bunup --entry src/index.ts
-
-# Multiple formats with TypeScript declarations
-bunup --entry src/index.ts --format esm,cjs --dts
-
-# Named entries
-bunup --entry.main src/index.ts --entry.cli src/cli.ts
-
-# Watch mode
-bunup --entry src/index.ts --watch
-```
-
-## Entry Points
-
-Bunup supports multiple ways to define entry points:
-
-### Array of Paths
-
-```typescript
-export default defineConfig({
-    entry: ['src/index.ts', 'src/cli.ts'],
-});
-```
-
-This will generate output files named after the input files (e.g., `index.js` and `cli.js`).
-
-### Named Entries
-
-```typescript
-export default defineConfig({
-    entry: {
-        main: 'src/index.ts',
-        cli: 'src/cli.ts',
-        utils: 'src/utils/index.ts',
-    },
-});
-```
-
-This will generate output files with the specified names (e.g., `main.js`, `cli.js`, and `utils.js`).
-
-## Output Formats
-
-Bunup supports three output formats:
-
-- **esm**: ECMAScript modules (`.mjs` extension)
-- **cjs**: CommonJS modules (`.js` or `.cjs` extension)
-- **iife**: Immediately Invoked Function Expression (`.global.js` extension)
-
-```typescript
-export default defineConfig({
-    entry: ['src/index.ts'],
-    format: ['esm', 'cjs', 'iife'],
-});
-```
-
-The file extensions are determined automatically based on the format and your package.json `type` field:
-
-| Format | package.json type: "module" | package.json type: "commonjs" or unspecified |
-| ------ | --------------------------- | -------------------------------------------- |
-| esm    | `.mjs`                      | `.mjs`                                       |
-| cjs    | `.cjs`                      | `.js`                                        |
-| iife   | `.global.js`                | `.global.js`                                 |
-
-## TypeScript Declarations
-
-Bunup can generate TypeScript declaration files (`.d.ts`) for your code:
-
-```typescript
-export default defineConfig({
-    entry: ['src/index.ts'],
-    dts: true,
-});
-```
-
-For more control, you can specify custom entry points for declarations:
-
-```typescript
-export default defineConfig({
-    entry: ['src/index.ts', 'src/cli.ts'],
-    dts: {
-        entry: ['src/index.ts'], // Only generate declarations for index.ts
-    },
-});
-```
-
-Or use named entries:
-
-```typescript
-export default defineConfig({
-    entry: {
-        main: 'src/index.ts',
-        cli: 'src/cli.ts',
-    },
-    dts: {
-        entry: {
-            types: 'src/index.ts', // Generate types.d.ts from index.ts
-        },
-    },
-});
-```
-
-You can also specify a custom tsconfig file for declaration generation:
-
-```typescript
-export default defineConfig({
-    entry: ['src/index.ts'],
-    dts: true,
-    preferredTsconfigPath: './tsconfig.build.json',
-});
-```
-
-Declaration file extensions follow the same pattern as JavaScript files:
-
-| Format | package.json type: "module" | package.json type: "commonjs" or unspecified |
-| ------ | --------------------------- | -------------------------------------------- |
-| esm    | `.d.mts`                    | `.d.mts`                                     |
-| cjs    | `.d.cts`                    | `.d.ts`                                      |
-| iife   | `.d.ts`                     | `.d.ts`                                      |
+## Documentation
 
-## External Dependencies
+For complete documentation, visit [the full documentation](https://bunup.arshadyaseen.com/).
 
-By default, Bunup treats all dependencies from your `package.json` (`dependencies` and `peerDependencies`) as external. This means they won't be included in your bundle.
-
-You can explicitly mark additional packages as external:
-
-```typescript
-export default defineConfig({
-    entry: ['src/index.ts'],
-    external: ['lodash', 'react', '@some/package'],
-});
-```
+## Contributing
 
-You can also force include specific dependencies that would otherwise be external:
+For guidelines on contributing, please read the [contributing guide](https://github.com/arshad-yaseen/bunup/blob/main/CONTRIBUTING.md).
 
-```typescript
-export default defineConfig({
-    entry: ['src/index.ts'],
-    external: ['lodash'],
-    noExternal: ['lodash/merge'], // Include lodash/merge even though lodash is external
-});
-```
-
-Both `external` and `noExternal` support string patterns and regular expressions.
-
-## Code Splitting
-
-Bunup supports code splitting for the ESM format:
-
-```typescript
-export default defineConfig({
-    entry: ['src/index.ts'],
-    format: ['esm'],
-    splitting: true, // Default is true for ESM
-});
-```
-
-Code splitting is enabled by default for ESM format and disabled for CJS and IIFE formats. You can explicitly enable or disable it:
-
-```typescript
-export default defineConfig({
-    entry: ['src/index.ts'],
-    format: ['esm', 'cjs'],
-    splitting: false, // Disable code splitting for all formats
-});
-```
-
-## Minification
-
-Bunup provides several minification options:
-
-```typescript
-export default defineConfig({
-    entry: ['src/index.ts'],
-
-    // Enable all minification options
-    minify: true,
-
-    // Or configure individual options
-    minifyWhitespace: true,
-    minifyIdentifiers: false,
-    minifySyntax: true,
-});
-```
-
-The `minify` option is a shorthand that enables all three specific options. If you set individual options, they take precedence over the `minify` setting.
-
-## Watch Mode
-
-Bunup can watch your files for changes and rebuild automatically:
-
-```typescript
-export default defineConfig({
-    entry: ['src/index.ts'],
-    watch: true,
-});
-```
-
-Or use the CLI flag:
-
-```bash
-bunup --entry src/index.ts --watch
-```
-
-In watch mode, Bunup will monitor your source files and their dependencies, rebuilding only what's necessary when files change.
-
-## API Reference
-
-### BunupOptions
-
-The complete configuration options interface:
-
-```typescript
-interface BunupOptions {
-    /**
-     * Name of the build configuration
-     * Used for logging and identification purposes
-     */
-    name?: string;
-
-    /**
-     * Entry point files for the build
-     * Can be an array of file paths or an object with named entries
-     */
-    entry: string[] | Record<string, string>;
-
-    /**
-     * Output directory for the bundled files
-     * Defaults to 'dist'
-     */
-    outDir: string;
-
-    /**
-     * Output formats for the bundle
-     * Can include 'esm', 'cjs', and/or 'iife'
-     * Defaults to ['cjs']
-     */
-    format: ('esm' | 'cjs' | 'iife')[];
-
-    /**
-     * Whether to enable all minification options
-     */
-    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
-     */
-    minifyWhitespace?: boolean;
-
-    /**
-     * Whether to minify identifiers in the output
-     */
-    minifyIdentifiers?: boolean;
-
-    /**
-     * Whether to minify syntax in the output
-     */
-    minifySyntax?: boolean;
-
-    /**
-     * Whether to watch for file changes and rebuild automatically
-     */
-    watch?: boolean;
-
-    /**
-     * Whether to generate TypeScript declaration files (.d.ts)
-     * When set to true, generates declaration files for all entry points
-     * Can also be configured with DtsOptions for more control
-     */
-    dts?:
-        | boolean
-        | {
-              entry: string[] | Record<string, string>;
-          };
-
-    /**
-     * Path to a preferred tsconfig.json file to use for declaration generation
-     */
-    preferredTsconfigPath?: string;
-
-    /**
-     * External packages that should not be bundled
-     */
-    external?: string[];
-
-    /**
-     * Packages that should be bundled even if they are in external
-     */
-    noExternal?: string[];
-
-    /**
-     * The target environment for the bundle
-     * Can be 'browser', 'bun', 'node'
-     * Defaults to 'node'
-     */
-    target?: 'browser' | 'bun' | 'node';
-
-    /**
-     * Whether to clean the output directory before building
-     * Defaults to true
-     */
-    clean?: boolean;
-}
-```
-
-### Default Options
-
-```typescript
-const DEFAULT_OPTIONS = {
-    entry: [],
-    format: ['cjs'],
-    outDir: 'dist',
-    minify: false,
-    watch: false,
-    dts: false,
-    target: 'node',
-    external: [],
-    clean: true,
-};
-```
-
-## Examples
-
-### Basic Library
-
-```typescript
-// bunup.config.ts
-import {defineConfig} from 'bunup';
-
-export default defineConfig({
-    entry: ['src/index.ts'],
-    format: ['esm', 'cjs'],
-    dts: true,
-});
-```
-
-### Multiple Entry Points
-
-```typescript
-// bunup.config.ts
-import {defineConfig} from 'bunup';
-
-export default defineConfig({
-    entry: {
-        index: 'src/index.ts',
-        cli: 'src/cli.ts',
-    },
-    format: ['esm', 'cjs'],
-    dts: true,
-});
-```
-
-### Browser and Node Targets
-
-```typescript
-// bunup.config.ts
-import {defineConfig} from 'bunup';
-
-export default defineConfig([
-    {
-        name: 'node',
-        entry: ['src/index.ts'],
-        format: ['cjs', 'esm'],
-        target: 'node',
-        outDir: 'dist/node',
-    },
-    {
-        name: 'browser',
-        entry: ['src/index.ts'],
-        format: ['esm', 'iife'],
-        target: 'browser',
-        outDir: 'dist/browser',
-    },
-]);
-```
-
-### With Minification
-
-```typescript
-// bunup.config.ts
-import {defineConfig} from 'bunup';
-
-export default defineConfig({
-    entry: ['src/index.ts'],
-    format: ['esm', 'cjs'],
-    minify: true,
-    dts: true,
-});
-```
+We welcome contributions from the community to enhance Bunup's capabilities and make it even more powerful. ❤️

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "bunup",
-  "version": "0.1.28",
-  "description": "A extremely fast, zero-config bundler for TypeScript & JavaScript, powered by Bun.",
+  "version": "0.1.29",
+  "description": "An extremely fast, zero-config bundler for TypeScript & JavaScript, powered by Bun.",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",
   "module": "./build/index.mjs",
@@ -42,6 +42,7 @@
     "type": "git",
     "url": "git+https://github.com/arshad-yaseen/bunup.git"
   },
+  "homepage": "https://bunup.arshadyaseen.com",
   "maintainers": [
     {
       "name": "Arshad Yaseen",