关于 faasjs-project-workflow
faasjs-project-workflow 是用于组织和维护 FaasJS 项目的技能，涵盖项目配置、功能组织、测试与开发规范。
主要功能
- 01项目设置与布局指南
- 02垂直功能切片组织
- 03TypeScript 和 Vite 配置实践
- 04文件与命名规范
- 05测试与验证指南
适用场景
- 01为新功能安排文件
- 02按项目结构组织测试
- 03添加工具前核对配置
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/faasjs-project-workflow确认已加载。
包含的文件
除 SKILL.md 外，安装时一起下载的参考资料和脚本。
references/guidelines/application-slices.mdcli-and-tooling.mdcode-comments.mdcurated-stack.mdfile-conventions.mdgetting-started.mdnaming-convention.mdproject-config.mdtesting.md详细介绍
FaasJS 项目工作流
默认工作流
- 添加或移动文件前，先阅读项目配置和文件布局。
- 将功能组织为纵向切片，让 UI、API、数据库变更和测试彼此靠近。
- 遵循现有的
tsconfig.json别名和 Vite/Vitest 配置；除非运行时配置中也有对应设置，否则不要自行创建新别名。 - 将测试放在其所覆盖的功能或包区域中的
__tests__/目录下。 - 仅在包入口点或调用方约定不明显的共享导出上使用公共 JSDoc。
加载以下参考资料
- 新项目设置或入门：
references/guidelines/getting-started.md。 - 支持的技术栈和框架边界：
references/guidelines/curated-stack.md。 - 完整的纵向功能布局：
references/guidelines/application-slices.md。 - 文件放置和抽取规则：
references/guidelines/file-conventions.md。 - TypeScript、Vite 和共享工具配置：
references/guidelines/project-config.md。 - CLI 命令、类型生成、迁移、测试命令和环境变量：
references/guidelines/cli-and-tooling.md。 - 标识符、文件和目录名称：
references/guidelines/naming-convention.md。 - JSDoc 和行内注释策略：
references/guidelines/code-comments.md。 - 共享测试级别和模拟边界规则：
references/guidelines/testing.md。
注意事项
- 测试、固定数据和模拟对象应放在相关的
__tests__/目录下，而不是作为同级文件。 - 仅为复用、明确的边界或较大的代码块抽取组件、钩子、辅助函数或抽象。
- 不要在未修改的代码中添加注释；应删除已确认无用的代码，而不是留下标记。
- 应从源文件重新生成派生文档，而不是直接编辑生成的文档。
验证
- 条件允许时，在修改代码或文档源文件后运行
vp check --fix。 - 行为变更后运行
vp test，或运行针对性的vp test <pattern>。 - 如果指南、源文档、API JSDoc 或文档导航受到影响，则运行
npm run doc。
评论
支持 Markdown