Seamless integration between Rollup and TypeScript.
npm install @cocos/rollup-plugin-typescript[npm]: https://img.shields.io/npm/v/@rollup/plugin-typescript
[npm-url]: https://www.npmjs.com/package/@rollup/plugin-typescript
[size]: https://packagephobia.now.sh/badge?p=@rollup/plugin-typescript
[size-url]: https://packagephobia.now.sh/result?p=@rollup/plugin-typescript
[![npm][npm]][npm-url]
[![size][size]][size-url]
This is a typescript rollup plugin forked from https://github.com/rollup/plugins/tree/master/packages/typescript .
We did some changes:
- Depends on a modified version of typescript npm package (@cocos/typescript)
- Renames the current package to @cocos/rollup-plugin-typescript
The original README is below:
🍣 A Rollup plugin for seamless integration between Rollup and Typescript.
This plugin requires an LTS Node version (v14.0.0+) and Rollup v2.14.0+. This plugin also requires at least TypeScript 3.7.
Using npm:
``console`
npm install @rollup/plugin-typescript --save-dev
Note that both typescript and tslib are peer dependencies of this plugin that need to be installed separately.
See @rollup/plugin-babel.
Create a rollup.config.js configuration file and import the plugin:
`js
// rollup.config.js
import typescript from '@rollup/plugin-typescript';
export default {
input: 'src/index.ts',
output: {
dir: 'output',
format: 'cjs'
},
plugins: [typescript()]
};
`
Then call rollup either via the CLI or the API.
The plugin loads any compilerOptions from the tsconfig.json file by default. Passing options to the plugin directly overrides those options:
`js`
...
export default {
input: './main.ts',
plugins: [
typescript({ compilerOptions: {lib: ["es5", "es6", "dom"], target: "es5"}})
]
}
The following options are unique to @rollup/plugin-typescript:
Type: String | Array[...String]
Default:
A picomatch pattern, or array of patterns, which specifies the files in the build the plugin should _ignore_. By default no files are ignored.
Type: String | Array[...String]
Default:
A picomatch pattern, or array of patterns, which specifies the files in the build the plugin should operate on. By default all .ts and .tsx files are targeted.
Type: String | Boolean
Default: ?? tsConfig.compilerOptions.rootDir ?? process.cwd()
Optionally resolves the include and exclude patterns against a directory other than process.cwd(). If a String is specified, then the value will be used as the base directory. Relative paths will be resolved against process.cwd() first. If false, then the patterns will not be resolved against any directory.
By default, patterns resolve against the rootDir set in your TS config file.
This can fix plugin errors when parsing files outside the current working directory (process.cwd()).
Type: String | Boolean
Default:
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.
Type: import('typescript')
Default: _peer dependency_
Overrides the TypeScript module used for transpilation.
`js`
typescript({
typescript: require('some-fork-of-typescript')
});
Type: String
Default: _peer dependency_
Overrides the injected TypeScript helpers with a custom version.
`js`
typescript({
tslib: require.resolve('some-fork-of-tslib')
});
Type: { [before | after | afterDeclarations]: TransformerFactory[] } | ((program: ts.Program) => ts.CustomTransformers)
Default:
Allows registration of TypeScript custom transformers at any of the supported stages:
- before: transformers will execute before the TypeScript's own transformers on raw TypeScript files
- after: transformers will execute after the TypeScript transformers on transpiled code
- afterDeclarations: transformers will execute after declaration file generation allowing to modify existing declaration files
Supported transformer factories:
- all built-in TypeScript custom transformer factories:
- import('typescript').TransformerFactory annotated TransformerFactory bellowimport('typescript').CustomTransformerFactory
- annotated CustomTransformerFactory bellow
- ProgramTransformerFactory represents a transformer factory allowing the resulting transformer to grab a reference to the Program instance
`js`
{
type: 'program',
factory: (program: Program) => TransformerFactory | CustomTransformerFactory
}
- TypeCheckerTransformerFactory represents a transformer factory allowing the resulting transformer to grab a reference to the TypeChecker instance
`js`
{
type: 'typeChecker',
factory: (typeChecker: TypeChecker) => TransformerFactory | CustomTransformerFactory
}
`js
typescript({
transformers: {
before: [
{
// Allow the transformer to get a Program reference in it's factory
type: 'program',
factory: (program) => {
return ProgramRequiringTransformerFactory(program);
}
},
{
type: 'typeChecker',
factory: (typeChecker) => {
// Allow the transformer to get a TypeChecker reference in it's factory
return TypeCheckerRequiringTransformerFactory(typeChecker);
}
}
],
after: [
// You can use normal transformers directly
require('custom-transformer-based-on-Context')
],
afterDeclarations: [
// Or even define in place
function fixDeclarationFactory(context) {
return function fixDeclaration(source) {
function visitor(node) {
// Do real work here
return ts.visitEachChild(node, visitor, context);
}
return ts.visitEachChild(source, visitor, context);
};
}
]
}
});
`
Alternatively, the transformers can be created inside a factory.
Supported transformer factories:
- all built-in TypeScript custom transformer factories:
- import('typescript').TransformerFactory annotated TransformerFactory bellowimport('typescript').CustomTransformerFactory
- annotated CustomTransformerFactory bellow
The example above could be written like this:
`js
typescript({
transformers: function (program) {
return {
before: [
ProgramRequiringTransformerFactory(program),
TypeCheckerRequiringTransformerFactory(program.getTypeChecker())
],
after: [
// You can use normal transformers directly
require('custom-transformer-based-on-Context')
],
afterDeclarations: [
// Or even define in place
function fixDeclarationFactory(context) {
return function fixDeclaration(source) {
function visitor(node) {
// Do real work here
return ts.visitEachChild(node, visitor, context);
}
return ts.visitEachChild(source, visitor, context);
};
}
]
};
}
});
`
Type: String
Default: _.rollup.cache_
When compiling with incremental or composite options the plugin will
store compiled files in this folder. This allows the use of incremental
compilation.
`js`
typescript({
cacheDir: '.rollup.tscache'
});
Type: Boolean
Default:
Earlier version of @rollup/plugin-typescript required that the compilerOptions noEmit and emitDeclarationOnly both false to guarantee that source code was fed into the next plugin/output. This is no longer true. This option disables the plugin forcing the values of those options and instead defers to the values set in tsconfig.json.
noForceEmit can be very useful if you use with @rollup/plugin-babel and @babel/preset-typescript. Having @rollup/plugin-typescript only do typechecking / declarations with "emitDeclarationOnly": true while deferring to @rollup/plugin-babel for transpilation can dramatically reduce rollup build times for large projects.
Some of Typescript's CompilerOptions affect how Rollup builds files.
#### noEmitOnError
Type: Boolean
Default:
If a type error is detected, the Rollup build is aborted when this option is set to true.
#### files, include, exclude
Type: Array[...String]
Default:
Declaration files are automatically included if they are listed in the files field in your tsconfig.json file. Source files in these fields are ignored as Rollup's configuration is used instead.
#### Ignored options
These compiler options are ignored by Rollup:
- noEmitHelpers, importHelpers: The tslib helper module always must be used.noEmit
- , emitDeclarationOnly: Typescript needs to emit code for the plugin to work with.@rollup/plugin-typescript
- _Note: While this was true for early iterations of , it is no longer. To override this behavior, and defer to tsconfig.json for these options, see the noForceEmit option_noResolve
- : Preventing Typescript from resolving code may break compilation
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.
`js
// rollup.config.js
import typescript from '@rollup/plugin-typescript';
import commonjs from '@rollup/plugin-commonjs';
export default {
input: './main.ts',
plugins: [
typescript({ compilerOptions: { module: 'CommonJS' } }),
commonjs({ extensions: ['.js', '.ts'] }) // the ".ts" extension is required
]
};
`
Note that this will often result in less optimal output.
Whenever choosing to preserve JSX output to be further consumed by another transform step via tsconfig compilerOptions by setting jsx: 'preserve' or overriding options, please bear in mind that, by itself, this plugin won't be able to preserve JSX output, usually failing with:
`sh`
[!] Error: Unexpected token (Note that you need plugins to import files that are not JavaScript)
file.tsx (1:15)
1: export default Foobar
^
To prevent that, make sure to use the acorn plugin, namely acorn-jsx, which will make Rollup's parser acorn handle JSX tokens. (See https://rollupjs.org/guide/en/#acorninjectplugins)
After adding acorn-jsx plugin, your Rollup config would look like the following, correctly preserving your JSX output.
`js
import jsx from 'acorn-jsx';
import typescript from '@rollup/plugin-typescript';
export default {
// … other options …
acornInjectPlugins: [jsx()],
plugins: [typescript({ compilerOptions: { jsx: 'preserve' } })]
};
`
Previous versions of this plugin used Typescript's transpileModule API, which is faster but does not perform typechecking and does not support cross-file features like const enum`s and emit-less types. If you want this behaviour, you can use @rollup/plugin-sucrase instead.