DTS plugin for WebPack

Inspired by this blog post.

This is wrapper for dts-bundle plugin to use inside WebPack build. Generates bundle from the .d.ts declaration files generated by a TypeSript compiler.

Installation

npm i dts-bundle-webpack --save-dev

Usage

1const DtsBundleWebpack = require('dts-bundle-webpack')
2
3// webpack config
4{
5  plugins: [
6    new DtsBundleWebpack({options})
7  ]
8}

List of possible options are the same as for dts-bundle plugin:

Example of all options:

1var opts = {
2
3    // Required
4
5    // name of module like in package.json
6    // - used to declare module & import/require
7    name: 'cool-project',
8    // path to entry-point (generated .d.ts file for main module)
9    // if you want to load all .d.ts files from a path recursively you can use "path/project/**/*.d.ts"
10    //  ^ *** Experimental, TEST NEEDED, see "All .d.ts files" section 
11    // - either relative or absolute
12    main: 'build/index.d.ts',
13
14    // Optional
15
16    // base directory to be used for discovering type declarations (i.e. from this project itself)
17    // - default: dirname of main
18    baseDir: 'build',
19    // path of output file. Is relative from baseDir but you can use absolute paths. 
20    // if starts with "~/" then is relative to current path. See https://github.com/TypeStrong/dts-bundle/issues/26
21    //  ^ *** Experimental, TEST NEEDED    
22    // - default: "<baseDir>/<name>.d.ts"
23    out: 'dist/cool-project.d.ts',
24    // include typings outside of the 'baseDir' (i.e. like node.d.ts)
25    // - default: false
26    externals: false,
27    // reference external modules as <reference path="..." /> tags *** Experimental, TEST NEEDED
28    // - default: false
29    referenceExternals: false,
30    // filter to exclude typings, either a RegExp or a callback. match path relative to opts.baseDir
31    // - RegExp: a match excludes the file
32    // - function: (file:String, external:Boolean) return true to exclude, false to allow
33    // - always use forward-slashes (even on Windows)
34    // - default: *pass*
35    exclude: /^defs\/$/,
36    // delete all source typings (i.e. "<baseDir>/**/*.d.ts")
37    // - default: false
38    removeSource: false,
39    // newline to use in output file
40    newline: os.EOL,
41    // indentation to use in output file
42    // - default 4 spaces
43    indent: '    ',
44    // prefix for rewriting module names
45    // - default ''
46    prefix: '__',
47    // separator for rewriting module 'path' names
48    // - default: forward slash (like sub-modules)
49    separator: '/',
50    // enable verbose mode, prints detailed info about all references and includes/excludes
51    // - default: false
52    verbose: false,
53    // emit although included files not found. See "Files not found" section. 
54    // *** Experimental, TEST NEEDED
55    // - default: false 
56    emitOnIncludedFileNotFound: false,
57    // emit although no included files not found. See "Files not found" section. 
58    // *** Experimental, TEST NEEDED
59    // - default: false     
60    emitOnNoIncludedFileNotFound: false,    
61    // output d.ts as designed for module folder. (no declare modules)
62    outputAsModuleFolder: false,
63    // path to file that contains the header
64    // // insert a header in output file. i.e.: http://definitelytyped.org/guides/contributing.html#header
65    // - default: null
66    headerPath: "path/to/header/file",
67    // text of the the header
68    // doesn't work with headerPath
69    // // insert a header in output file. i.e.: http://definitelytyped.org/guides/contributing.html#header
70    // - default: ''
71    headerTex: "" 
72};

References

For all other information, please, go to original dts-bundle plugin.