carbon-design-system/sveld

说明与用途

**项目简介**
carbon-design-system/sveld 是一个面向 Svelte 组件的工具，能够自动生成 TypeScript 类型定义和完整的组件文档，从而提升代码可维护性并加速 UI 开发。

**价值**

• **统一类型安全**：为每个 Svelte 组件输出精准的 .d.ts，在 TypeScript 项目中实现完整的类型检查。
• **文档即代码**：基于组件源码自动生成 Markdown/HTML 文档，省去手动编写 API 手册的时间。
• **加速原型与审查**：在区块链/Web3 场景下，可快速搭建钱包、DeFi、链上交互等 UI 原型，并通过生成的文档让团队成员快速了解组件的属性、事件和插槽，帮助审查链路实现细节。

**典型接入方式**

1. **安装**：npm i -D @carbon-design-system/sveld（或 pnpm add -D）。
2. **配置**：在项目根目录新建 sveld.config.js，指定组件入口、输出目录以及需要的文档格式，例如：

   module.exports = {
     components: 'src/lib/**/*.svelte',
     outDir: 'docs/components',
     typesDir: 'src/types',
     markdown: true,
   };

1. **运行**：在 package.json 中添加脚本 "gen:docs": "sveld"，执行 npm run gen:docs 即可生成 TypeScript 定义文件和文档。
2. **CI 集成**：将上述脚本加入 CI 流程（如 GitHub Actions），确保每次提交后文档和类型保持同步。

**生产可用性**

• **成熟度**：已有 444 ★、24 Fork，最近一次更新在 2026‑06‑27，活跃度尚可。
• **适用场景**：非常适合作为内部原型、组件库的文档生成以及 Web3 前端的快速迭代工具。
• **上线准备**：在生产环境使用前建议完成以下检查：

1. **依赖审计**：确认 sveld 及其依赖的许可证兼容性并通过安全扫描。
2. **维护者确认**：检查最近的 Issue/PR 活动，确保项目仍有活跃维护者。
3. **回归测试**：在小型 POC 中验证生成的 .d.ts 与实际运行时行为一致，避免类型不匹配导致的运行错误。

• **风险等级**：中等。对原型和内部工具非常可靠，若用于面向外部用户的生产系统，需要额外的依赖管理和持续维护措施。

实际用途

carbon-design-system/sveld helps prototype or inspect blockchain workflows with open implementation details.

• build Web3 workflows
• inspect blockchain integrations
• prototype wallet or DeFi features

限制与审查说明

Medium: useful for prototypes or internal workflows, with dependency and maintenance checks before production.