bun-plugin-dts-auto

This Bun plugin generates dts files for your TypeScript project.

Features

Automatic dts generation based on your entrypoints
Support for source map generations
Honors & inherits your tsconfig.json settings

Usage

bun install -d bun-plugin-dts-auto

You may now use the plugin:

import dts from 'bun-plugin-dts-auto'

await Bun.build({
  root: './src', // optional

  entrypoints: [
    'src/index.ts',
  ],

  outdir: './dist',

  plugins: [
    dts({
      cwd: import.meta.dir, // optional
      rootDir: `${import.meta.dir}/src`, // optional
      withSourceMap: true, // optional
      outdir: 'dist/types', // optional
    }),
  ],
})

console.log('Build complete ✅')

Note

Please note, this plugin honors your tsconfig.json compilerOptions.outDir setting. If you want to override this, you can do so by setting the outdir, rootDir, and cwd option in the build object.

Testing

bun test

Changelog

Please see our releases page for more information on what has changed recently.

Contributing

Please review the Contributing Guide for details.

Community

For help, discussion about best practices, or any other conversation that would benefit from being searchable:

Discussions on GitHub

For casual chit-chat with others using this package:

Join the Stacks Discord Server

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, 5710 Crescent Park #107, Playa Vista 90094, CA.

Credits

Many thanks to the following core technologies & people who have contributed to this package:

License

The MIT License (MIT). Please see LICENSE for more information.

Made with 💙

stacksjs / bun-plugin-dts-auto Goto Github PK