dts-obvi-bundle-webpack-plugin

Webpack Bundle Typescript Definitions

Bundles the typescript definitions of your bundled webpack definitions in a way that is obviously what you want, not what the rest of the community is offering.

What Does This Do

Bundles all, and I mean ALL, of the types that are exported in your bundle. When you're using webpack you may intentionally bundle 3rd party dependencies and re-export them. This pattern is useful for extending existing projects, reducing dependencies, tree-shaking / reducing dependency size, security patching in controlled environments.

If you're not bundling external dependencies then you do not want this. There are other typescript definitions bundlers out there you might want:

• dts-bundle
• npm-dts
• dts-bundle-generator

These other bundlers either do not bundle 3rd party modules or require you to write code a specific way or export everything in a global namespace.

Usage

npm i -D dts-obvi-bundle-webpack-plugin

// webpack.config.js
const DtsObviBundlePlugin = require("dts-obvi-bundle-webpack-plugin");


module.exports = {
  ...
  plugins: [
    new DtsObviBundlePlugin(),
  ]
}

Options

DtsObviBundlePluginOptions : object

Properties

Name	Type	Default	Description
[compilerOptions]	ts.CompilerOptions	{}	tsconfig compilerOptions to override your tsconfig definition
[config]	string	"tsconfig.json"	Path to tsconfig.json
[entry]	string		Entry to your .d.ts type definitions
[excludes]	Array.<string> | Array.<RegExp>	[]	list of node_modules to exclude type definitions for
[out]	string	"obvi-types"	output path relative to webpack output directory to store generated types