tsdx

# TSDX

Zero-config CLI for TypeScript package development.

[![CI](https://github.com/jaredpalmer/tsdx/actions/workflows/nodejs.yml/badge.svg)](https://github.com/jaredpalmer/tsdx/actions/workflows/nodejs.yml)
[![npm](https://img.shields.io/npm/v/tsdx.svg)](https://www.npmjs.com/package/tsdx)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

Modern TypeScript library development, simplified. TSDX provides a zero-config CLI that helps you develop, test, and publish TypeScript packages with ease.

> **TSDX 2.0** is a complete rewrite using modern, high-performance Rust-based tooling. See the [Migration Guide](./MIGRATION.md) if upgrading from v0.x

## Features

- **Zero config** - Sensible defaults, just start coding
- **Modern tooling** - Built on [bunchee](https://github.com/huozhi/bunchee), [vitest](https://vitest.dev/), [oxlint](https://oxc.rs/docs/guide/usage/linter.html), and [oxfmt](https://oxc.rs/docs/guide/usage/formatter)
- **Dual ESM/CJS** - Automatic dual module builds with proper exports
- **TypeScript first** - Full TypeScript support with declaration generation
- **Lightning fast** - Rust-powered linting (50-100x faster than ESLint) and formatting (35x faster than Prettier)
- **Bun-native** - Uses bun for package management
- **Modern Node.js** - Supports Node.js 20+ (LTS)

## Quick Start

```bash
# Create a new package
bunx tsdx create mylib

# Navigate to the project
cd mylib

# Start development
bun run dev
```

That's it! Start editing `src/index.ts` and build your library.

## Installation

### Global Installation (recommended for creating projects)

```bash
bun add -g tsdx
```

### Per-Project Installation

```bash
bun add -D tsdx
```

## Commands

### `tsdx create <name>`

Create a new TypeScript package from a template.

```bash
# Interactive template selection
bunx tsdx create mylib

# Specify template directly
bunx tsdx create mylib --template react
```

**Available Templates:**

| Template | Description |
|----------|-------------|
| `basic` | A basic TypeScript library with vitest |
| `react` | A React component library with Testing Library |

### `tsdx build`

Build the package for production using [bunchee](https://github.com/huozhi/bunchee).

```bash
tsdx build

# Skip cleaning dist folder
tsdx build --no-clean
```

Outputs ESM and CommonJS formats with TypeScript declarations.

### `tsdx dev` / `tsdx watch`

Start development mode with file watching.

```bash
tsdx dev
```

Rebuilds automatically when files change.

### `tsdx test`

Run tests using [vitest](https://vitest.dev/).

```bash
# Run tests once
tsdx test

# Watch mode
tsdx test --watch

# With coverage
tsdx test --coverage

# Update snapshots
tsdx test --update
```

### `tsdx lint`

Lint the codebase using [oxlint](https://oxc.rs/docs/guide/usage/linter.html).

```bash
# Lint src and test directories (default)
tsdx lint

# Lint specific paths
tsdx lint src lib

# Auto-fix issues
tsdx lint --fix

# Use