Registry / devops / ts-import-plugin

ts-import-plugin

library3.0.0jsnpmunverified

Modular import plugin for TypeScript, converting named imports like `import { Alert, Card } from 'antd'` into separate per-module imports and optional style imports. Version 3.0.0 requires TypeScript >= 4.8 and drops support for older versions. The plugin is commonly used with antd, antd-mobile, and other large libraries to enable tree shaking and reduce bundle size. It works with ts-loader, awesome-typescript-loader, rollup-plugin-typescript2, and @rollup/plugin-typescript. Key differentiator: operates at the TypeScript compiler level via custom transformers, unlike babel-plugin-import which requires Babel.

devops

npm install ts-import-plugin

github ↗package ↗

INSTALL

IMPORT

SIG · TS-IMPORT-PLUGIN

ts-import-plugin

devopsjavascriptv3.0.0

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

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

tsImportPluginFactory (default)

✓ const tsImportPluginFactory = require('ts-import-plugin')

✗ import tsImportPluginFactory from 'ts-import-plugin'

CommonJS default export via require. ESM named export createTransformer is available for rollup usage. In TypeScript, you may need to use `import tsImportPluginFactory = require('ts-import-plugin')`.

createTransformer

✓ import createTransformer from 'ts-import-plugin'

✗ import { createTransformer } from 'ts-import-plugin'

Default export name is createTransformer for ESM; using named import {} will fail. This is the pattern for rollup and some ESM setups.

PluginOptions

✓ import type { PluginOptions } from 'ts-import-plugin'

TypeScript type export for the options object. Only available in TypeScript projects; not exported at runtime.

Configures ts-loader with ts-import-plugin to transform antd imports to modular ones, enabling tree shaking.

// webpack.config.js const tsImportPluginFactory = require('ts-import-plugin'); module.exports = { module: { rules: [ { test: /\.tsx?$/, use: { loader: 'ts-loader', options: { transpileOnly: true, getCustomTransformers: () => ({ before: [ tsImportPluginFactory({ libraryName: 'antd', libraryDirectory: 'es', style: true, }), ], }), compilerOptions: { module: 'es2015', }, }, }, exclude: /node_modules/, }, ], }, };

Debug

Known issues

breakingTypeScript version must be >= 4.8 for ts-import-plugin v3.0.0

fix

Upgrade TypeScript to 4.8+ or use ts-import-plugin v2.x for TS < 4.8

affects: >=3.0.0

breakingTypeScript version must be >= 4.2 for ts-import-plugin v2.0.0

fix

Upgrade TypeScript to 4.2+ or use v1.x for TS < 4.2

affects: >=2.0.0 <3.0.0

gotchaPlugin does not work with `import * as _ from 'lodash'` or `import _ from 'lodash'` (default imports)

fix

Use named imports (e.g., `import { map } from 'lodash'`) to trigger the transform

affects: *

gotchaMust set `module: 'ESNext'` in tsconfig.json and `compilerOptions.module: 'es2015'` in webpack config for proper output

fix

Ensure both tsconfig and webpack loader config have the module set to ES2015/ESNext

affects: *

Errors

Common errors & fixes

Error: Plugin 'ts-import-plugin' cannot be used with 'import * as' or 'default import'

The plugin only transforms named imports (e.g., import { Foo } from 'bar'), not namespace imports.

fix

Change `import * as X from 'lib'` to `import { X } from 'lib'`.

TypeError: Cannot read properties of undefined (reading 'factory')

Using ts-import-plugin v3.0.0 with TypeScript < 4.8 (missing context.factory API).

fix

Upgrade TypeScript to >= 4.8 or downgrade ts-import-plugin to v2.x.

Module not found: Error: Can't resolve 'antd/es/button/style'

Style option enabled but style path resolver cannot locate the styles (e.g., libraryDirectory mismatch).

fix

Set `libraryDirectory` to 'es' (or correct path) and ensure style path exists. Use `style: true` for default CSS or provide a custom resolver.

Upgrade

Version history

3.0.0latest on npm

Audit

Dependencies

typescriptrequiredPeer dependency: requires TypeScript >= 4.8 from v3.0.0

Agent activity

10 hits · last 30 days

node

Resources

githubhttps://github.com/Brooooooklyn/ts-import-plugin ↗

packagehttps://www.npmjs.com/package/ts-import-plugin ↗