close
Rslib
  • 简体中文

      • 快速上手

      环境准备

      开始之前，需要先安装 Node.js >= 18.12.0 版本，推荐使用 Node.js LTS 版本。

      通过以下命令检查当前的 Node.js 版本：

      node -v

      如果你的环境中尚未安装 Node.js，或是版本太低，可以通过 nvm 或 fnm 安装。

      下面是通过 nvm 安装的例子：

      # 安装 Node.js LTS
nvm install --lts
# 切换 Node.js LTS
nvm use --lts

      创建 Rslib 项目

      使用 create-rslib 来创建一个 Rslib 项目，运行以下命令：

      npm
      yarn
      pnpm
      bun
      deno
      npm create rslib@latest

      按照提示一步步操作即可。在创建过程中，你可以选择是否需要 TypeScript、ESLint 等额外的工具。

      在创建完成后，你可以执行以下步骤：

      • 执行 git init 来初始化 Git 仓库。
      • 执行 npm install（或其他包管理器的 install 命令）安装 npm 依赖。
      • 执行 npm run dev 启动监听模式开始开发。

      模板

      在创建项目时，你可以选择 create-rslib 提供的下列模板：

      模板描述
      Node.js dual ESM/CJS packageNode.js 双格式 ESM/CJS 包
      Node.js pure ESM packageNode.js 纯 ESM 包
      ReactReact 组件库
      VueVue 组件库

      可选工具

      create-rslib 能够帮助你设置一些常用的工具，包括 Biome、ESLint、Prettier、Rspress、Storybook、Rstest 和 Vitest，你可以使用上下箭头和空格进行选择。如果你不需要这些工具，可以直接按回车跳过。

      • Rspress 可用于 React + TypeScript 模板，用于生成组件文档站点。
      • Storybook 可用于 Web 目标模板（React、Vue），用于组件开发和预览。
      • Rstest / Vitest 适用于所有模板，用于测试。
      ◆  Select additional tools (Use <space> to select, <enter> to continue)
│  ◻ Biome - linting & formatting
│  ◻ ESLint - linting
│  ◻ Prettier - formatting
│  ◻ Rspress - documentation
│  ◻ Storybook - component development
│  ◻ Rstest - testing
│  ◻ Vitest - testing
      Tip

      Biome 提供与 ESLint 和 Prettier 相似的代码检查和格式化功能。如果你选择了 Biome，通常就不需要再选择 ESLint 或 Prettier 了。

      当前目录

      如果你需要在当前目录下创建项目，可以将 target folder 设置为 .：

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

      非交互模式

      create-rslib 支持通过命令行选项进入非交互模式。使用该模式可以跳过所有提示，直接创建项目，适合脚本、CI 以及 coding agents 等自动化场景。

      例如，以下命令将在 my-project 目录中创建一个 React 项目：

      npx -y create-rslib@latest my-project --template react

# 使用缩写
npx -y create-rslib@latest my-project -t react

# 指定多个 tools
npx -y create-rslib@latest my-project -t react --tools rstest,biome

      create-rslib 完整的 CLI 选项如下：

      Usage: create-rslib [dir] [options]

Options:

  -h, --help            display help for command
  -d, --dir <dir>       create project in specified directory
  -t, --template <tpl>  specify the template to use
  --tools <tool>        add additional tools, comma separated
  --override            override files in target directory
  --packageName <name>  specify the package name

Available templates:
  node-dual-js, node-dual-ts, node-esm-js, node-esm-ts, react-js, react-ts, vue-js, vue-ts

Optional tools:
  biome, eslint, prettier, rspress, storybook, rstest, vitest

      从现有项目迁移

      如果你需要从一个现有项目迁移迁移到 Rslib，可以参考以下指南：

      其他项目

      对于其他类型的项目，你可以手动安装 @rslib/core 包：

      npm
      yarn
      pnpm
      bun
      deno
      npm add @rslib/core -D

      然后参考指南和文档，按需启用各个功能：