typescript-declaration-webpack-plugin

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

typescript-declaration-webpack-plugin

★ 22 Open GitHub ↗

Bundels typescript declaration generated by typescript in webpack.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# typescript-declaration-webpack-plugin

Bundles typescript declarations generated by typescript loaded into one .d.ts file.

# What it does

The Plugin looks at all declaration files which the typescript loader generated and merges them into one.
Import will be sorted so that each module or package is only imported once.

# Setup

## Install via npm

Install this plugin via npm.

```
npm install --dev typescript-declaration-webpack-plugin
```

## tsconfig.json

Enable declaration generation by adding the following to the compiler options in your tsconfig.json file.

```json
{
    "compilerOptions": {
        "declaration": true
    }
}
```

## Webpack plugin

Add the following to your webpack.config.js file.

```javascript
const TypescriptDeclarationPlugin = require('typescript-declaration-webpack-plugin');
//...
module.exports = {
    //...
    plugins: [
        new TypescriptDeclarationPlugin({
            // Options for TypescriptDeclarationPlugin (see below)
        }),
    ],
    //..
};
//...
```

## Options

There are several options how you can customize the behavior of this plugin. Just pass these options to the constructor of the TypescriptDeclarationPlugin class.

| Option                   | Descrption                                                                      | Type     |
| ------------------------ | ------------------------------------------------------------------------------- | -------- |
| out                      | Name of the bundled file. Per default `index.d.ts`                              | _string_ |
| removeMergedDeclarations | If true the plugin will remove all merged declaration files. Per default `true` | _bool_   |
| removeComments           | Remove all comments from declaration files. Per default `true`                  | _bool_   |

# Feature plan

-   Merging declaration map's generated by declarationMap compiler option
-   Support multiple entry points, only include declarations of imported sources
-   Multiline comments should remove only the comment part

typescript-declaration-webpack-plugin

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README