README.md

ts-transform-default-export

A TypeScript transformer that converts a default export such as one of these:

export default function foo() {}
export default foo
export { foo as default }

to its CommonJS counterpart:

export = foo

When such a module is then transpiled to CommonJS or UMD, the export will become module.exports = foo, making the module consumable by require('foo') instead of require('foo').default.

This is useful when making a package compatible with both CommonJS and ES modules.

Installation

npm install --save-dev ts-transform-default-export

Usage

After the package is installed, you need to add it to your TypeScript compilation pipeline. Currently there is no native way to do it, so you'll have to use a third-party tool (TTypescript, ts-patch) or a plugin for your bundler (e.g. rollup-plugin-ts). For concrete instructions refer to the docs of the tool of your choice. When adding the transformer, keep in mind that its type is program, the most common one.

The transformer can be added to the before or afterDeclarations stages of compilation.

• When added to the before stage, it will transform only modules themselves. In this case the resulting code will not match its type declarations.

• When added to afterDeclarations, it will transform only declaration files. This will also produce mismatching type declarations. However, this can be useful if your build tool transforms the modules for you (e.g. rollup with output.exports = 'default') and you want to make the declarations compatible.

• When added to both before and afterDeclarations, both modules and declarations will be transformed. This is the most common case that produces matching files.

Only files that match the files or include property of your tsconfig.json will be transformed. This is an intentional restriction to make it possible to control which files are processed.

Example tsconfig.json for TTypescript

{
  "compilerOptions": {
    "module": "CommonJS",
    "plugins": [{
      "transform": "ts-transform-default-export",
      "afterDeclarations": true,
      "keepOriginalExport": true // Option of the transformer
    }]
  },
  "include": ["src/index.ts"]
}

Example rollup.config.js with rollup-plugin-ts

import typescript from 'rollup-plugin-ts'
import transformDefaultExport from 'ts-transform-default-export'

export default {
  input: 'src/index.ts',
  output: [
    {
      dir: 'dist',
      format: 'cjs',
      sourcemap: true,
      exports: 'default',
      entryFileNames: '[name].js',
      plugins: [],
    },
    {
      dir: 'dist',
      format: 'umd',
      sourcemap: true,
      name: 'lib',
      exports: 'default',
      entryFileNames: '[name].umd.js',
      plugins: [terser()],
    },
  ],
  plugins: [
    typescript({
      transformers: ({ program }) => ({
        afterDeclarations: transformDefaultExport(program),
      }),
    }),
  ],
}

Options

keepOriginalExport: boolean

Whether to keep the original default export in the code when transforming it. Useful if you want to get a declaration file that is compatible with both CommonJS and ES modules.

• When false (default):

  export default foo → export = foo

• When true:

  export default foo → export default foo; export = foo

allowNamedExports: boolean

Whether to throw when there are named exports in the module along with the default one.

This is important because when a default export is converted to export =, named exports could get lost. For example, export { foo as default, bar } becomes exports.bar = bar; module.exports = foo, so bar is overwritten.

You can work around this by assigning the named exports to the default export's value if possible (foo.bar = bar; export { foo as default, bar }) and setting this option to true.

• When false (default):

  export { foo as default, bar } → throws an error

• When true (and keepOriginalExport is false):

  export { foo as default, bar } → export { bar }; export = foo

• When true (and keepOriginalExport is true):

  export { foo as default, bar } → export { foo as default, bar }; export = foo

License

ISC