TypeScript#

How to use#

Enabling TypeScript support can be done through builtin:swc-loader.

module.exports = {
  module: {
    rules: [
      {
        test: /\.ts$/,
        exclude: [/node_modules/],
        loader: 'builtin:swc-loader',
        options: {
          jsc: {
            parser: {
              syntax: 'typescript',
            },
          },
        },
        type: 'javascript/auto',
      },
    ],
  },
};

Transpile only#

For maximum speed, builtin:swc-loader transpiles TypeScript source code without performing any type checking. An external tool such as tsc must be used for type checking.

Enable isolatedModules#

To maximize parallelism, builtin:swc-loader will transpile each module separately. This requires that isolatedModules must be enabled in your TypeScript configuration to ensure type check of source code by tsc. Certain language features such as const enums rely on parsing the entire project, and thus cannot be used with isolated module transpilation. Enable isolatedModules in your tsconfig.json file to ensure that your IDE hints and type checker accurately reflect Rspack's module handling behavior:

{
  "compilerOptions": {
    "isolatedModules": true
  }
}

TypeCheck#

You can use the fork-ts-checker-webpack-plugin to perform TypeScript type checking during compilation. However, it's important to note that TypeScript's type checking can be time-consuming, especially for larger projects. This means that the time required for type checking may exceed the build time of Rspack itself.

If you are using the plugin in development mode, it won't block the build and you can continue with the build process. However, in build mode, the plugin will block the build until the type checking is complete which may lead to longer build times.

Based on your actual needs, you should decide whether to enable this plugin. If the type checking process becomes a bottleneck in your build process, we recommend using TypeScript's incremental build feature. This feature can greatly speed up the type checking process by only analyzing the changed files since the last build.

To enable TypeScript's incremental build, you can use tsc --incremental independently or enabling incremental mode in the plugin.

Enabling incremental build can help reduce type checking time, especially when only a few files have been modified. This way, you can optimize your build process without sacrificing the benefits of type checking.

Remember to evaluate the trade-off between build speed and the accuracy of type checking in your specific project, and choose the best approach accordingly.

JSX and TSX#

Enabling TSX|JSX support can be done through builtin:swc-loader.

module.exports = {
  module: {
    rules: [
      {
        test: /\.jsx$/,
        use: {
          loader: 'builtin:swc-loader',
          options: {
            jsc: {
              parser: {
                syntax: 'ecmascript',
                jsx: true,
              },
              transform: {
                react: {
                  pragma: 'React.createElement',
                  pragmaFrag: 'React.Fragment',
                  throwIfNamespace: true,
                  development: false,
                  useBuiltins: false,
                },
              },
            },
          },
        },
        type: 'javascript/auto',
      },
    ],
  },
};

Alias#

See resolve.tsConfig for details.

Client types#

It's possible to use the type of webpack or Rspack specific features in your TypeScript code, such as import.meta.webpackContext.

Rspack provides client module types via @rspack/core/module, you can declare them in different ways:

1. Add the TypeScript reference directive to declare:

   Add the following content to the global d.ts declarattion file:

   src/index.ts

   /// <reference types="@rspack/core/module" />

   It can then be used in any TypeScript file:

   src/index.ts

   console.log(import.meta.webpackContext); // without reference declared above, TypeScript will throw an error

2. You can also add @rspack/core/module to the types field of tsconfig.json. You could refer to the tsconfig types document for more details.

   tsconfig.json

   {
     "compilerOptions": {
       "types": ["@rspack/core/module"]
     }
   }