Seamless integration between Rollup and TypeScript.
Last updated 13 days ago by shellscape .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @rollup/plugin-typescript 
SYNC missed versions from official npm registry.

npm size libera manifesto


???? A Rollup plugin for seamless integration between Rollup and Typescript.


This plugin requires an LTS Node version (v8.0.0+) and Rollup v1.20.0+. Due to the use of tslib to inject helpers, this plugin requires at least TypeScript 2.1. See also here.


Using npm:

npm install @rollup/plugin-typescript --save-dev

Note that both typescript and tslib are peer dependencies of this plugin that need to be installed separately.


See @rollup/plugin-babel.


Create a rollup.config.js configuration file and import the plugin:

// rollup.config.js
import typescript from '@rollup/plugin-typescript';

export default {
  input: 'src/index.ts',
  output: {
    dir: 'output',
    format: 'cjs'
  plugins: [typescript()]

Then call rollup either via the CLI or the API.


The plugin loads any compilerOptions from the tsconfig.json file by default. Passing options to the plugin directly overrides those options:

export default {
  input: './main.ts',
  plugins: [
      typescript({lib: ["es5", "es6", "dom"], target: "es5"})

The following options are unique to rollup-plugin-typescript:


Type: String | Array[...String]
Default: null

A minimatch pattern, or array of patterns, which specifies the files in the build the plugin should ignore. By default no files are ignored.


Type: String | Array[...String]
Default: null

A minimatch pattern, or array of patterns, which specifies the files in the build the plugin should operate on. By default all .ts and .tsx files are targeted.


Type: String | Boolean
Default: true

When set to false, ignores any options specified in the config file. If set to a string that corresponds to a file path, the specified file will be used as config file.


Type: import('typescript')
Default: peer dependency

Overrides the TypeScript module used for transpilation.

  typescript: require('some-fork-of-typescript')


Type: String
Default: peer dependency

Overrides the injected TypeScript helpers with a custom version.

  tslib: require.resolve('some-fork-of-tslib')

Typescript compiler options

Some of Typescript's CompilerOptions affect how Rollup builds files.


Type: Boolean
Default: true

If a type error is detected, the Rollup build is aborted when this option is set to true.

files, include, exclude

Type: Array[...String]
Default: []

Declaration files are automatically included if they are listed in the files field in your tsconfig.json file. Source files in these fields are ignored as Rollup's configuration is used instead.

Ignored options

These compiler options are ignored by Rollup:

  • noEmitHelpers, importHelpers: The tslib helper module always must be used.
  • noEmit, emitDeclarationOnly: Typescript needs to emit code for the plugin to work with.
  • noResolve: Preventing Typescript from resolving code may break compilation

Importing CommonJS

Though it is not recommended, it is possible to configure this plugin to handle imports of CommonJS files from TypeScript. For this, you need to specify CommonJS as the module format and add rollup-plugin-commonjs to transpile the CommonJS output generated by TypeScript to ES Modules so that rollup can process it.

// rollup.config.js
import typescript from '@rollup/plugin-typescript';
import commonjs from '@rollup/plugin-commonjs';

export default {
  input: './main.ts',
  plugins: [
    typescript({ module: 'CommonJS' }),
    commonjs({ extensions: ['.js', '.ts'] }) // the ".ts" extension is required

Note that this will often result in less optimal output.

Preserving JSX output

Whenever choosing to preserve JSX output to be further consumed by another transform step via tsconfig compilerOptions by setting jsx: 'preserve' or overriding options, please bear in mind that, by itself, this plugin won't be able to preserve JSX output, usually failing with:

[!] Error: Unexpected token (Note that you need plugins to import files that are not JavaScript)
file.tsx (1:15)
1: export default <span>Foobar</span>

To prevent that, make sure to use the acorn plugin, namely acorn-jsx, which will make Rollup's parser acorn handle JSX tokens. (See https://rollupjs.org/guide/en/#acorninjectplugins)

After adding acorn-jsx plugin, your Rollup config would look like the following, correctly preserving your JSX output.

import jsx from 'acorn-jsx';
import typescript from '@rollup/plugin-typescript';

export default {
  // … other options …
  acornInjectPlugins: [jsx()],
  plugins: [typescript({ jsx: 'preserve' })]

Faster compiling

Previous versions of this plugin used Typescript's transpileModule API, which is faster but does not perform typechecking and does not support cross-file features like const enums and emit-less types. If you want this behaviour, you can use @rollup/plugin-sucrase instead.




Current Tags

  • 5.0.1                                ...           latest (13 days ago)

13 Versions

  • 5.0.1                                ...           13 days ago
  • 5.0.0                                ...           19 days ago
  • 4.1.2                                ...           2 months ago
  • 4.1.1                                ...           3 months ago
  • 4.1.0                                ...           3 months ago
  • 4.0.0                                ...           4 months ago
  • 3.1.1                                ...           4 months ago
  • 3.1.0                                ...           4 months ago
  • 3.0.0                                ...           5 months ago
  • 2.1.0                                ...           6 months ago
  • 2.0.2                                ...           6 months ago
  • 2.0.1                                ...           7 months ago
  • 2.0.0                                ...           7 months ago
Today 2
This Week 600
This Month 954
Last Day 119
Last Week 678
Last Month 3,622
Dependencies (2)
Dev Dependencies (7)

Copyright 2014 - 2017 © taobao.org |