Tsup#

This section introduces how to migrate a project using tsup to Rslib.

Installing Dependencies#

First, you need to replace the npm dependencies of tsup with Rslib's dependencies.

• Remove tsup:

npm remove tsup

• Install Rslib:

npm add @rslib/core -D

Updating npm scripts#

Next, you need to update the npm scripts in your package.json to use Rslib's CLI commands.

{
  "scripts": {
-   "build": "tsup",
-   "build:watch": "tsup --watch",
+   "build": "rslib build",
+   "build:watch": "rslib build --watch"
  }
}

Create Configuration File#

Create a Rslib configuration file rslib.config.ts in the same directory as package.json, and add the following content:

import { defineConfig } from '@rslib/core';

export default defineConfig({});

Configuration Migration#

Here is the corresponding Rslib configuration for tsup configuration:

Platform#

For platform, tsup defaults to node while Rslib defaults to web (the same as tsup's browser).

If your target platform is node, you can set output.target to node:

import { defineConfig } from '@rslib/core';

export default defineConfig({
  output: {
    target: 'node',
  },
});

Contents Supplement#

The current document only covers part of the migration process. If you find suitable content to add, feel free to contribute to the documentation via pull request 🤝.

The documentation for Rslib can be found in the rslib/website directory.