For reporting bugs, issues, or security vulnerabilities, please visit community.foss.global/. This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a code.foss.global/ account to submit Pull Requests directly.

Installation

# Global installation for CLI usage
npm install -g @git.zone/tsbundle

# Local installation for project usage
npm install --save-dev @git.zone/tsbundle

# Or with pnpm
pnpm add -g @git.zone/tsbundle

Quick Start ⚡

Interactive Setup

The easiest way to get started is with the interactive wizard:

tsbundle init

This will guide you through setting up your bundle configuration with preset options:

element - Web component / element bundle (./ts_web/index.ts → ./dist_bundle/bundle.js)
website - Full website with HTML and assets (./ts_web/index.ts → ./dist_serve/bundle.js)
npm - NPM package bundle (./ts/index.ts → ./dist_bundle/bundle.js)
custom - Configure everything manually

Build Your Bundles

Once configured, simply run:

tsbundle

That's it! Your bundles will be built according to your npmextra.json configuration.

CLI Commands

Command	Description
`tsbundle`	Build all bundles from `npmextra.json` configuration
`tsbundle custom`	Same as above (explicit)
`tsbundle init`	Interactive wizard to create/update bundle configuration

Configuration 📝

tsbundle uses npmextra.json for configuration. Here's an example:

{
  "@git.zone/tsbundle": {
    "bundles": [
      {
        "from": "./ts_web/index.ts",
        "to": "./dist_bundle/bundle.js",
        "outputMode": "bundle",
        "bundler": "esbuild",
        "production": false
      },
      {
        "from": "./ts_web/index.ts",
        "to": "./dist_serve/bundle.js",
        "outputMode": "bundle",
        "bundler": "esbuild",
        "includeFiles": ["./html/**/*.html", "./assets/**/*"]
      }
    ]
  }
}

Bundle Configuration Options

Option	Type	Default	Description
`from`	`string`	-	Entry point TypeScript file
`to`	`string`	-	Output file path
`outputMode`	`"bundle"` \| `"base64ts"`	`"bundle"`	Output format (see below)
`bundler`	`"esbuild"` \| `"rolldown"` \| `"rspack"`	`"esbuild"`	Which bundler to use
`production`	`boolean`	`false`	Enable minification
`includeFiles`	`string[]`	`[]`	Glob patterns for additional files (HTML, assets)

Output Modes

`bundle` (default)

Standard JavaScript bundle output. Additional files specified in includeFiles are copied to the output directory.

`base64ts`

Generates a TypeScript file with base64-encoded content - perfect for Deno compile scenarios where you need everything embedded in a single executable:

// Auto-generated by tsbundle
export const files: { path: string; contentBase64: string }[] = [
  { path: "bundle.js", contentBase64: "Y29uc3QgaGVsbG8gPSAid29ybGQi..." },
  { path: "index.html", contentBase64: "PCFET0NUWVBFIGh0bWw+..." },
];

Available Bundlers 🔧

tsbundle supports three modern bundlers:

Bundler	Speed	Best For
esbuild	⚡⚡⚡ Blazing fast	Development, quick iterations
rolldown	⚡⚡ Fast	Production builds, tree-shaking
rspack	⚡⚡ Fast	Webpack compatibility

API Usage

TsBundle Class

import { TsBundle } from '@git.zone/tsbundle';

const bundler = new TsBundle();

await bundler.build(
  process.cwd(),           // Working directory
  './src/index.ts',        // Entry point
  './dist/bundle.js',      // Output path
  {
    bundler: 'esbuild',
    production: true
  }
);

HtmlHandler Class

Process and minify HTML files:

import { HtmlHandler } from '@git.zone/tsbundle';

const htmlHandler = new HtmlHandler();

await htmlHandler.processHtml({
  from: './html/index.html',
  to: './dist/index.html',
  minify: true
});

AssetsHandler Class

Handle static assets:

import { AssetsHandler } from '@git.zone/tsbundle';

const assetsHandler = new AssetsHandler();

await assetsHandler.processAssets({
  from: './assets',
  to: './dist/assets'
});

Complete Example 🎯

1. Initialize your project

tsbundle init

Select "website" preset for a full web application setup.

2. Your generated config

{
  "@git.zone/tsbundle": {
    "bundles": [
      {
        "from": "./ts_web/index.ts",
        "to": "./dist_serve/bundle.js",
        "outputMode": "bundle",
        "bundler": "esbuild",
        "includeFiles": ["./html/**/*.html", "./assets/**/*"]
      }
    ]
  }
}

3. Create your entry point

// ts_web/index.ts
console.log('Hello from tsbundle! 🚀');

export const app = {
  version: '1.0.0',
  init() {
    console.log('App initialized');
  }
};

app.init();

4. Build

tsbundle

Your bundle is ready in ./dist_serve/bundle.js along with any HTML and assets!

Embedding for Deno Compile 🦕

For single-executable scenarios with Deno:

tsbundle init
# Select "custom", set outputMode to "base64ts"

Config:

{
  "@git.zone/tsbundle": {
    "bundles": [
      {
        "from": "./ts_web/index.ts",
        "to": "./ts/embedded-bundle.ts",
        "outputMode": "base64ts",
        "bundler": "esbuild",
        "production": true,
        "includeFiles": ["./html/index.html"]
      }
    ]
  }
}

Then in your Deno app:

import { files } from './ts/embedded-bundle.ts';

// Decode and serve your embedded files
const bundle = files.find(f => f.path === 'bundle.js');
const html = files.find(f => f.path === 'html/index.html');

const bundleContent = atob(bundle.contentBase64);
const htmlContent = atob(html.contentBase64);

Project Structure Recommendations 📁

your-project/
├── ts_web/              # Web bundle entry points
│   └── index.ts
├── ts/                  # Library/node entry points
│   └── index.ts
├── html/                # HTML templates
│   └── index.html
├── assets/              # Static assets (images, fonts, etc.)
├── dist_bundle/         # Output for element/npm bundles
├── dist_serve/          # Output for website bundles
└── npmextra.json        # tsbundle configuration

License and Legal Information

This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the LICENSE file.

Please note: The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.

Trademarks

This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.

Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.

readme.md

@git.zone/tsbundle

Issue Reporting and Security