https://github.com/eth-p/esbuild-plugin-dts-bundle-generator

An esbuild plugin that builds d.ts bundles using `dts-bundle-generator`.
https://github.com/eth-p/esbuild-plugin-dts-bundle-generator

Last synced: 6 days ago
JSON representation

An esbuild plugin that builds d.ts bundles using `dts-bundle-generator`.

• Host: GitHub
• URL: https://github.com/eth-p/esbuild-plugin-dts-bundle-generator
• Owner: eth-p
• Created: 2023-04-13T00:20:51.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-04-13T04:00:11.000Z (over 1 year ago)
• Last Synced: 2024-10-08T13:54:17.466Z (26 days ago)
• Language: TypeScript
• Size: 57.6 KB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# esbuild-plugin-dts-bundle-generator

An [esbuild](https://esbuild.github.io/) plugin to generate bundles of `.d.ts` definitions using [dts-bundle-generator](https://www.npmjs.com/package/dts-bundle-generator).

## Usage

Inside your esbuild build script:

```js

import * as esbuild from 'esbuild';

import esbuildPluginDtsBundleGenerator from 'esbuild-plugin-dts-bundle-generator';

await esbuild.build({

	// ...

	plugins: [esbuildPluginDtsBundleGenerator(/* options */)],

});

```

### Options

Everything should just work out of the box, but there are a couple of options that can be changed:

```typescript

interface Options {

	/**

	 * Alternate entry points for generating d.ts files.

	 * This follows the same format as `esbuild`'s `entryPoints` option.

	 */

	entryPoints?: Record | Array<{ in: string; out: string }>;

	/**

	 * The path to the project tsconfig file.

	 *

	 * If this is not specified, it will try to use the `tsconfig` option provided to `esbuild`.

	 * If neither options were specified, the nearest `tsconfig.json` file will be used.

	 */

	tsconfig?: string;

	/**

	 * ADVANCED CONFIGURATION:

	 *

	 * A function that is called for each entry point file, creating an `EntryPointConfig` to be used by `dts-bundle-generator`.

	 * This function cannot override the `filePath` property.

	 *

	 * @param entrypoint The entrypoint file.

	 * @returns The corresponding `EntryPointConfig`.

	 */

	configureEntryPoint?: (entrypoint: string) => EntryPointConfig;

	/**

	 * The default `OutputOptions` given to `dts-bundle-generator`.

	 * If `configureEntryPoint` returns output options, that will take precedence.

	 */

	outputOptions?: OutputOptions;

	/**

	 * The default `LibrariesOptions` given to `dts-bundle-generator`.

	 * If `configureEntryPoint` returns output options, that will take precedence.

	 */

	librariesOptions?: LibrariesOptions;

	/**

	 * The `CompilationOptions` given to `dts-bundle-generator`.

	 * This cannot override the `entryPoints` property.

	 */

	compilationOptions?: CompilationOptions;

}

```