Repository files navigation

Rollup plugin for typescript with compiler errors.

This is a rewrite of theoriginalrollup-plugin-typescript, starting and borrowing fromthis fork.

This version is somewhat slower than the 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 tslib --save-dev# with yarnyarn add rollup-plugin-typescript2 typescript tslib --dev

// rollup.config.jsimporttypescriptfrom'rollup-plugin-typescript2';exportdefault{input:'./main.ts',plugins:[typescript(/*{ plugin options }*/)]}

This plugin inherits all compiler options and file lists from yourtsconfig.json file.If yourtsconfig has another name or another relative path from the root directory, seetsconfigDefaults,tsconfig, andtsconfigOverride options below.This also allows for passing in differenttsconfig files depending on your build target.

• noEmitHelpers: false
• importHelpers: true
• noResolve: false
• noEmit: false (Rollup controls emit)
• noEmitOnError: false (Rollup controls emit. See#254 and theabortOnError plugin option below)
• inlineSourceMap: false (see#71)
• outDir:./placeholder in cache root (see#83 andMicrosoft/TypeScript#24715)
• declarationDir: Rollup'soutput.file oroutput.dir (unlessuseTsconfigDeclarationDir is true in the plugin options)
• allowNonTsExtensions: true to let other plugins on the chain generate typescript; update plugin'sinclude filter to pick them up (see#111)

• module: defaults toES2015. Other valid values areES2020,ES2022 andESNext (required for dynamic imports, see#54).

• moduleResolution: defaults tonode10 (same asnode), but value from tsconfig is used if specified. Other valid (but mostly untested) values arenode16,nodenext andbundler. If in doubt, usenode10.

  • classic isdeprecated and changed tonode10. It also breaks this plugin, see#12 and#14.

• allowJs: lets TypeScript process JS files as well. If you use it, modify this plugin'sinclude option to add"*.js+(|x)", "**/*.js+(|x)" (might also want toexclude"**/node_modules/**/*", as it can slow down the build significantly).

Must be beforerollup-plugin-typescript2 in the plugin list, especially when thebrowser: true option is used (see#66).

See the explanation forrollupCommonJSResolveHack option below.

This plugin transpiles code, but doesn't change file extensions.@rollup/plugin-babel only looks at code with these extensionsby default:.js,.jsx,.es6,.es,.mjs. To workaround this, add.ts and.tsx to its list of extensions.

// ...import{DEFAULT_EXTENSIONS}from'@babel/core';// ...babel({extensions:[...DEFAULT_EXTENSIONS,'.ts','.tsx']}),// ...

See#108

• cwd:string

  The current working directory. Defaults toprocess.cwd().

• tsconfigDefaults:{}

  The object passed astsconfigDefaults will be merged with the loadedtsconfig.json.The final config passed to TypeScript will be the result of values intsconfigDefaults replaced by values in the loadedtsconfig.json, replaced by values intsconfigOverride, and then replaced by forcedcompilerOptions overrides on top of that (see above).

  For simplicity and other tools' sake, try to minimize the usage of defaults and overrides and keep everything in atsconfig.json file (tsconfigs can themselves be chained withextends, so save some turtles).

  letdefaults={compilerOptions:{declaration:true}};letoverride={compilerOptions:{declaration:false}};// ... plugins:[typescript({tsconfigDefaults:defaults,tsconfig:"tsconfig.json",tsconfigOverride:override})]

  This is adeep merge: objects are merged, arrays are merged by index, primitives are replaced, etc.Increaseverbosity to3 and look forparsed tsconfig if you get something unexpected.

• tsconfig:undefined

  Path totsconfig.json.Set this if yourtsconfig has another name or relative location from the project directory.

  By default, will try to load./tsconfig.json, but will not fail if the file is missing, unless the value is explicitly set.

• tsconfigOverride:{}

  SeetsconfigDefaults.

• check: true

  Set to false to avoid doing any diagnostic checks on the code.Setting to false is sometimes referred to astranspileOnly by other TypeScript integrations.

• verbosity: 1

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

• clean: false

  Set to true to disable the cache and do a clean build.This also wipes any existing cache.

• cacheRoot:node_modules/.cache/rollup-plugin-typescript2

  Path to cache.Defaults to a folder innode_modules.

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

  By default compiles all.ts and.tsx files with TypeScript.

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

  But excludes type definitions.

• abortOnError: true

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

• rollupCommonJSResolveHack: false

  Deprecated. OS native paths are nowalways used since0.30.0 (see#251), so this no longer has any effect -- as if it is alwaystrue.

• objectHashIgnoreUnknownHack: false

  The plugin uses your Rollup config as part of its cache key.object-hash is used to generate a hash, but it can have trouble with some uncommon types of elements.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 option if you need it (e.g. if you getError: Unknown object type "xxx") and make sure to run withclean: true once in a while and definitely before a release.(See#105 and#203)

• useTsconfigDeclarationDir: false

  If true, declaration files will be emitted in thedeclarationDir given in thetsconfig.If false, 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: peerDependency

  If you'd like to use a different version of TS than the peerDependency, you can import a different TypeScript module and pass it in astypescript: require("path/to/other/typescript").

  You can also use an alternative TypeScript implementation, such asttypescript, with this option.

  Must be TS 2.0+; things might break if the compiler interfaces changed enough from what the plugin was built against.

• transformers:undefined

  experimental, TypeScript 2.4.1+

  Transformers will likely be available intsconfig eventually, so this is not a stable interface (seeMicrosoft/TypeScript#14419).

  For example, integratingkimamula/ts-transformer-keys:

  constkeysTransformer=require('ts-transformer-keys/transformer').default;consttransformer=(service)=>({before:[keysTransformer(service.getProgram())],after:[]});// ... plugins:[typescript({transformers:[transformer]})]

This plugin respectsdeclaration: true in yourtsconfig.json file.When set, it will emit*.d.ts files for your bundle.The resulting file(s) can then be used with thetypes property in yourpackage.json file as describedhere.
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 usedeclarationDir, setuseTsconfigDeclarationDir: true in the plugin options.

The above also applies todeclarationMap: true and*.d.ts.map files for your bundle.

This plugin also respectsemitDeclarationOnly: true and will only emit declarations (and declaration maps, if enabled) if set in yourtsconfig.json.If you useemitDeclarationOnly, you will need another plugin to compile any TypeScript sources, such as@rollup/plugin-babel,rollup-plugin-esbuild,rollup-plugin-swc, etc.When composing Rollup plugins this way,rollup-plugin-typescript2 will perform type-checking and declaration generation, while another plugin performs the TypeScript to JavaScript compilation.
Some scenarios where this can be particularly useful: you want to use Babel plugins on TypeScript source, or you want declarations and type-checking for your Vite builds (NOTE: this space has not been fully explored yet).

The way TypeScript handles type-only imports and ambient types effectively hides them from Rollup's watch mode, 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.

• TypeScript2.4+
• Rollup1.26.3+
• Node6.4.0+ (basic ES6 support)

SeeCONTRIBUTING.md