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-typescript2';

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
• noEmitHelpers: true
• importHelpers: true
• noResolve: false

You will need to set "moduleResolution": "node" in tsconfig.json if typescript complains about missing tslib. See #12 and #14.

Plugin takes following options:

• check: true

  Set to false to avoid doing any diagnostic checks on the code.

• verbosity: 1

  • 0 -- Error
  • 1 -- Warning
  • 2 -- Info
  • 3 -- Debug

• clean: false

  Set to true for clean build (wipes out cache on every build).

• cacheRoot: ".rts2_cache"

  Path to cache.

• include: [ "*.ts+(|x)", "**/*.ts+(|x)" ]

  By default passes all .ts files through typescript compiler.

• exclude: [ "*.d.ts", "**/*.d.ts" ]

  But excludes type definitions.

• abortOnError: true

  Bail out on first syntactic or semantic error. In some cases setting this to false will result in exception in rollup itself (for example for unresolvable imports).

• rollupCommonJSResolveHack: false

  On windows typescript resolver favors POSIX path, while commonjs plugin (and maybe others?) uses native path as module id. This can result in namedExports being ignored if rollup happened to use typescript's resolution. Set to true to pass resolved module path through resolve() to match up with rollup-plugin-commonjs.

Watch mode

The way typescript handles type-only imports and ambient types effectively hides them from rollup watch, because import statements are not generated and changing them doesn't trigger a rebuild.

Otherwise the plugin should work in watch mode. Make sure to run a normal build after watch session to catch any type errors.

Version

This plugin currently requires TypeScript 2.0+.

Rollup version

Tested on rollup 0.41.4.

Reporting bugs

Report any bugs on github: https://github.com/ezolenko/rollup-plugin-typescript2/issues.

Attach your tsconfig.json, package.json (for versions of dependencies), rollup script and anything else that could influence module resolution, ambient types and typescript compilation.

Check if problem is reproducible after running npm prune to clear any rogue types from npm_modules (by default typescript grabs all ambient types).

Check if you get the same problem with clean option set to true (might indicate a bug in the cache).

If makes sense, check if running tsc directly produces similar results.

Attach plugin output with verbosity option set to 3 (this will list all files being transpiled and their imports).