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 npmnpm install rollup-plugin-typescript2 typescript --save-dev# with yarnyarn add rollup-plugin-typescript2 typescript --dev
// rollup.config.js;input: './main.ts'plugins:
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
tsconfigOverride options below. This also allows for passing in different tsconfig files depending on your build target.
Some compiler options are forced
inlineSourceMap: false (see #71)
./placeholderin cache root, see 83 and Microsoft/TypeScript/issues/24715
useTsconfigDeclarationDiris false in the plugin options)
classicis deprecated. It also breaks this plugin, see #12 and #14)
allowNonTsExtensions: true to let other plugins on the chain generate typescript, update plugin's include filter to pick them up (see #111)
Some compiler options have more than one compatible value.
module: defaults to
ES2015, other valid value is
ESNext(required for dynamic imports, see #54).
Some options need additional configuration on plugin side
allowJs: lets typescript process js files as well, if you use it, modify plugin's
includeoption to add
"*.js+(|x)", "**/*.js+(|x)"(might want to exclude node_modules, it will slow down the build significantly).
Must be before rollup-plugin-typescript2 in the plugin list, especially when
browser: true option is used, see #66
See explanation for
rollupCommonJSResolveHack option below.
This plugin transpiles code, but doesn't change file extension. Babel plugin, even though it claims it processes all files, only looks at code with those extensions by default:
.js,.jsx,.es6,.es,.mjs. To workaround add
tsx to the list of babel extensions.
The current work directory, default
The object passed as
tsconfigDefaultswill be merged with loaded
tsconfig.json. Final config passed to typescript will be the result of values in
tsconfigDefaultsreplaced by values in loaded
tsconfig.json, replaced by values in
tsconfigOverrideand then replaced by hard
compilerOptionsoverrides 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.jsonfile (tsconfigs can themselves be chained, so save some turtles).let defaults = compilerOptions: declaration: true ;let override = compilerOptions: declaration: false ;// ...plugins:
This is a deep merge (objects are merged, arrays are concatenated, primitives are replaced, etc), increase
verbosityto 3 and look for
parsed tsconfigif you get something unexpected.
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.
Set to false to avoid doing any diagnostic checks on the code.
- 0 -- Error
- 1 -- Warning
- 2 -- Info
- 3 -- Debug
Set to true for clean build (wipes out cache on every build).
Path to cache. Defaults to a folder in node_modules.
[ "*.ts+(|x)", "**/*.ts+(|x)" ]
By default passes all .ts files through typescript compiler.
[ "*.d.ts", "**/*.d.ts" ]
But excludes type definitions.
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).
On windows typescript resolver favors POSIX path, while commonjs plugin (and maybe others?) uses native path as module id. This can result in
namedExportsbeing 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-commonjsfixed this in
10.1.0, so projects using this option who update to new version will be broken again.
This also works around the similar bug affecting code splitting (see rollup/issues/3094).
The plugin uses rollup config as part of cache key.
object-hashis used to generate a hash, but it can have trouble with some uncommon types of elements. Setting this option to true will make
object-hashignore 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 "xxx"for example) and make sure to run with
clean: trueonce in a while and definitely before a release. (See #105 and #203)
If 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.
Set to false if any other rollup plugins need access to declaration files.
typescript: typescript module installed with the plugin
When 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.
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 = default;const transformer =before:after:;// ...plugins:
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
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.
6.4.0+ (basic es6 support)
Report any bugs on github: https://github.com/ezolenko/rollup-plugin-typescript2/issues.
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).
Use the normal github process of forking, making a branch and creating a PR when ready. Fix all linting problems (run
npm lint), fix any failed checks that are run on the PR (basically lint right now). Use an editor that supports editorconfig, or match the settings from
.editorconfig file manually.
Fastest way to test changes is to do a self build, the plugin is part of its own build system:
- make changes
npm build(uses build committed to master branch)
- check that you get expected changes in
npm build-self(uses fresh local build)
distfor the expected changes
npm build-selfagain to make sure plugin built by new version can still build itself
build-self breaks at some point, fix the problem and restart from
build step (a known good copy).
This repo badly needs unittests and integration tests with various scenarios and expected outcomes though.