Quick Start#

Setup Environment#

Before getting started, you will need to install Node.js >= version 16, it is recommended to use the Node.js LTS version.

Check the current Node.js version with the following command:

node -v

If you do not have Node.js installed in current environment, or the installed version is too low, you can use nvm or fnm to install.

Here is an example of how to install via nvm:

# Install Node.js LTS
nvm install --lts
# Switch to Node.js LTS
nvm use --lts

Creating an Rslib Project#

You can use the create-rslib to create a new Rslib project. Run the following command:

npm create rslib@latest

Then follow the prompts to complete the operation.

Templates#

create-rslib is a tool for quickly creating Rslib projects. When creating a project, you can choose from the following templates:

Each template supports both JavaScript and TypeScript, along with optional development tools, formatters, and linters.

Development Tools#

create-rslib can help you set up some commonly used development linter tools, including Vitest, Storybook. You can use the arrow keys and the space bar to make your selections. If you don't need these tools, you can simply press Enter to skip.

• Vitest is available for all templates, it will be adapted based on the template's selection.
• Storybook is available for web targeted templates (React), it will be adapted based on the template's selection.

◆  Select development tools (Use <space> to select, <enter> to continue)
│  ◻ Storybook
│  ◻ Vitest
└

Optional Tools#

create-rslib can help you set up some commonly used formatter and linter tools, including Biome, ESLint, and prettier. You can use the arrow keys and the space bar to make your selections. If you don't need these tools, you can simply press Enter to skip.

◆  Select additional tools (Use <space> to select, <enter> to continue)
│  ◻ Add Biome for code linting and formatting
│  ◻ Add ESLint for code linting
│  ◻ Add Prettier for code formatting
└

Current Directory#

If you need to create a project in the current directory, you can set the target folder to .:

◆  Create Rslib Project
│
◇  Project name or path
│  .
│
◇  "." is not empty, please choose:
│  Continue and override files

Quick Creation#

create-rslib provides some CLI flags. By setting these CLI flags, you can skip the interactive selection steps and create the project with one command.

For example, to create an example project in the my-project directory with one command:

npx create-rslib --dir my-project --template example

# Using abbreviations
npx create-rslib -d my-project -t example

All the CLI flags of create-rslib:

Usage: create-rslib [options]

Options:

  -h, --help       display help for command
  -d, --dir        create project in specified directory
  -t, --template   specify the template to use
  --tools          select additional tools (biome, eslint, prettier)
  --override       override files in target directory

Migration#

If you need to migrate from an existing project to Rslib, you can refer to the following guides:

• Migrating from tsup
• Migrating from Modern.js Module