开发规范

在开发iStock Shell时，遵循以下开发规范能够帮助你保持整个项目的一致性。

代码规范

iStock Shell使用eslint + prettier + husky + lint-staged方案来确保代码规范和一致性。这个方案集成了多种常用规范，并通过自动化工具来确保代码风格的统一性和可读性。

命名规范

文件夹和文件名

• 文件夹和文件名使用短横线(-)分隔多个单词，以保持统一和易读性。
• 对于需要区分分类的文件，可以使用[文件名].[分类].[扩展名]的命名格式，例如：.decorator.ts表示装饰器文件，.domain.ts表示命令域文件，.controller.ts表示控制器类文件，.cmd.ts表示命令描述文件，.service.ts表示命令服务文件，.model.ts表示命令数据模型文件。
• UI对应的组件文件名则使用单词首字母大写分隔。

TypeScript类型和接口

• 定义TS类型时，以大写字母T开头，命名单词以首字母大写分隔。
• 定义TS接口时，以大写字母I开头，命名单词以首字母大写分隔。

遵循这些命名规范可以使项目结构清晰，便于团队协作和代码维护。

命令描述文件

描述文件配置数据需要按照默认导出的方式进行，也就是说，你需要将配置数据放在一个默认导出的对象中，如下所示：

export default {
  // 在这里放置你的配置数据
};

这样的约定设计是为了方便使用命令工具来生成文档。