gentleeduck/duck-ui / .claude/skills/tsdown
tsdown
VerifiedBundle TypeScript and JavaScript libraries with blazing-fast speed powered by Rolldown. Use when building libraries, generating type declarations, bundling for multiple formats, or migrating from tsup.
references/option-cjs-default.md
View on GitHub# CJS Default Export
Control how default exports are handled in CommonJS output.
## Overview
The `cjsDefault` option improves compatibility when generating CommonJS modules. When enabled (default), modules with only a single default export use `module.exports = ...` instead of `exports.default = ...`.
## Type
```ts
cjsDefault?: boolean // default: true
```
## Basic Usage
### Enabled (Default)
```ts
export default defineConfig({
entry: ['src/index.ts'],
format: ['cjs'],
cjsDefault: true, // default behavior
})
```
### Disabled
```ts
export default defineConfig({
entry: ['src/index.ts'],
format: ['cjs'],
cjsDefault: false,
})
```
## How It Works
### With `cjsDefault: true` (Default)
When your module has **only a single default export**, tsdown transforms:
**Source:**
```ts
// src/index.ts
export default function greet() {
console.log('Hello, world!')
}
```
**Generated CJS:**
```js
// dist/index.cjs
function greet() {
console.log('Hello, world!')
}
module.exports = greet
```
**Generated Declaration:**
```ts
// dist/index.d.cts
declare function greet(): void
export = greet
```
This allows consumers to use `const greet = require('your-module')` directly.
### With `cjsDefault: false`
The default export stays as `exports.default`:
```js
// dist/index.cjs
function greet() {
console.log('Hello, world!')
}
exports.default = greet
```
Consumers need `require('your-module').default`.
## When to Disable
- When your module has both default and named exports
- When you need consistent `exports.default` behavior
- When consumers always use ESM imports
## Tips
1. **Leave enabled** for most libraries (default `true`)
2. **Disable** if you have both default and named exports and need consistent behavior
3. **Test CJS consumers** to verify compatibility
## Related Options
- [Output Format](option-output-format.md) - Module formats
- [Shims](option-shims.md) - ESM/CJS compatibility
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| receiving-code-reviewobra/superpowersUse when receiving code review feedback, before implementing suggestions, especially if feedback seems unclear or technically questionable - requires technical rigor and verification, not performative agreement or blind implementation | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| requesting-code-reviewobra/superpowersUse when completing tasks, implementing major features, or before merging to verify work meets requirements | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| using-git-worktreesobra/superpowersUse when starting feature work that needs isolation from current workspace or before executing implementation plans - ensures an isolated workspace exists via native tools or git worktree fallback | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| verification-before-completionobra/superpowersUse when about to claim work is complete, fixed, or passing, before committing or creating PRs - requires running verification commands and confirming output before making any success claims; evidence before assertions always | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |