bundle-declarations-webpack-plugin

Example usage

Simplest scenario

As of version 3.1.0, it's possible to omit the configuration overrides; when you do this, the plugin will fallback on webpack's entrypoints and other defaults.

1import BundleDeclarationsWebpackPlugin from "bundle-declarations-webpack-plugin";
2import { resolve } from "path";
3import type { Configuration } from "webpack";
4
5export default <Configuration> {
6    entry: "./src/main.ts",
7    output: {
8        filename: "index.js",
9        path: resolve("./dist"),
10    },
11    plugins: [
12        `...`,
13        new BundleDeclarationsWebpackPlugin(),
14    ],
15};

The configuration above adds the plugin with default options. All typescript included/imported by the ./src/main.ts file is transpiled to ./dist/index.js and all exported types for the bundle are added to the output directory with the default name index.d.ts.
Just to be clear, currently the output filename is defaulted to this value, but the key in webpack's entry is not considered/applied if set as it is with the webpack bundle.

Most common scenario

Usually you will want to include all types which are visible on the surface of a library, but the entry and outFile may not necessarily match with your webpack bundle.

1import BundleDeclarationsWebpackPlugin from "bundle-declarations-webpack-plugin";
2import type { Configuration } from "webpack";
3
4export default <Configuration> {
5    plugins: [
6        `...`,
7        new BundleDeclarationsWebpackPlugin({
8            entry: ["./src/index.ts", "./src/globals.ts"],
9            outFile: "main.d.ts",
10        }),
11    ]
12}

In the above example, the exports of index.ts and globals.ts are combined into webpack's output as main.d.ts.

When you need control of dts-bundle-generator

1import BundleDeclarationsWebpackPlugin from "bundle-declarations-webpack-plugin";
2import type { Configuration } from "webpack";
3
4export default <Configuration> {
5    plugins: [
6        `...`,
7        new BundleDeclarationsWebpackPlugin({
8            entry: {
9                filePath: "./src/index.ts",
10                libraries: {
11                    inlinedLibraries: [
12                        "tsyringe",
13                    ],
14                },
15                output: {
16                    sortNodes: false,
17                    // dts-bundle-generator comments in output
18                    noBanner: false, 
19                }
20            },
21            outFile: "index.d.ts",
22
23            compilationOptions: {
24                followSymlinks: true,
25                preferredConfigPath: "./some/tsconfig.json",
26            },
27            
28            // setting these will mean no post-processing
29            removeEmptyLines: false,
30            removeEmptyExports: false,
31            removeRelativeReExport: false,
32        }),
33    ]
34}

Multiple entrypoints with different config

Assuming you want to combine into 1 .d.ts bundle, this can be achieved by providing an array of EntryPointConfigs to a single plugin instance's entry option.

Multiple bundles

This is expected, it should be completely safe to use multiple instances of the plugin as part of webpack's parallel builds; in fact the only thing stopping you from reusing the same instance is that the options are shared (which might be fine in some cases).

Watch mode

As of version 4.0.0, .d.ts bundling runs as a background process while webpack is in watch mode; this means that it will no longer delay incremental builds, but consequently the declarations may become out of sync with the webpack compilations.
Also note that the plugin will output to the file system even when shouldEmit returns false.