https://github.com/jackw/rollup-plugin-dts-mapper
A development plugin to map TS declaration files back to source.
https://github.com/jackw/rollup-plugin-dts-mapper
Last synced: about 2 months ago
JSON representation
A development plugin to map TS declaration files back to source.
- Host: GitHub
- URL: https://github.com/jackw/rollup-plugin-dts-mapper
- Owner: jackw
- License: mit
- Created: 2024-07-02T07:14:03.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2026-03-01T16:24:14.000Z (3 months ago)
- Last Synced: 2026-03-01T18:58:29.535Z (3 months ago)
- Language: JavaScript
- Size: 72.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[npm]: https://img.shields.io/npm/v/rollup-plugin-dts-mapper
[npm-url]: https://www.npmjs.com/package/rollup-plugin-dts-mapper
[size]: https://packagephobia.now.sh/badge?p=rollup-plugin-dts-mapper
[size-url]: https://packagephobia.now.sh/result?p=rollup-plugin-dts-mapper
[![npm][npm]][npm-url]
[![size][size]][size-url]
[](https://liberamanifesto.com)
# rollup-plugin-dts-mapper
🍣 A Rollup plugin which creates dummy .d.ts files that map back to the src ts file.
## Why?
Building TS definition files is slow and needs to be handled separately when using tools like SWC or Esbuild for speedy compilation. This plugin solves the issue by creating a `.d.ts` file for each entrypoint (just like when you build for production) but the contents map back to the source `ts` file. This makes it very quick to create TS definition files without the need to run a typescript compiler alongside Rollup.
The alternative to using this plugin is to set your package.json `types` definition to point to `src/index.ts` and at publish time swap that out for the dist definition file. This means relying on yarn or pnpm `publishConfig` overrides or custom scripting to duplicate and/or edit the package.json file.
## Requirements
This plugin requires an [LTS](https://github.com/nodejs/Release) Node version (v14.0.0+) and Rollup v1.20.0+.
## Install
Using npm:
```console
npm install rollup-plugin-dts-mapper --save-dev
```
## Usage
Create a `rollup.config.js` [configuration file](https://www.rollupjs.org/guide/en/#configuration-files) and import the plugin.
> [!CAUTION]
> This plugin should only ever be used during development builds.
```js
const isDevelopment = process.env.NODE_ENV !== "production";
export default {
input: "src/index.js",
output: {
dir: "output",
format: "cjs",
},
plugins: [
isDevelopment && (await import("rollup-plugin-dts-mapper")).default(),
],
};
```
Then call `rollup` either via the [CLI](https://www.rollupjs.org/guide/en/#command-line-reference) or the [API](https://www.rollupjs.org/guide/en/#javascript-api).
## Options
There are currently no options available for this plugin.
## Meta
[CONTRIBUTING](./CONTRIBUTING.md)
[CODE OF CONDUCT]('./CODE_OF_CONDUCT.md')
[LICENSE (MIT)](/LICENSE)