SuperAPI AI 工具集

rslib-best-practices

编程与开发

查看项目

更新于 10-16 09:52

技能介绍

用途:在编写或审查 Rslib 库项目时提供最佳实践规则,用于配置、评审或排查 Rslib 库构建中的输出格式、声明文件、依赖处理及集成问题。

配置:使用 rslib.config.ts 与 defineConfig;优先检查 Rslib 专属配置(如 lib.),并可按需复用 Rsbuild 配置(source.、output.、tools.);深度或高级配置可通过 tools.rspack 或 tools.bundlerChain 访问 Rspack 原生配置;TypeScript 项目优先使用 tsconfig.json 路径别名。

CLI:使用 rslib 构建;rslib --watch 进入监听模式用于本地开发;rslib inspect 查看最终 Rslib/Rsbuild/Rspack 配置。

输出:优先构建纯 ESM 包,在 package.json 中设置 "type": "module";构建组件库时优先使用 bundleless 模式并将 output.target 设为 'web';构建 Node.js 工具库时优先使用 bundle 模式;确保 package.json 的 exports 字段正确配置,与实际 JS 输出及各格式(ESM、CJS 等)的声明文件输出匹配。

声明文件:优先用 lib.dts: true 或详细配置启用声明文件生成;安装 @typescript/native-preview 后可启用实验性 lib.dts.tsgo 加快类型生成。

依赖:bundle 模式下应被打包的依赖放在 devDependencies;dependencies 与 peerDependencies 默认自动外部化(不打包);仔细核验构建产物与 package.json 的依赖说明符,避免使用者安装时出现缺失依赖错误。

构建优化:保持 lib.syntax 的语法目标与真实兼容性需求一致以获得更好优化;避免在源码中使用特定格式的 API,提升对不同输出格式的兼容性;优先选择轻量依赖以减小打包体积。

工具链集成:优先使用 Rstest 配合 @rstest/adapter-rslib 编写测试;优先使用 Rspress 编写库文档,并配合 @rspress/plugin-preview 与 @rspress/plugin-api-docgen 实现组件预览和 API 文档。

调试:诊断配置解析或插件行为时使用 DEBUG=rsbuild 运行;查看 dist/.rsbuild 中的生成文件确认最终 Rsbuild/Rspack 配置,而非假定配置。

文档:最新 Rslib 文档见 https://rslib.rs/llms.txt。

限制:资料未提供具体版本要求、完整配置示例细节及更多场景说明。