开发指南 · 导读
本文档面向 SFMC 业务模块开发者与平台核心贡献者,介绍项目架构划分、开发环境要求与常见开发流程。
1. 仓库划分与工程边界
在开始开发前,需要先明确 SFMC 各仓库与目录的职责边界:
2. 开发环境准备
推荐编辑器扩展
- SFMC Module:官方 VS Code / Cursor 扩展,支持创建新模块、挂接软链接(Link)、文件监听热重载(Watch)与一键部署。
- ESLint:启用
@sfmc-bds/eslint-plugin,在编写代码时实时检查消息格式、SDK 导入路径与权限声明。
3. 开发路径选择
适合开发具体的服务器玩法与功能扩展:
- 模块开发手册 — 初始化模块、本地联调与发布流程
- API 速查手册 (Cheatsheet) — 消息提示、数据库、配置与服务调用代码片段
- 验证与调试指南 — 静态检查、本地联调与 BDS 运行验证
- ESLint 规则手册 · 发布你的模块 — 代码规范与 npm 发布