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).
# with npm
npm install rollup-plugin-typescript2 typescript --save-dev
# with yarn
yarn add rollup-plugin-typescript2 typescript --dev
// rollup.config.js
import typescript from 'rollup-plugin-typescript2';
export default {
entry: './main.ts',
plugins: [
typescript(/*{ plugin options }*/)
]
}
The plugin inherits all compiler options and file lists from your tsconfig.json
file. If your tsconfig has another name or another relative path from the root directory, see tsconfigDefaults
, tsconfig
and tsconfigOverride
options below. This also allows for passing in different tsconfig files depending on your build target.
noEmitHelpers
: falseimportHelpers
: truenoResolve
: falsenoEmit
: falseinlineSourceMap
: false (see #71)outDir
:./placeholder
in cache root, see 83 and Microsoft/TypeScript/issues/24715declarationDir
:process.cwd()
(only ifuseTsconfigDeclarationDir
is false in the plugin options)moduleResolution
:node
(classic
is deprecated. It also breaks this plugin, see #12 and #14)
module
: defaults toES2015
, other valid value isESNext
(required for dynamic imports, see #54).
Must be before this plugin in the plugin list, especially when browser: true
option is used, see #66
See explanation for rollupCommonJSResolveHack
option below.
See objectHashIgnoreUnknownHack
below.
-
tsconfigDefaults
:{}
The object passed as
tsconfigDefaults
will be merged with loadedtsconfig.json
. Final config passed to typescript will be the result of values intsconfigDefaults
replaced by values in loadedtsconfig.json
, replaced by values intsconfigOverride
and then replaced by hardcompilerOptions
overrides on top of that (see above).For simplicity and other tools' sake, try to minimize usage of defaults and overrides and keep everything in
tsconfig.json
file (tsconfigs can themselves be chained, so save some turtles).let defaults = { compilerOptions: { declaration: true } }; let override = { compilerOptions: { declaration: false } }; // ... plugins: [ typescript({ tsconfigDefaults: defaults, tsconfig: "tsconfig.json", tsconfigOverride: override }) ]
This is a deep merge (objects are merged, arrays are concatenated, primitives are replaced, etc), increase
verbosity
to 3 and look forparsed tsconfig
if you get something unexpected. -
tsconfig
:undefined
Path to
tsconfig.json
. Set this if your tsconfig has another name or relative location from the project directory. By default will try to load./tsconfig.json
, but will not fail if file is missing unless the value is set explicitly. -
tsconfigOverride
:{}
See
tsconfigDefaults
. -
check
: trueSet to false to avoid doing any diagnostic checks on the code.
-
verbosity
: 1- 0 -- Error
- 1 -- Warning
- 2 -- Info
- 3 -- Debug
-
clean
: falseSet to true for clean build (wipes out cache on every build).
-
cacheRoot
:./.rts2_cache
Path to cache. Defaults to a folder in the current directory. Can be safely moved out with something like
${require('temp-dir')}/.rpt2_cache
, but watch out for multiple concurrent builds of the same repo. -
include
:[ "*.ts+(|x)", "**/*.ts+(|x)" ]
By default passes all .ts files through typescript compiler.
-
exclude
:[ "*.d.ts", "**/*.d.ts" ]
But excludes type definitions.
-
abortOnError
: trueBail 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
: falseOn 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 throughresolve()
to match up withrollup-plugin-commonjs
. -
objectHashIgnoreUnknownHack
: falseThe plugin uses rollup config as part of cache key.
object-hash
is used to generate a hash, but it can't hash certain elements at the moment. Setting this option to true will makeobject-hash
ignore unknowns, at the cost of not invalidating the cache if ignored elements are changed. Only enable this if you need it (Error: Unknown object type "asyncfunction"
for example) and make sure to run withclean: true
once in a while and definitely before a release. (See #105) -
useTsconfigDeclarationDir
: falseIf true, declaration files will be emitted in the directory given in the tsconfig. If false, the declaration files will be placed inside the destination directory given in the Rollup configuration.
-
typescript
: typescript module installed with the pluginWhen typescript version installed by the plugin (latest 2.x) is unacceptable, you can import your own typescript module and pass it in as
typescript: require("typescript")
. Must be 2.0+, things might break if transpiler interfaces changed enough from what the plugin was built against. -
transformers
:undefined
experimental, typescript 2.4.1+
Transformers will likely be available in tsconfig eventually, so this is not a stable interface, see Microsoft/TypeScript/issues/14419.
For example, integrating kimamula/ts-transformer-keys:
const keysTransformer = require('ts-transformer-keys/transformer').default; const transformer = (service) => { before: [ keysTransformer(service.getProgram()) ], after: [] }; // ... plugins: [ typescript({ transformers: [transformer] }) ]
This plugin respects declaration: true
in your tsconfig.json
file. When set, it will emit *.d.ts
files for your bundle. The resulting file(s) can then be used with the types
property in your package.json
file as described here.
By default, the declaration files will be located in the same directory as the generated Rollup bundle. If you want to override this behavior and instead use the declarationDir set useTsconfigDeclarationDir
to true
in the plugin options.
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.
TypeScript 2.4+
Rollup 0.50+
Node 6.4.0+
(basic es6 support)
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).