Skip to content

Latest commit

 

History

History
121 lines (83 loc) · 4.2 KB

README.md

File metadata and controls

121 lines (83 loc) · 4.2 KB
Raw

Social Card of Bun Plugin dtsx

npm version GitHub Actions Commitizen friendly npm downloads

This Bun plugin generates dts files for your TypeScript projects.

Features

  • Automatic & fast dts generation
  • Powered by Bun & isolatedDeclarations
  • Monorepo support

Usage

bun install -d bun-plugin-dtsx

You may now use the plugin:

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

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, 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.

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 💙