wobsoriano / bun-plugin-dts

A Bun plugin for generating dts files.

bun-plugin-dts

A Bun plugin for generating .d.ts files.

Install

bun add -d bun-plugin-dts

Usage

import dts from 'bun-plugin-dts'

await Bun.build({
  entrypoints: ['./src/index.ts', './src/other.ts'],
  outdir: './dist',
  plugins: [
    dts()
  ],
})

// Generates `dist/index.d.ts` and `dist/other.d.ts`

Options

This plugin utilizes dts-bundle-generator internally, allowing you to easily customize its behavior by passing specific options for dts-bundle-generator.

type Options = {
  libraries?: LibrariesOptions;
  /**
   * Fail if generated dts contains class declaration.
   */
  failOnClass?: boolean;
  output?: OutputOptions;
  compilationOptions?: CompilationOptions;
}

interface LibrariesOptions {
  /**
   * Array of package names from node_modules to inline typings from.
   * Used types will be inlined into the output file.
   */
  inlinedLibraries?: string[];
  /**
   * Array of package names from node_modules to import typings from.
   * Used types will be imported using `import { First, Second } from 'library-name';`.
   * By default all libraries will be imported (except inlined libraries and libraries from @types).
   */
  importedLibraries?: string[];
  /**
   * Array of package names from @types to import typings from via the triple-slash reference directive.
   * By default all packages are allowed and will be used according to their usages.
   */
  allowedTypesLibraries?: string[];
}

interface OutputOptions {
  /**
   * Sort output nodes in ascendant order.
   */
  sortNodes?: boolean;
  /**
   * Name of the UMD module.
   * If specified then `export as namespace ModuleName;` will be emitted.
   */
  umdModuleName?: string;
  /**
   * Enables inlining of `declare global` statements contained in files which should be inlined (all local files and packages from inlined libraries).
   */
  inlineDeclareGlobals?: boolean;
  /**
   * Enables inlining of `declare module` statements of the global modules
   * (e.g. `declare module 'external-module' {}`, but NOT `declare module './internal-module' {}`)
   * contained in files which should be inlined (all local files and packages from inlined libraries)
   */
  inlineDeclareExternals?: boolean;
  /**
   * Allows remove "Generated by dts-bundle-generator" comment from the output
   */
  noBanner?: boolean;
  /**
   * Enables stripping the `const` keyword from every direct-exported (or re-exported) from entry file `const enum`.
   * This allows you "avoid" the issue described in https://github.com/microsoft/TypeScript/issues/37774.
   */
  respectPreserveConstEnum?: boolean;
  /**
   * By default all interfaces, types and const enums are marked as exported even if they aren't exported directly.
   * This option allows you to disable this behavior so a node will be exported if it is exported from root source file only.
   */
  exportReferencedTypes?: boolean;
}

interface CompilationOptions {
  /**
   * Allows disable resolving of symlinks to the original path.
   * By default following is enabled.
   * @see https://github.com/timocov/dts-bundle-generator/issues/39
   */
  followSymlinks?: boolean;
  /**
   * Path to the tsconfig file that will be used for the compilation.
   */
  preferredConfigPath?: string;
}

License

MIT

bun-plugin-dts's Issues

Problems with nested entries with the same name

for a file structure like this:

src
 - core / index.ts
 - lib / index.ts
 - something / index.ts
 - etc / index.ts

there is only one index file generated and it's in the root of the outdir

dist
 - core / index.js
 - ...
 - index.d.ts

and it's not all of them combined but rather the last one - so in this example contents of etc / index.ts entrypoint

`export * as Module from './Module'` doesn't generate any types

I have prepared a repo to show this problem: https://github.com/JacobWeisenburger/dts_bug_repo

I'm trying to do export * as Module from './Module' but when I run my build script, it doesn't generate any types. See code below (also in repo)

scripts/build.ts

import dts from 'bun-plugin-dts'
// ...
await Bun.build( {
    entrypoints: [ './src/index.ts' ],
    outdir: './dist',
    plugins: [
        dts()
    ],
} )
// ...

src/index.ts

export * as fooModule from './fooModule'

src/fooModule.ts

export * from './foo.ts'

src/foo.ts

export function foo () { return 'foo' }

dist/index.d.ts

// Generated by dts-bundle-generator v8.1.2
export {};

Bump `dts-bundle-generator` version to `9.4.0`

I recently posted this issue on the dts-bundle-generator repo: timocov/dts-bundle-generator#314.

The author kindly released a fix on the DTS bundling side of things to improve performance which subsequently fixed the issue.

The new version is 9.4.0

Throws error for imported assets

This plugin throws an error when resolving imported assets as described by the Bun documentation here:

Files

• ./index.ts
• ./desert/background.png

// index.ts
import desertViewTowerUrl from './desert/background.jpg'

Output

error TS2307: Cannot find module './desert/background.jpg' or its corresponding type declarations.

Expected Behavior

I would expect this plugin to skip anything that Bun considers to be an asset.