• This repository has been archived on 05/Aug/2021
  • Stars
    star
    324
  • Rank 129,708 (Top 3 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created about 9 years ago
  • Updated almost 5 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

This module has moved and is now available at @rollup/plugin-typescript / https://github.com/rollup/plugins/blob/master/packages/typescript

Moved

This module has moved and is now available at @rollup/plugin-typescript. Please update your dependencies. This repository is no longer maintained.

rollup-plugin-typescript

Build Status npm-version npm-monthly-downloads npm-dependencies

Seamless integration between Rollup and Typescript.

Why?

See rollup-plugin-babel.

Installation

npm install --save-dev rollup-plugin-typescript typescript tslib

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

Usage

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

export default {
  input: './main.ts',
  plugins: [
    typescript()
  ]
}

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:

  • options.include and options.exclude (each a minimatch pattern, or array of minimatch patterns), which determine which files are transpiled by Typescript (all .ts and .tsx files by default).

  • tsconfig 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.

  • typescript overrides TypeScript used for transpilation:

    typescript({
      typescript: require('some-fork-of-typescript')
    })
  • tslib overrides the injected TypeScript helpers with a custom version

    typescript({
      tslib: require('some-fork-of-tslib')
    })

TypeScript version

Due to the use of tslib to inject helpers, this plugin requires at least TypeScript 2.1. See also here.

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.

Issues

This plugin will currently not warn for any type violations. This plugin relies on TypeScript's transpileModule function which basically transpiles TypeScript to JavaScript by stripping any type information on a per-file basis. While this is faster than using the language service, no cross-file type checks are possible with this approach.

This also causes issues with emit-less types, see #28.

More Repositories

1

rollup

Next-generation ES module bundler
JavaScript
25,314
star
2

plugins

๐Ÿฃ The one-stop shop for official Rollup plugins
JavaScript
3,626
star
3

awesome

โšก๏ธ Delightful Rollup Plugins, Packages, and Resources
2,549
star
4

rollup-starter-lib

Bare-bones example of how to create a library using Rollup
JavaScript
966
star
5

rollup-plugin-babel

This package has moved and is now available at @rollup/plugin-babel / https://github.com/rollup/plugins/tree/master/packages/babel
JavaScript
702
star
6

rollup-plugin-commonjs

This module has moved and is now available at @rollup/plugin-commonjs / https://github.com/rollup/plugins/blob/master/packages/commonjs
JavaScript
501
star
7

rollup-plugin-node-resolve

This module has moved and is now available at @rollup/plugin-node-resolve / https://github.com/rollup/plugins/blob/master/packages/node-resolve
JavaScript
469
star
8

rollup-starter-app

Bare-bones example of how to create an application using Rollup
JavaScript
424
star
9

rollup-starter-project

Sample project for packages built using rollup.
JavaScript
325
star
10

rollup-starter-code-splitting

Starter project with code-splitting and dynamic imports, for modern and legacy browsers
JavaScript
248
star
11

rollup-plugin-alias

This module has moved and is now available at @rollup/plugin-alias / https://github.com/rollup/plugins/tree/master/packages/alias
JavaScript
172
star
12

rollup-plugin-multi-entry

This module has moved and is now available at @rollup/plugin-multi-entry / https://github.com/rollup/plugins/blob/master/packages/multi-entry
JavaScript
171
star
13

rollup-plugin-replace

This module has moved and is now available at @rollup/plugin-replace / https://github.com/rollup/plugins/blob/master/packages/replace
JavaScript
162
star
14

rollup-plugin-json

This module has moved and is now available at @rollup/plugin-json / https://github.com/rollup/plugins/blob/master/packages/json
JavaScript
126
star
15

rollup-watch

Fast incremental rebuilds with Rollup CLI
JavaScript
91
star
16

three-jsnext

three.js, but futuristic
JavaScript
85
star
17

rollupjs.org

Rollup demo website
Svelte
77
star
18

rollup-plugin-inject

This module has moved and is now available at @rollup/plugin-inject / https://github.com/rollup/plugins/blob/master/packages/inject
JavaScript
77
star
19

rollup-plugin-wasm

This module has moved and is now available at @rollup/plugin-wasm / https://github.com/rollup/plugins/blob/master/packages/wasm
WebAssembly
75
star
20

rollup-plugin-url

This module has moved and is now available at @rollup/plugin-url / https://github.com/rollup/plugins/blob/master/packages/url
JavaScript
75
star
21

rollup-docs-cn

Rollup.js ไธญๆ–‡ๆ–‡ๆกฃ - Built with Vitepress
JavaScript
74
star
22

rollup-plugin-run

This module has moved and is now available at @rollup/plugin-run / https://github.com/rollup/plugins/blob/master/packages/run
JavaScript
64
star
23

rollup-plugin-strip

This module has moved and is now available at @rollup/plugin-strip / https://github.com/rollup/plugins/blob/master/packages/strip
JavaScript
50
star
24

babel-preset-es2015-rollup

babel-preset-es2015, minus modules, plus helpers
JavaScript
48
star
25

rollup-pluginutils

This package has moved and is now available at @rollup/pluginutils / https://github.com/rollup/plugins
TypeScript
45
star
26

rollup-plugin-buble

This module has moved and is now available at @rollup/plugin-buble / https://github.com/rollup/plugins/blob/master/packages/buble
JavaScript
43
star
27

rollup-plugin-image

This module has moved and is now available at @rollup/plugin-image / https://github.com/rollup/plugins/blob/master/packages/image
JavaScript
41
star
28

plugin-auto-install

This module has moved and is now available at @rollup/plugin-auto-install / https://github.com/rollup/plugins/blob/master/packages/auto-install
JavaScript
41
star
29

rollup-plugin-virtual

This module has moved and is now available at @rollup/plugin-virtual / https://github.com/rollup/plugins/blob/master/packages/virtual
JavaScript
41
star
30

d3-jsnext

d3, but futuristic
JavaScript
33
star
31

rollup-babel

[DEPRECATED] Experimental rollup/babel integration
JavaScript
28
star
32

rollup-plugin-sucrase

This package has moved and is now available at @rollup/plugin-sucrase / https://github.com/rollup/plugins/blob/master/packages/sucrase
JavaScript
23
star
33

stream

๐Ÿฃ Stream Rollup build results
TypeScript
22
star
34

rollup-plugin-butternut

This module is no longer maintained. Please use https://www.npmjs.com/package/rollup-plugin-terser
JavaScript
20
star
35

rollup-plugin-ractive

Precompile Ractive components
JavaScript
11
star
36

rollup-plugin-yaml

This module has moved and is now available at @rollup/plugin-yaml / https://github.com/rollup/plugins/blob/master/packages/yaml
JavaScript
11
star
37

rollup-plugin-legacy

Add export statements to plain scripts. Moved to https://github.com/rollup/plugins/blob/master/packages/legacy
JavaScript
10
star
38

eslint-config-rollup

A shareable ESLint configuration for Rollup projects
JavaScript
9
star
39

rollup-init

Initialise Rollup configuration
JavaScript
7
star
40

rollup-plugin-dsv

This module has moved and is now available at @rollup/plugin-dsv / https://github.com/rollup/plugins/blob/master/packages/dsv
JavaScript
5
star
41

rollup-starter-plugin

Starter code for creating a Rollup plugin
JavaScript
5
star
42

containers

๐Ÿ“ค
Dockerfile
4
star
43

log

๐ŸŒณ
TypeScript
3
star
44

hull

๐Ÿ›ณ
JavaScript
2
star
45

org

Organizational issues and tasks for Rollup
1
star
46

rollup-docs-az

Rollup docs in Azerbaijani
JavaScript
1
star