rollup-plugin-typescript2

What is rollup-plugin-typescript2?

rollup-plugin-typescript2 is a Rollup plugin that integrates TypeScript compilation into the Rollup bundling process. It provides advanced TypeScript features, incremental compilation, and better error reporting compared to other TypeScript plugins for Rollup.

What are rollup-plugin-typescript2's main functionalities?

TypeScript Compilation

This feature allows you to compile TypeScript files into JavaScript as part of the Rollup bundling process. The plugin reads the tsconfig.json file for TypeScript configuration.

const typescript = require('rollup-plugin-typescript2');

module.exports = {
  input: 'src/main.ts',
  output: {
    file: 'bundle.js',
    format: 'cjs'
  },
  plugins: [
    typescript({
      tsconfig: 'tsconfig.json'
    })
  ]
};

Incremental Compilation

This feature enables incremental compilation, which speeds up the build process by only recompiling files that have changed since the last build.

const typescript = require('rollup-plugin-typescript2');

module.exports = {
  input: 'src/main.ts',
  output: {
    file: 'bundle.js',
    format: 'cjs'
  },
  plugins: [
    typescript({
      tsconfig: 'tsconfig.json',
      useTsconfigDeclarationDir: true
    })
  ]
};

Error Reporting

This feature provides enhanced error reporting, making it easier to debug TypeScript compilation issues. The 'clean' option ensures that the cache is cleared before each build, which can help in identifying persistent errors.

const typescript = require('rollup-plugin-typescript2');

module.exports = {
  input: 'src/main.ts',
  output: {
    file: 'bundle.js',
    format: 'cjs'
  },
  plugins: [
    typescript({
      tsconfig: 'tsconfig.json',
      clean: true
    })
  ]
};

Other packages similar to rollup-plugin-typescript2

rollup-plugin-typescript

rollup-plugin-typescript is another Rollup plugin for integrating TypeScript compilation. It is simpler and has fewer features compared to rollup-plugin-typescript2, lacking incremental compilation and advanced error reporting.

rollup-plugin-sucrase

rollup-plugin-sucrase is a Rollup plugin that uses Sucrase to compile TypeScript and other modern JavaScript syntax. It is faster than rollup-plugin-typescript2 but does not support type checking.

rollup-plugin-babel

rollup-plugin-babel is a Rollup plugin that uses Babel to transpile JavaScript, including TypeScript. It offers a wide range of plugins and presets but requires additional configuration for TypeScript support.

README

rollup-plugin-typescript2

Rollup plugin for typescript with compiler errors.

This is a rewrite of original rollup-plugin-typescript, starting and borrowing from this fork.

This version is somewhat slower than original, but it will print out typescript syntactic and semantic diagnostic messages (the main reason for using typescript after all).

Usage

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

export default {
	entry: './main.ts',

	plugins: [
		typescript()
	]
}

The plugin depends on existence of tsconfig.json file. All compiler options and file lists are loaded from that.

Following compiler options are forced though:

• module: es2015
• sourceMap: true
• noEmitHelpers: true
• importHelpers: true
• noResolve: false

Plugin takes following options:

• check: true
  • set to false to avoid doing any diagnostic checks on the code
• verbosity: 2
  • goes up to 3
• clean: false
  • set to true for clean build (wipes out cache)
• cacheRoot: ".rts2_cache"
  • path to cache
• include: [ "*.ts+(|x)", "**/*.ts+(|x)" ]
  • passes all .ts files through typescript compiler.
• exclude: [ "*.d.ts", "**/*.d.ts" ]
  • but not types

TypeScript version

This plugin currently requires TypeScript 2.0+.