关于 faasjs-specs
用于处理 FaasJS 规范的开发技能,帮助维护者落实规范要求,并使运行时行为、文档、测试和向后兼容保持一致。
主要功能
- 01规范性要求的应用指南
- 02配置与路由参考
- 03HTTP 协议行为指南
- 04插件生命周期与配置规则
- 05关注兼容性的验证步骤
适用场景
- 01修改 FaasJS 运行时行为
- 02更新与规范一致的公开文档
- 03调整路由或配置合并行为
- 04检查插件加载和 HTTP 响应变更
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ faasjs/ faasjs --skill faasjs-specs安装后在 Claude Code 中输入/faasjs-specs确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
references/specs/faas-yaml.mdhttp-protocol.mdplugin.mdrouting-mapping.md详细介绍
FaasJS 规范
默认工作流
- 在更改运行时行为或公开文档前,加载相关规范。
- 将 MUST/SHOULD/MAY 语言视为规范性要求。
- 确保实现、文档和测试与规范保持一致。
- 除非有意进行破坏性更改并将其记录在文档中,否则应保持向后兼容。
加载以下参考文档
faas.yaml的位置、发现方式、合并顺序、暂存键、server 节点、plugins 节点和 YAML 子集:references/specs/faas-yaml.md。- 零映射文件命名和路由查找顺序:
references/specs/routing-mapping.md。 - HTTP 请求、响应封装、状态和传输行为:
references/specs/http-protocol.md。 - 插件标识、生命周期执行、配置分层、手动注册和配置驱动加载:
references/specs/plugin.md。
注意事项
- 规范具有规范性,要求可能比通用指南更严格。
- 路由行为和配置合并顺序对兼容性至关重要。
- HTTP 响应行为必须保留响应封装和底层错误之间的区别。
- 插件配置优先级必须与手动加载和配置驱动加载保持一致。
验证
- 针对变更涉及的规范领域运行有针对性的运行时测试。
- 编辑规范源文件后运行
npm run doc。 - 文档路由、规范页面或链接发生变更时,运行
cd docs && npm run build。
评论
支持 Markdown