Compare commits

...

6 Commits

15 changed files with 919 additions and 78 deletions

View File

@ -1,5 +1,29 @@
# Changelog # Changelog
## 2025-06-26 - 2.5.0 - feat(documentation)
Improve README with comprehensive installation, usage, and API reference details
- Updated installation instructions for both global and local setups
- Added a quick start guide featuring CLI usage and API examples
- Enhanced sections for available bundlers and specialized CLI commands
- Expanded API reference with detailed examples for TsBundle, HtmlHandler, and AssetsHandler
- Reorganized content to improve clarity and best practices guidance
## 2025-06-26 - 2.4.1 - fix(tests)
Improve decorator tests and add LitElement component tests for better validation
- Refactored test-decorators.ts to robustly verify that the sealed decorator prevents prototype modifications
- Added test-lit.ts to ensure LitElement component renders correctly and increments counter on click
## 2025-06-19 - 2.4.0 - feat(bundler)
Introduce rspack bundler support and update multi-bundler workflow
- Added full support for rspack with its own implementation in ts/mod_rspack
- Updated package.json: new dependency on @rspack/core and revised description
- Refactored bundler types and switch statement to remove deprecated rollup and parcel options
- Modified test suite to include tests for esbuild, rolldown, and rspack with bundle size comparisons
- Adjusted output configuration for esbuild and rolldown for dynamic naming and inline dynamic imports
## 2025-06-19 - 2.3.0 - feat(bundler) ## 2025-06-19 - 2.3.0 - feat(bundler)
Integrate rolldown bundler support and update bundler selection logic Integrate rolldown bundler support and update bundler selection logic

View File

@ -1,15 +1,15 @@
{ {
"name": "@git.zone/tsbundle", "name": "@git.zone/tsbundle",
"version": "2.3.0", "version": "2.5.0",
"private": false, "private": false,
"description": "a bundler using rollup for painless bundling of web projects", "description": "a multi-bundler tool supporting esbuild, rolldown, and rspack for painless bundling of web projects",
"main": "dist_ts/index.js", "main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts", "typings": "dist_ts/index.d.ts",
"type": "module", "type": "module",
"author": "Lossless GmbH", "author": "Lossless GmbH",
"license": "MIT", "license": "MIT",
"scripts": { "scripts": {
"test": "npm run build && (tstest test/) && (cd test && node ../cli.js --production)", "test": "npm run build && (tstest test/ --verbose)",
"build": "(tsbuild --web --allowimplicitany)" "build": "(tsbuild --web --allowimplicitany)"
}, },
"bin": { "bin": {
@ -36,6 +36,7 @@
"esbuild": "^0.25.5", "esbuild": "^0.25.5",
"html-minifier": "^4.0.0", "html-minifier": "^4.0.0",
"rolldown": "^1.0.0-beta.18", "rolldown": "^1.0.0-beta.18",
"@rspack/core": "^1.1.8",
"typescript": "5.8.3" "typescript": "5.8.3"
}, },
"files": [ "files": [

154
pnpm-lock.yaml generated
View File

@ -35,6 +35,9 @@ importers:
'@push.rocks/smartspawn': '@push.rocks/smartspawn':
specifier: ^3.0.3 specifier: ^3.0.3
version: 3.0.3 version: 3.0.3
'@rspack/core':
specifier: ^1.1.8
version: 1.3.15
'@types/html-minifier': '@types/html-minifier':
specifier: ^4.0.5 specifier: ^4.0.5
version: 4.0.5 version: 4.0.5
@ -804,6 +807,24 @@ packages:
'@mixmark-io/domino@2.2.0': '@mixmark-io/domino@2.2.0':
resolution: {integrity: sha512-Y28PR25bHXUg88kCV7nivXrP2Nj2RueZ3/l/jdx6J9f8J4nsEGcgX0Qe6lt7Pa+J79+kPiJU3LguR6O/6zrLOw==} resolution: {integrity: sha512-Y28PR25bHXUg88kCV7nivXrP2Nj2RueZ3/l/jdx6J9f8J4nsEGcgX0Qe6lt7Pa+J79+kPiJU3LguR6O/6zrLOw==}
'@module-federation/error-codes@0.14.3':
resolution: {integrity: sha512-sBJ3XKU9g5Up31jFeXPFsD8AgORV7TLO/cCSMuRewSfgYbG/3vSKLJmfHrO6+PvjZSb9VyV2UaF02ojktW65vw==}
'@module-federation/runtime-core@0.14.3':
resolution: {integrity: sha512-xMFQXflLVW/AJTWb4soAFP+LB4XuhE7ryiLIX8oTyUoBBgV6U2OPghnFljPjeXbud72O08NYlQ1qsHw1kN/V8Q==}
'@module-federation/runtime-tools@0.14.3':
resolution: {integrity: sha512-QBETX7iMYXdSa3JtqFlYU+YkpymxETZqyIIRiqg0gW+XGpH3jgU68yjrme2NBJp7URQi/CFZG8KWtfClk0Pjgw==}
'@module-federation/runtime@0.14.3':
resolution: {integrity: sha512-7ZHpa3teUDVhraYdxQGkfGHzPbjna4LtwbpudgzAxSLLFxLDNanaxCuSeIgSM9c+8sVUNC9kvzUgJEZB0krPJw==}
'@module-federation/sdk@0.14.3':
resolution: {integrity: sha512-THJZMfbXpqjQOLblCQ8jjcBFFXsGRJwUWE9l/Q4SmuCSKMgAwie7yLT0qSGrHmyBYrsUjAuy+xNB4nfKP0pnGw==}
'@module-federation/webpack-bundler-runtime@0.14.3':
resolution: {integrity: sha512-hIyJFu34P7bY2NeMIUHAS/mYUHEY71VTAsN0A0AqEJFSVPszheopu9VdXq0VDLrP9KQfuXT8SDxeYeJXyj0mgA==}
'@mongodb-js/saslprep@1.3.0': '@mongodb-js/saslprep@1.3.0':
resolution: {integrity: sha512-zlayKCsIjYb7/IdfqxorK5+xUMyi4vOKcFy10wKJYc63NSdKI8mNME+uJqfatkPmOSMMUiojrL58IePKBm3gvQ==} resolution: {integrity: sha512-zlayKCsIjYb7/IdfqxorK5+xUMyi4vOKcFy10wKJYc63NSdKI8mNME+uJqfatkPmOSMMUiojrL58IePKBm3gvQ==}
@ -1293,6 +1314,67 @@ packages:
'@rolldown/pluginutils@1.0.0-beta.18': '@rolldown/pluginutils@1.0.0-beta.18':
resolution: {integrity: sha512-sHG++r1AOeQrzp0Lm3w9TBuaMHty3rU4yCZ4Vd/s428dvv3eTIhuRqHPHJCBlVpZjOJ5b4ZcBPTyRCsDKFt2+w==} resolution: {integrity: sha512-sHG++r1AOeQrzp0Lm3w9TBuaMHty3rU4yCZ4Vd/s428dvv3eTIhuRqHPHJCBlVpZjOJ5b4ZcBPTyRCsDKFt2+w==}
'@rspack/binding-darwin-arm64@1.3.15':
resolution: {integrity: sha512-f+DnVRENRdVe+ufpZeqTtWAUDSTnP48jVo7x9KWsXf8XyJHUi+eHKEPrFoy1HvL1/k5yJ3HVnFBh1Hb9cNIwSg==}
cpu: [arm64]
os: [darwin]
'@rspack/binding-darwin-x64@1.3.15':
resolution: {integrity: sha512-TfUvEIBqYUT2OK01BYXb2MNcZeZIhAnJy/5aj0qV0uy4KlvwW63HYcKWa1sFd4Ac7bnGShDkanvP3YEuHOFOyg==}
cpu: [x64]
os: [darwin]
'@rspack/binding-linux-arm64-gnu@1.3.15':
resolution: {integrity: sha512-D/YjYk9snKvYm1Elotq8/GsEipB4ZJWVv/V8cZ+ohhFNOPzygENi6JfyI06TryBTQiN0/JDZqt/S9RaWBWnMqw==}
cpu: [arm64]
os: [linux]
'@rspack/binding-linux-arm64-musl@1.3.15':
resolution: {integrity: sha512-lJbBsPMOiR0hYPCSM42yp7QiZjfo0ALtX7ws2wURpsQp3BMfRVAmXU3Ixpo2XCRtG1zj8crHaCmAWOJTS0smsA==}
cpu: [arm64]
os: [linux]
'@rspack/binding-linux-x64-gnu@1.3.15':
resolution: {integrity: sha512-qGB8ucHklrzNg6lsAS36VrBsCbOw0acgpQNqTE5cuHWrp1Pu3GFTRiFEogenxEmzoRbohMZt0Ev5grivrcgKBQ==}
cpu: [x64]
os: [linux]
'@rspack/binding-linux-x64-musl@1.3.15':
resolution: {integrity: sha512-qRn6e40fLQP+N2rQD8GAj/h4DakeTIho32VxTIaHRVuzw68ZD7VmKkwn55ssN370ejmey35ZdoNFNE12RBrMZA==}
cpu: [x64]
os: [linux]
'@rspack/binding-win32-arm64-msvc@1.3.15':
resolution: {integrity: sha512-7uJ7dWhO1nWXJiCss6Rslz8hoAxAhFpwpbWja3eHgRb7O4NPHg6MWw63AQSI2aFVakreenfu9yXQqYfpVWJ2dA==}
cpu: [arm64]
os: [win32]
'@rspack/binding-win32-ia32-msvc@1.3.15':
resolution: {integrity: sha512-UsaWTYCjDiSCB0A0qETgZk4QvhwfG8gCrO4SJvA+QSEWOmgSai1YV70prFtLLIiyT9mDt1eU3tPWl1UWPRU/EQ==}
cpu: [ia32]
os: [win32]
'@rspack/binding-win32-x64-msvc@1.3.15':
resolution: {integrity: sha512-ZnDIc9Es8EF94MirPDN+hOMt7tkb8nMEbRJFKLMmNd0ElNPgsql+1cY5SqyGRH1hsKB87KfSUQlhFiKZvzbfIg==}
cpu: [x64]
os: [win32]
'@rspack/binding@1.3.15':
resolution: {integrity: sha512-utNPuJglLO5lW9XbwIqjB7+2ilMo6JkuVLTVdnNVKU94FW7asn9F/qV+d+MgjUVqU1QPCGm0NuGO9xhbgeJ7pg==}
'@rspack/core@1.3.15':
resolution: {integrity: sha512-QuElIC8jXSKWAp0LSx18pmbhA7NiA5HGoVYesmai90UVxz98tud0KpMxTVCg+0lrLrnKZfCWN9kwjCxM5pGnrA==}
engines: {node: '>=16.0.0'}
peerDependencies:
'@swc/helpers': '>=0.5.1'
peerDependenciesMeta:
'@swc/helpers':
optional: true
'@rspack/lite-tapable@1.0.1':
resolution: {integrity: sha512-VynGOEsVw2s8TAlLf/uESfrgfrq2+rcXB1muPJYBWbsm1Oa6r5qVQhjA5ggM6z/coYPrsVMgovl3Ff7Q7OCp1w==}
engines: {node: '>=16.0.0'}
'@sec-ant/readable-stream@0.4.1': '@sec-ant/readable-stream@0.4.1':
resolution: {integrity: sha512-831qok9r2t8AlxLko40y2ebgSDhenenCatLVeW/uBtnHPyhHOvG0C7TvfgecV+wHzIm5KUICgzmVpWS+IMEAeg==} resolution: {integrity: sha512-831qok9r2t8AlxLko40y2ebgSDhenenCatLVeW/uBtnHPyhHOvG0C7TvfgecV+wHzIm5KUICgzmVpWS+IMEAeg==}
@ -5642,6 +5724,31 @@ snapshots:
'@mixmark-io/domino@2.2.0': {} '@mixmark-io/domino@2.2.0': {}
'@module-federation/error-codes@0.14.3': {}
'@module-federation/runtime-core@0.14.3':
dependencies:
'@module-federation/error-codes': 0.14.3
'@module-federation/sdk': 0.14.3
'@module-federation/runtime-tools@0.14.3':
dependencies:
'@module-federation/runtime': 0.14.3
'@module-federation/webpack-bundler-runtime': 0.14.3
'@module-federation/runtime@0.14.3':
dependencies:
'@module-federation/error-codes': 0.14.3
'@module-federation/runtime-core': 0.14.3
'@module-federation/sdk': 0.14.3
'@module-federation/sdk@0.14.3': {}
'@module-federation/webpack-bundler-runtime@0.14.3':
dependencies:
'@module-federation/runtime': 0.14.3
'@module-federation/sdk': 0.14.3
'@mongodb-js/saslprep@1.3.0': '@mongodb-js/saslprep@1.3.0':
dependencies: dependencies:
sparse-bitfield: 3.0.3 sparse-bitfield: 3.0.3
@ -6651,6 +6758,53 @@ snapshots:
'@rolldown/pluginutils@1.0.0-beta.18': {} '@rolldown/pluginutils@1.0.0-beta.18': {}
'@rspack/binding-darwin-arm64@1.3.15':
optional: true
'@rspack/binding-darwin-x64@1.3.15':
optional: true
'@rspack/binding-linux-arm64-gnu@1.3.15':
optional: true
'@rspack/binding-linux-arm64-musl@1.3.15':
optional: true
'@rspack/binding-linux-x64-gnu@1.3.15':
optional: true
'@rspack/binding-linux-x64-musl@1.3.15':
optional: true
'@rspack/binding-win32-arm64-msvc@1.3.15':
optional: true
'@rspack/binding-win32-ia32-msvc@1.3.15':
optional: true
'@rspack/binding-win32-x64-msvc@1.3.15':
optional: true
'@rspack/binding@1.3.15':
optionalDependencies:
'@rspack/binding-darwin-arm64': 1.3.15
'@rspack/binding-darwin-x64': 1.3.15
'@rspack/binding-linux-arm64-gnu': 1.3.15
'@rspack/binding-linux-arm64-musl': 1.3.15
'@rspack/binding-linux-x64-gnu': 1.3.15
'@rspack/binding-linux-x64-musl': 1.3.15
'@rspack/binding-win32-arm64-msvc': 1.3.15
'@rspack/binding-win32-ia32-msvc': 1.3.15
'@rspack/binding-win32-x64-msvc': 1.3.15
'@rspack/core@1.3.15':
dependencies:
'@module-federation/runtime-tools': 0.14.3
'@rspack/binding': 1.3.15
'@rspack/lite-tapable': 1.0.1
'@rspack/lite-tapable@1.0.1': {}
'@sec-ant/readable-stream@0.4.1': {} '@sec-ant/readable-stream@0.4.1': {}
'@sinclair/typebox@0.27.8': {} '@sinclair/typebox@0.27.8': {}

View File

@ -6,10 +6,11 @@
- The main class `TsBundle` spawns child processes using `smartspawn.ThreadSimple` - The main class `TsBundle` spawns child processes using `smartspawn.ThreadSimple`
## Bundler Implementations ## Bundler Implementations
- **esbuild** (default): Fully implemented, production ready - **esbuild** (default): Fully implemented, production ready, 2.2K minified
- **rolldown**: Implemented and working (beta), produces smaller bundles than esbuild - **rolldown**: Implemented and working (beta), produces smallest bundles (1.5K minified)
- **rollup**: Empty module directory exists but not implemented - **rspack**: Implemented and working, webpack-compatible API, 6.1K minified
- **parcel**: Empty module directory exists but not implemented - **rollup**: Removed (was never implemented)
- **parcel**: Removed (was never implemented)
## Adding New Bundlers ## Adding New Bundlers
To add a new bundler, you need: To add a new bundler, you need:
@ -24,12 +25,22 @@ To add a new bundler, you need:
- Rolldown is in beta (v1.0.0-beta.18) but working well - Rolldown is in beta (v1.0.0-beta.18) but working well
- API: Use `rolldown()` function directly, not `rolldown.rolldown()` - API: Use `rolldown()` function directly, not `rolldown.rolldown()`
- Output options go in the `write()` method, not the initial config - Output options go in the `write()` method, not the initial config
- Uses `dir` and `entryFileNames` instead of `file` for output (handles dynamic imports)
- Includes `inlineDynamicImports: true` to avoid chunk splitting issues
- Produces smaller minified bundles than esbuild (1.5K vs 2.2K in tests) - Produces smaller minified bundles than esbuild (1.5K vs 2.2K in tests)
- Supports TypeScript via `resolve.tsconfigFilename` - Supports TypeScript via `resolve.tsconfigFilename`
## Rspack Specific Notes
- Rspack v1.3.15 - stable and production ready
- Uses webpack-compatible API (callback-based)
- Built-in SWC loader for TypeScript transpilation
- Produces larger bundles than esbuild/rolldown due to webpack runtime overhead
- Best choice if you need webpack compatibility or advanced features
- Supports ES modules output via `experiments.outputModule: true`
## CLI Usage ## CLI Usage
- Default bundler: `tsbundle` - Default bundler: `tsbundle` (uses esbuild)
- Specify bundler: `tsbundle --bundler=rolldown` - Specify bundler: `tsbundle --bundler=rolldown` or `tsbundle --bundler=rspack`
- Production mode: `tsbundle --production` - Production mode: `tsbundle --production`
- Combined: `tsbundle --bundler=rolldown --production` - Combined: `tsbundle --bundler=rolldown --production`

337
readme.md
View File

@ -1,71 +1,304 @@
# @git.zone/tsbundle # @git.zone/tsbundle
a bundler using rollup for painless bundling of web projects
## Availabililty and Links A powerful multi-bundler tool supporting esbuild, rolldown, and rspack for painless bundling of web projects.
* [npmjs.org (npm package)](https://www.npmjs.com/package/@git.zone/tsbundle)
* [gitlab.com (source)](https://gitlab.com/gitzone/tsbundle)
* [github.com (source mirror)](https://github.com/gitzone/tsbundle)
* [docs (typedoc)](https://gitzone.gitlab.io/tsbundle/)
## Status for master ## Installation
Status Category | Status Badge ```bash
-- | -- # Global installation for CLI usage
GitLab Pipelines | [![pipeline status](https://gitlab.com/gitzone/tsbundle/badges/master/pipeline.svg)](https://lossless.cloud)
GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/gitzone/tsbundle/badges/master/coverage.svg)](https://lossless.cloud)
npm | [![npm downloads per month](https://badgen.net/npm/dy/@git.zone/tsbundle)](https://lossless.cloud)
Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/gitzone/tsbundle)](https://lossless.cloud)
TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@git.zone/tsbundle)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@git.zone/tsbundle)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@git.zone/tsbundle)](https://lossless.cloud)
Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
## Usage
Use TypeScript for best in class intellisense.
tsbundle will bundle modern JavaScript websites in an Google Bot conformant way so things like AdSense do work.
tsbundle supports two modes of usage: CLI and API usage.
### CLI
```shell
# Note: This is code that belongs into your terminal ;)
# Install the tool for cli usage
# Globally
npm install -g @git.zone/tsbundle npm install -g @git.zone/tsbundle
# Locally for use in your pacakge.json # Local installation for project usage
npm install --save-dev @git.zone/tsbundle npm install --save-dev @git.zone/tsbundle
# then use it
tsbundle --from="./ts/index.ts" --to="dist/bundle.js"
## note you can call tsbundle without arguments. Default values are --from="./ts_web/index.ts" --to="dist_bundle/bundle.js"
## You can use --production to enable minification using terser
``` ```
## API ## Quick Start
You are using TypeScript, aren't you? Most of the stuff is apparent from the IDE intellisense. ### CLI Usage
The simplest way to bundle your project:
```bash
# Bundle with default settings (from ./ts_web/index.ts to ./dist_bundle/bundle.js)
tsbundle
# Bundle with custom paths
tsbundle --from="./src/index.ts" --to="./dist/bundle.js"
# Production build with minification
tsbundle --from="./src/index.ts" --to="./dist/bundle.js" --production
# Use a specific bundler
tsbundle --bundler=rolldown
```
### API Usage
```typescript ```typescript
import { TsBundle } from '@gitozne/tsbundle'; import { TsBundle } from '@git.zone/tsbundle';
const myTsBundleInstance = new TsBundle(); const bundler = new TsBundle();
const run = async () => { // Basic usage
await myTsBundleInstance.buildTest('./from/my.ts', './to/mybundle.js'); await bundler.build(
// OR process.cwd(), // working directory
await myTsBundleInstance.buildProduction('./from/my.ts', './to/mybundle.js'); './src/index.ts', // entry point
}; './dist/bundle.js', // output file
{ bundler: 'esbuild' } // options
);
// Production build with rolldown
await bundler.build(
process.cwd(),
'./src/index.ts',
'./dist/bundle.min.js',
{
bundler: 'rolldown',
production: true
}
);
``` ```
## Available Bundlers
tsbundle supports three modern bundlers, each with its own strengths:
- **esbuild** (default): Extremely fast, great for development
- **rolldown**: Rust-based bundler with excellent tree-shaking
- **rspack**: High-performance bundler with webpack compatibility
Select your bundler using the `--bundler` flag in CLI or the `bundler` option in API.
## CLI Commands
### Default Command
Bundle TypeScript/JavaScript projects:
```bash
tsbundle [options]
Options:
--from Source entry point (default: ./ts_web/index.ts)
--to Output bundle path (default: ./dist_bundle/bundle.js)
--production Enable production mode with minification
--bundler Choose bundler: esbuild, rolldown, or rspack
--commonjs Output CommonJS format instead of ESM
--skiplibcheck Skip TypeScript library checking
```
### Specialized Commands
#### `tsbundle element`
Bundle web components with standard naming conventions:
```bash
tsbundle element
# Bundles from ./ts_web/elements/<elementName>.ts to ./dist_bundle/bundle.js
```
#### `tsbundle npm`
Bundle npm packages for distribution:
```bash
tsbundle npm
# Prepares your package for npm publishing
```
#### `tsbundle website`
Full website bundling with HTML processing and asset handling:
```bash
tsbundle website
# Bundles JavaScript, processes HTML, and copies assets
```
## API Reference
### TsBundle Class
The main bundler class for programmatic usage.
```typescript
import { TsBundle } from '@git.zone/tsbundle';
const bundler = new TsBundle();
// Method signature
await bundler.build(
cwdArg: string, // Working directory
fromArg?: string, // Entry point (default: './ts_web/index.ts')
toArg?: string, // Output path (default: './dist_bundle/bundle.js')
argvArg?: ICliOptions // Configuration options
): Promise<void>
```
#### ICliOptions Interface
```typescript
interface ICliOptions {
bundler: 'esbuild' | 'rolldown' | 'rspack'; // Bundler to use
production?: boolean; // Enable production optimizations
commonjs?: boolean; // Output CommonJS format
skiplibcheck?: boolean; // Skip TypeScript lib checking
}
```
### HtmlHandler Class
Process and minify HTML files:
```typescript
import { HtmlHandler } from '@git.zone/tsbundle';
const htmlHandler = new HtmlHandler();
// Check if HTML files exist
const exists = await htmlHandler.checkIfExists();
// Process HTML with options
await htmlHandler.processHtml({
from: './src/index.html', // Source HTML (default: './html/index.html')
to: './dist/index.html', // Output HTML (default: './dist_serve/index.html')
minify: true // Enable minification
});
```
### AssetsHandler Class
Handle static assets (images, fonts, etc.):
```typescript
import { AssetsHandler } from '@git.zone/tsbundle';
const assetsHandler = new AssetsHandler();
// Ensure assets directory exists
await assetsHandler.ensureAssetsDir();
// Copy and process assets
await assetsHandler.processAssets({
from: './src/assets', // Source directory (default: './assets')
to: './dist/assets' // Output directory (default: './dist_serve/assets')
});
```
## Advanced Examples
### Building a Modern Web Application
```typescript
import { TsBundle, HtmlHandler, AssetsHandler } from '@git.zone/tsbundle';
async function buildWebApp() {
const bundler = new TsBundle();
const htmlHandler = new HtmlHandler();
const assetsHandler = new AssetsHandler();
// Bundle the JavaScript
await bundler.build(
process.cwd(),
'./src/app.ts',
'./dist/app.js',
{
bundler: 'rolldown',
production: true
}
);
// Process HTML
await htmlHandler.processHtml({
from: './src/index.html',
to: './dist/index.html',
minify: true
});
// Copy assets
await assetsHandler.processAssets({
from: './src/assets',
to: './dist/assets'
});
console.log('Build complete!');
}
buildWebApp();
```
### Multi-Entry Point Bundling
```typescript
import { TsBundle } from '@git.zone/tsbundle';
async function buildMultipleEntries() {
const bundler = new TsBundle();
const entries = [
{ from: './src/main.ts', to: './dist/main.js' },
{ from: './src/admin.ts', to: './dist/admin.js' },
{ from: './src/worker.ts', to: './dist/worker.js' }
];
for (const entry of entries) {
await bundler.build(
process.cwd(),
entry.from,
entry.to,
{ bundler: 'esbuild' }
);
}
}
```
### Development vs Production Builds
```typescript
import { TsBundle } from '@git.zone/tsbundle';
const bundler = new TsBundle();
const isDev = process.env.NODE_ENV === 'development';
await bundler.build(
process.cwd(),
'./src/index.ts',
isDev ? './dist/dev/bundle.js' : './dist/prod/bundle.min.js',
{
bundler: isDev ? 'esbuild' : 'rolldown', // esbuild for speed in dev
production: !isDev, // minify in production
commonjs: false // use ES modules
}
);
```
## TypeScript Configuration
tsbundle works best with the following TypeScript configuration:
```json
{
"compilerOptions": {
"target": "ES2022",
"module": "ESNext",
"moduleResolution": "node",
"esModuleInterop": true,
"allowSyntheticDefaultImports": true,
"strict": true
}
}
```
## Best Practices
1. **Entry Points**: Keep your entry points in `ts_web/` for web bundles or `ts/` for library bundles
2. **Output Structure**: Use `dist_bundle/` for bundled files and `dist_serve/` for web-ready files
3. **Bundler Selection**:
- Use `esbuild` for development (fastest)
- Use `rolldown` or `rspack` for production (better optimization)
4. **Assets**: Place static assets in the `assets/` directory
5. **HTML**: Keep HTML templates in the `html/` directory
## Contribution ## Contribution
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :) We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)

41
test/test-decorators.ts Normal file
View File

@ -0,0 +1,41 @@
// Test file to verify decorator functionality
function sealed(constructor: Function) {
Object.seal(constructor);
Object.seal(constructor.prototype);
}
@sealed
class TestClass {
name = 'test';
modify() {
this.name = 'modified';
}
}
// Test that the class is sealed
const instance = new TestClass();
console.log('Initial name:', instance.name);
// This should work (modifying existing property)
instance.modify();
console.log('Modified name:', instance.name);
// This should fail silently in non-strict mode or throw in strict mode
try {
(instance as any).newProperty = 'should not work';
console.log('Adding new property:', (instance as any).newProperty);
} catch (e) {
console.log('Error adding property (expected):', e.message);
}
// Test that we can't add to prototype
try {
(TestClass.prototype as any).newMethod = function() {};
console.log('Prototype is NOT sealed (unexpected)');
} catch (e) {
console.log('Prototype is sealed (expected)');
}
console.log('Is TestClass sealed?', Object.isSealed(TestClass));
console.log('Is TestClass.prototype sealed?', Object.isSealed(TestClass.prototype));

View File

@ -1,17 +1,108 @@
import { expect, tap } from '@push.rocks/tapbundle'; import { expect, tap } from '@git.zone/tstest/tapbundle';
import * as tsbundle from '../ts/index.js'; import * as tsbundle from '../dist_ts/index.js';
import * as path from 'path';
import * as fs from 'fs';
const testBundler = async (bundlerName: 'esbuild' | 'rolldown' | 'rspack', mode: 'test' | 'production') => {
const outputFile = `./dist_manual/${bundlerName}-${mode}.js`;
const testDir = path.join(process.cwd(), 'test');
// Clean up output directory
const outputDir = path.join(testDir, 'dist_manual');
if (!fs.existsSync(outputDir)) {
fs.mkdirSync(outputDir, { recursive: true });
}
// Clean up output file if exists
const outputPath = path.join(testDir, outputFile);
if (fs.existsSync(outputPath)) {
fs.rmSync(outputPath, { force: true });
}
tap.test('should bundle with esbuild', async () => {
const tsbundleInstance = new tsbundle.TsBundle(); const tsbundleInstance = new tsbundle.TsBundle();
await tsbundleInstance.build( await tsbundleInstance.build(
process.cwd() + '/test', testDir,
'./ts_web/index.ts', './ts_web/index.ts',
'./dist_manual/test.js', outputFile,
{ {
bundler: 'esbuild' bundler: bundlerName,
production: mode === 'production'
} }
); );
// Verify output file was created
expect(fs.existsSync(outputPath)).toBeTrue();
console.log(`${bundlerName} ${mode} mode: success`);
};
// Test esbuild
tap.test('should bundle with esbuild in test mode', async () => {
await testBundler('esbuild', 'test');
}); });
tap.test('should bundle with esbuild in production mode', async () => {
await testBundler('esbuild', 'production');
});
// Test rolldown
tap.test('should bundle with rolldown in test mode', async () => {
await testBundler('rolldown', 'test');
});
tap.test('should bundle with rolldown in production mode', async () => {
await testBundler('rolldown', 'production');
});
// Test rspack
tap.test('should bundle with rspack in test mode', async () => {
await testBundler('rspack', 'test');
});
tap.test('should bundle with rspack in production mode', async () => {
await testBundler('rspack', 'production');
});
// Test size comparison
tap.test('should show bundle size comparison', async () => {
const testDir = path.join(process.cwd(), 'test');
const sizes: Record<string, { test: number; production: number }> = {
esbuild: { test: 0, production: 0 },
rolldown: { test: 0, production: 0 },
rspack: { test: 0, production: 0 }
};
for (const bundler of ['esbuild', 'rolldown', 'rspack'] as const) {
for (const mode of ['test', 'production'] as const) {
const filePath = path.join(testDir, `dist_manual/${bundler}-${mode}.js`);
if (fs.existsSync(filePath)) {
const stats = fs.statSync(filePath);
sizes[bundler][mode] = stats.size;
}
}
}
console.log('\n📊 Bundle Size Comparison:');
console.log('┌─────────────┬────────────┬──────────────┐');
console.log('│ Bundler │ Test Mode │ Production │');
console.log('├─────────────┼────────────┼──────────────┤');
for (const bundler of ['esbuild', 'rolldown', 'rspack'] as const) {
const testSize = (sizes[bundler].test / 1024).toFixed(1) + ' KB';
const prodSize = (sizes[bundler].production / 1024).toFixed(1) + ' KB';
console.log(`${bundler.padEnd(11)}${testSize.padEnd(10)}${prodSize.padEnd(12)}`);
}
console.log('└─────────────┴────────────┴──────────────┘');
// Verify all sizes are reasonable
for (const bundler of ['esbuild', 'rolldown', 'rspack'] as const) {
expect(sizes[bundler].test).toBeGreaterThan(0);
expect(sizes[bundler].production).toBeGreaterThan(0);
// Production bundles should generally be smaller due to minification
// but rspack might be larger due to runtime overhead
if (bundler !== 'rspack') {
expect(sizes[bundler].production).toBeLessThan(sizes[bundler].test);
}
}
});
tap.start(); tap.start();

37
test/ts_web/test-lit.ts Normal file
View File

@ -0,0 +1,37 @@
import { LitElement, html, css } from 'lit';
import { customElement, property } from 'lit/decorators.js';
@customElement('my-element')
export class MyElement extends LitElement {
static styles = css`
:host {
display: block;
padding: 16px;
}
`;
@property({ type: String })
name = 'World';
@property({ type: Number })
count = 0;
render() {
return html`
<h1>Hello, ${this.name}!</h1>
<button @click=${this._onClick}>
Click Count: ${this.count}
</button>
`;
}
private _onClick() {
this.count++;
}
}
// Test instantiation
const element = new MyElement();
console.log('Element created:', element);
console.log('Element name:', element.name);
console.log('Element count:', element.count);

View File

@ -3,6 +3,6 @@
*/ */
export const commitinfo = { export const commitinfo = {
name: '@git.zone/tsbundle', name: '@git.zone/tsbundle',
version: '2.3.0', version: '2.5.0',
description: 'a bundler using rollup for painless bundling of web projects' description: 'a multi-bundler tool supporting esbuild, rolldown, and rspack for painless bundling of web projects'
} }

View File

@ -2,7 +2,7 @@ export interface ICliOptions {
commonjs?: boolean; commonjs?: boolean;
skiplibcheck?: boolean; skiplibcheck?: boolean;
production?: boolean; production?: boolean;
bundler: 'parcel' | 'esbuild' | 'rollup' | 'rolldown' bundler: 'esbuild' | 'rolldown' | 'rspack'
} }
export interface IEnvTransportOptions { export interface IEnvTransportOptions {

View File

@ -61,7 +61,7 @@ export class TsBundleProcess {
format: 'esm', format: 'esm',
target: 'es2022', target: 'es2022',
minify: true, minify: true,
entryNames: 'bundle', entryNames: plugins.path.parse(toArg).name,
outdir: plugins.path.parse(toArg).dir, outdir: plugins.path.parse(toArg).dir,
tsconfig: paths.tsconfigPath, tsconfig: paths.tsconfigPath,
splitting: false, splitting: false,

View File

@ -39,10 +39,15 @@ export class TsBundleProcess {
}, },
}); });
const outputDir = plugins.path.dirname(toArg);
const outputFilename = plugins.path.basename(toArg);
await result.write({ await result.write({
file: toArg, dir: outputDir,
entryFileNames: outputFilename,
format: 'es', format: 'es',
sourcemap: true, sourcemap: true,
inlineDynamicImports: true,
}); });
} }
@ -66,11 +71,16 @@ export class TsBundleProcess {
}, },
}); });
const outputDir = plugins.path.dirname(toArg);
const outputFilename = plugins.path.basename(toArg);
await result.write({ await result.write({
file: toArg, dir: outputDir,
entryFileNames: outputFilename,
format: 'es', format: 'es',
sourcemap: true, sourcemap: true,
minify: true, minify: true,
inlineDynamicImports: true,
}); });
} }
} }

View File

@ -0,0 +1,236 @@
import * as plugins from './plugins.js';
import * as paths from '../paths.js';
import * as interfaces from '../interfaces/index.js';
import { logger } from '../tsbundle.logging.js';
export class TsBundleProcess {
constructor() {
// Nothing here
}
public async getAliases() {
try {
const aliasObject: Record<string, string> = {};
const localTsConfig = plugins.smartfile.fs.toObjectSync(
plugins.path.join(paths.cwd, 'tsconfig.json')
);
if (localTsConfig.compilerOptions && localTsConfig.compilerOptions.paths) {
for (const alias of Object.keys(localTsConfig.compilerOptions.paths)) {
const aliasPath = localTsConfig.compilerOptions.paths[alias][0];
// Convert TypeScript path to absolute path for rspack
aliasObject[alias.replace('/*', '')] = plugins.path.resolve(paths.cwd, aliasPath.replace('/*', ''));
}
}
return aliasObject;
} catch (error) {
return {};
}
}
/**
* creates a bundle for the test enviroment
*/
public async buildTest(fromArg: string, toArg: string, argvArg: any) {
const aliases = await this.getAliases();
const outputDir = plugins.path.dirname(toArg);
const outputFilename = plugins.path.basename(toArg);
const config = {
mode: 'development' as const,
entry: {
main: fromArg,
},
output: {
path: outputDir,
filename: outputFilename,
library: {
type: 'module' as const,
},
},
devtool: 'source-map' as const,
resolve: {
alias: aliases,
extensions: ['.ts', '.tsx', '.js', '.jsx'],
},
module: {
rules: [
{
test: /\.tsx?$/,
exclude: /node_modules/,
use: {
loader: 'builtin:swc-loader',
options: {
jsc: {
parser: {
syntax: 'typescript',
tsx: true,
decorators: true,
},
target: 'es2022',
transform: {
decoratorVersion: '2022-03',
},
},
},
},
type: 'javascript/auto',
},
],
},
experiments: {
outputModule: true,
},
};
return new Promise((resolve, reject) => {
plugins.rspack(config, (err, stats) => {
if (err) {
console.error(err.stack || err);
reject(err);
return;
}
if (stats.hasErrors()) {
console.error(stats.toString());
reject(new Error('Build failed with errors'));
return;
}
console.log(stats.toString({
colors: true,
modules: false,
children: false,
chunks: false,
chunkModules: false,
}));
resolve(undefined);
});
});
}
/**
* creates a bundle for the production environment
*/
public async buildProduction(fromArg: string, toArg: string, argvArg: any) {
console.log('rspack specific:');
console.log(`from: ${fromArg}`);
console.log(`to: ${toArg}`);
const aliases = await this.getAliases();
const outputDir = plugins.path.dirname(toArg);
const outputFilename = plugins.path.basename(toArg);
const config = {
mode: 'production' as const,
entry: {
main: fromArg,
},
output: {
path: outputDir,
filename: outputFilename,
library: {
type: 'module' as const,
},
},
devtool: 'source-map' as const,
resolve: {
alias: aliases,
extensions: ['.ts', '.tsx', '.js', '.jsx'],
},
module: {
rules: [
{
test: /\.tsx?$/,
exclude: /node_modules/,
use: {
loader: 'builtin:swc-loader',
options: {
jsc: {
parser: {
syntax: 'typescript',
tsx: true,
decorators: true,
},
target: 'es2022',
transform: {
decoratorVersion: '2022-03',
},
minify: {
compress: true,
mangle: true,
},
},
},
},
type: 'javascript/auto',
},
],
},
optimization: {
minimize: true,
concatenateModules: true,
usedExports: true,
sideEffects: true,
},
experiments: {
outputModule: true,
},
};
return new Promise((resolve, reject) => {
plugins.rspack(config, (err, stats) => {
if (err) {
console.error(err.stack || err);
reject(err);
return;
}
if (stats.hasErrors()) {
console.error(stats.toString());
reject(new Error('Build failed with errors'));
return;
}
console.log(stats.toString({
colors: true,
modules: false,
children: false,
chunks: false,
chunkModules: false,
}));
resolve(undefined);
});
});
}
}
const run = async () => {
console.log('running spawned compilation process');
const transportOptions: interfaces.IEnvTransportOptions = JSON.parse(
process.env.transportOptions
);
console.log('=======> RSPACK');
console.log(transportOptions);
process.chdir(transportOptions.cwd);
console.log(`switched to ${process.cwd()}`);
const tsbundleProcessInstance = new TsBundleProcess();
if (transportOptions.mode === 'test') {
console.log('building for test:');
await tsbundleProcessInstance.buildTest(
plugins.smartpath.transform.makeAbsolute(transportOptions.from, process.cwd()),
plugins.smartpath.transform.makeAbsolute(transportOptions.to, process.cwd()),
transportOptions.argv
);
} else {
console.log('building for production:');
await tsbundleProcessInstance.buildProduction(
plugins.smartpath.transform.makeAbsolute(transportOptions.from, process.cwd()),
plugins.smartpath.transform.makeAbsolute(transportOptions.to, process.cwd()),
transportOptions.argv
);
}
};
run();

5
ts/mod_rspack/plugins.ts Normal file
View File

@ -0,0 +1,5 @@
export * from '../plugins.js';
import { rspack } from '@rspack/core';
export { rspack }

View File

@ -15,10 +15,8 @@ export class TsBundle {
switch (argvArg.bundler) { switch (argvArg.bundler) {
case 'rolldown': case 'rolldown':
return './mod_rolldown/index.child.js'; return './mod_rolldown/index.child.js';
case 'rollup': case 'rspack':
return './mod_rollup/index.child.js'; return './mod_rspack/index.child.js';
case 'parcel':
return './mod_parcel/index.child.js';
case 'esbuild': case 'esbuild':
default: default:
return './mod_esbuild/index.child.js'; return './mod_esbuild/index.child.js';