rollup-plugin-dts-alias

Rollup Plugin: dts-alias-transformer

The dts-alias-transformer is a Rollup plugin designed to replace import paths in .d.ts files located in the dist directory based on provided alias mappings. This plugin can be especially useful in projects where you need to adjust import paths to accommodate different directory structures.

Installation

To use this plugin, you need to have Rollup installed in your project. You can install it via npm or yarn:

npm install --save-dev rollup dts-alias-transformer

or

yarn add --dev rollup dts-alias-transformer

Usage To use the dts-alias-transformer plugin, you need to import it in your Rollup configuration file (usually rollup.config.js) and provide it with the necessary options.

Example Configuration

export default {
  input: 'src/index.js',
  output: {
    dir: 'dist',
    format: 'cjs',
  },
  plugins: [
    dtsAliasPlugin({
      alias: {
        '@': '..', // Replace '@' with the parent directory
      },
      outputDir: 'dist', // Specify the output directory
    }),
  ],
};

Options

alias

• Type: { [key: string]: string }
• Default: { "@": ".." }

outputDir

• Type: string
• Default: "dist"

log

• Type: boolean
• Default: true

Example Workflow

• Before running Rollup，

Assume you have the following import statement in your dist/example.d.ts file:

import { HttpMethod } from "@/http";

• After running Rollup with the plugin:

If you set the alias mapping to replace @ with .., the import statement will be transformed as follows:

import { HttpMethod } from "../http";

Logging

The plugin will log the relative paths of all processed .d.ts files to the console, so you can keep track of which files were modified.

License

This project is licensed under the MIT License. See the LICENSE file for more details.