Registry / web-framework / esbuild-dts-path-alias

esbuild-dts-path-alias

library4.2.1jsnpmunverified

esbuild plugin for compiling TypeScript declaration files (.d.ts) with path alias transformation. Version 4.2.1 (latest) requires esbuild ^0.17.0, TypeScript >=5, and Node >=16.10.0. It resolves path aliases like '@utils/foo' into relative import paths in the output .d.ts files, solving a common pain point when using path aliases in TypeScript projects. It offers configurable tsconfig path, output directory, and debug logging. As a fork of esbuild-plugin-d-ts-alias, it maintains compatibility with recent esbuild and TypeScript versions. The plugin is ESM-only and ships TypeScript declarations.

web-framework http-networking testing observability

npm install esbuild-dts-path-alias

github ↗package ↗

INSTALL

IMPORT

SIG · ESBUILD-DTS-PATH-A

esbuild-dts-path-alias

web-frameworkjavascriptv4.2.1

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

dTSPathAliasPlugin

✓ import { dTSPathAliasPlugin } from 'esbuild-plugin-d-ts-path-alias'

✗ const dTSPathAliasPlugin = require('esbuild-plugin-d-ts-path-alias')

Package is ESM-only since v4.0.0. CommonJS require() will fail in Node ESM contexts.

dTSPathAliasPlugin (default export)

✓ import dTSPathAliasPlugin from 'esbuild-plugin-d-ts-path-alias'

The plugin also supports default export for convenience, but named export is recommended for consistency.

PluginConfig (type)

✓ import type { PluginConfig } from 'esbuild-plugin-d-ts-path-alias'

Type-only import for TypeScript users. PluginConfig includes tsconfigPath, outputPath, and debug options.

Demonstrates basic usage: include the plugin in esbuild build config to transform path aliases in .d.ts files.

import { build } from 'esbuild'; import { dTSPathAliasPlugin } from 'esbuild-plugin-d-ts-path-alias'; build({ entryPoints: ['./src/index.ts'], outfile: './dist/index.js', bundle: true, format: 'esm', target: 'es2020', plugins: [dTSPathAliasPlugin()], }).catch(() => process.exit(1));

Debug

Known issues

breakingVersion 3.0.0 dropped support for TypeScript <5 and esbuild <0.17.0.

fix

Upgrade TypeScript to >=5 and esbuild to >=0.17.0, and Node to >=16.10.0.

affects: >=3.0.0

breakingVersion 4.0.0 changed to ESM-only package (type:module in package.json).

fix

Use dynamic import() or switch to ESM project configuration. For CommonJS require, pin to v3.x.

affects: >=4.0.0

deprecatedThe original plugin was forked without indication of upstream changes. Check for newer versions.

fix

Monitor the GitHub repository for updates or consider forking as needed.

affects: any

Errors

Common errors & fixes

require() of ES Module esbuild-plugin-d-ts-path-alias from node_modules not supported

Using CommonJS require() to load an ESM-only package (v4+).

fix

Switch to ESM (set type: module in package.json or use .mjs extension) and use import syntax.

Cannot find module 'esbuild-plugin-d-ts-path-alias' or its corresponding type declarations

Missing installation or wrong import path when using TypeScript with strict moduleResolution.

fix

Install the package: npm install esbuild-plugin-d-ts-path-alias --save-dev. Ensure tsconfig.json has "moduleResolution": "node16" or "bundler".

Error: tsconfig.json not found

The plugin cannot locate tsconfig.json, or a custom tsconfigPath is incorrect.

fix

Provide explicit tsconfigPath option to dTSPathAliasPlugin({ tsconfigPath: './path/to/tsconfig.json' }) or ensure default tsconfig.json exists at project root.

Upgrade

Version history

4.2.1latest on npm

Audit

Dependencies

esbuildrequiredPeer dependency - provides the build system and plugin API at ^0.17.0, ^0.18.0, or ^0.21.0

typescriptrequiredPeer dependency - required for TypeScript declaration compilation, >=5.0

Agent activity

20 hits · last 30 days

node

OpenAI (training)

Amazon

Bingbot

Resources

githubhttps://github.com/ArtemKlyuev/esbuild-plugin-d-ts-path-alias ↗

packagehttps://www.npmjs.com/package/esbuild-dts-path-alias ↗