Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stacksjs/bun-plugin-dtsx
Automatically generate your TypeScript .d.ts files, using Bun's bundler. Very fast.
https://github.com/stacksjs/bun-plugin-dtsx
bun bun-plugin dts generation oxc tsconfig types
Last synced: about 2 months ago
JSON representation
Automatically generate your TypeScript .d.ts files, using Bun's bundler. Very fast.
- Host: GitHub
- URL: https://github.com/stacksjs/bun-plugin-dtsx
- Owner: stacksjs
- License: mit
- Created: 2023-07-31T06:30:23.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-08T13:54:54.000Z (about 2 months ago)
- Last Synced: 2024-11-08T14:42:03.885Z (about 2 months ago)
- Topics: bun, bun-plugin, dts, generation, oxc, tsconfig, types
- Language: TypeScript
- Homepage:
- Size: 2.14 MB
- Stars: 15
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
[![npm version][npm-version-src]][npm-version-href]
[![GitHub Actions][github-actions-src]][github-actions-href]
[](http://commitizen.github.io/cz-cli/)
[![npm downloads][npm-downloads-src]][npm-downloads-href]
This Bun plugin generates dts files for your TypeScript projects.
## Features
- Automatic & fast dts generation
- Powered by Bun & isolatedDeclarations
- Monorepo support
## Usage
```bash
bun install -d bun-plugin-dtsx
```
You may now use the plugin:
```ts
import dts from 'bun-plugin-dtsx'
// if you prefer named imports
// import { dts } from 'bun-plugin-dtsx'
await Bun.build({
root: './src',
entrypoints: [
'src/index.ts',
],
outdir: './dist',
plugins: [
dts({
cwd: './', // optional, default: process.cwd()
root: './src', // optional, default: './src'
outdir: './dist/types', // optional, default: './dist'
keepComments: true, // optional, default: true
tsconfigPath: './tsconfig.json', // optional, default: './tsconfig.json'
}),
],
})
console.log('Build complete ✅')
```
## API
The `dts` plugin accepts an options object with the following properties:
- `cwd`: The current working directory _(optional, default: `process.cwd()`)_
- `root`: The root directory of your TypeScript files _(optional, default: `'src'`)_
- `outdir`: The output directory for generated declaration files _(optional, default: `'./dist'`)_
- `entrypoints`: An array or glob of file paths, or a single file path, to process _(optional, if not specified, defaults to build entrypoints)_
- `keepComments`: Whether to keep comments in the generated dts files _(optional, default: `true`)_
- `tsconfigPath`: The path to your tsconfig file _(optional, default: `'./tsconfig.json'`)_
## Testing
```bash
bun test
```
## Changelog
Please see our [releases](https://github.com/stacksjs/bun-plugin-dtsx/releases) page for more information on what has changed recently.
## Contributing
Please review the [Contributing Guide](https://github.com/stacksjs/contributing) for details.
## Community
For help, discussion about best practices, or any other conversation that would benefit from being searchable:
[Discussions on GitHub](https://github.com/stacksjs/stacks/discussions)
For casual chit-chat with others using this package:
[Join the Stacks Discord Server](https://discord.gg/stacksjs)
## Postcardware
You will always be free to use any of the Stacks OSS software. We would also love to see which parts of the world Stacks ends up in. _Receiving postcards makes us happy—and we will publish them on our website._
Our address: Stacks.js, 12665 Village Ln #2306, Playa Vista, CA 90094, United States 🌎
## Sponsors
We would like to extend our thanks to the following sponsors for funding Stacks development. If you are interested in becoming a sponsor, please reach out to us.
- [JetBrains](https://www.jetbrains.com/)
- [The Solana Foundation](https://solana.com/)
## Credits
Many thanks to the following core technologies & people who have contributed to this package:
- [Oxc](https://oxc.rs/)
- [Chris Breuer](https://github.com/chrisbbreuer)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [LICENSE](https://github.com/stacksjs/bun-plugin-dtsx/tree/main/LICENSE.md) for more information.
Made with 💙
[npm-version-src]:
[npm-version-href]:
[npm-downloads-src]:
[npm-downloads-href]:
[github-actions-src]:
[github-actions-href]: