Merge pull request #30 from TrueNine/dev

🚀 [release] 0.0.26

Author: TrueNine

.augment/rules/all-convention.md .augment/rules/all.md.augment/rules/all-convention.md renamed to .augment/rules/all.md

@@ -0,0 +1,120 @@
+---
+type: "always_apply"
+---
+
+
+所有语言必须遵守通用规则，特定语言必须在通用规则基础之上遵循特定语言的规则
+
+# 通用标准
+
+**强制规则**
+
+1. 始终使用**简体中文**回复，即使用户输入大量英文提示，也应返回简体中文
+2. 禁止编写任何供用户使用的示例代码，即使需要临时测试，任务完成后也必须立即删除
+3. 严禁通过简化问题来解决问题
+4. 严禁通过降级依赖版本、减少测试断言、使用恒定测试条件等来解决编译错误以及运行时错误
+5. 严禁忽略异常或任何隐藏异常的行为
+6. 严禁在代码中暴露 API 密钥、密码和令牌
+7. 应当积极按照规则来重构修复上下文中出现的代码
+8. 应积极使用日志完善记录，主动补充缺失的日志
+9. 允许在单元测试调试期间添加日志以协助解决问题
+10. 必须最大化使用 `early return` 技术来减少代码嵌套层级
+11. 严禁在对话或任务完成后生成总结文档文件和其他不必要的操作
+12. 严禁出现以下令人作呕且腐朽不堪的词汇出现在任何除开第三方库调用的任何地方
++ `util`, `utils`
++ `helper`, `helpers`
++ `tool`, `tools`
+
+13. 严禁使用 `@Suppress`/`// @ts-ignore` 等注解压制警告
+
+**渐进式开发方法论**
+
+- 采用测试驱动开发结合渐进式开发方法
+- **Baby Steps开发**：每次只编写少量代码，立即进行单元测试验证
+- **快速反馈循环**：开发一点测试一点，绝不一次性编写大量代码
+- **逐个验证原则**：为多个代码编写单元测试时，一个个编写一个个验证，避免批量编写后统一验证
+- **风险最小化**：通过频繁的小幅度验证确保代码质量，避免错误累积
+- **嵌套测试组织**：使用合适的分组，避免根级别大量独立测试方法
+- 严禁出现没有断言的测试方法，发现应该立即补全断言
+
+**日志规范**
+
+- 在没有日志的情况下，应当多使用日志记录，以协助线上问题排查解决以及获取更多上下文信息
+- 在排查问题时，可向源代码中添加更多日志，以获取更详细的上下文信息
+- 日志应当只使用英文进行记录，如发现其他语言应当立即修正为英文
+- 重点记录第三方库调用和外部API的详细日志，包括请求参数、响应结果、耗时等信息
+- 使用结构化日志格式：`log.info("API call completed - endpoint: {}, status: {}, duration: {}ms", endpoint, status, duration)`
+- 记录关键上下文信息：用户ID、请求ID、操作类型、结果状态、异常详情
+- 避免记录敏感信息：密码、API密钥、身份证号、手机号等
+- 在外部调用、数据库操作、文件操作等关键节点记录日志
+- 使用占位符格式避免字符串拼接，保持日志消息简洁明了
+- 合理使用日志级别，避免生产环境输出过多DEBUG日志
+
+**注释规则**
+
+- 文档注释：必须使用英文注释
+- 代码内部注释：必须使用中文注释
+- 严禁使用行尾注释
+
+**测试组织最佳实践：**
+
+- 每个被测试类/函数/变量/方法创建主要分组
+- 按场景细分：正常用例、异常用例、边界用例
+  + 示例kotlin：`@Nested inner class CreateUser { @Test fun should_create_successfully() {} }`
+
+**代码风格**
+
+- 代码缩进：使用2个空格缩进
+- 代码换行：每个文件必须保留行尾换行符
+- 文件编码：必须使用UTF-8编码
+- 文件换行符：必须使用LF换行符
+- 行长度：每行字符长度不能超过160个字符
+- 配置参考：可参考项目根目录下的 `.editorconfig` 配置
+
+# 特定语言约定
+
+**SQL 规则**
+
+- 严禁在 SQL 中使用任何注释
+- 检查现有查询是否使用参数化
+- 统一使用 snake_case 命名，即使是出现在其他语言中的字符串
+
+**JVM 规则**
+
+1. 严禁在测试代码中使用 `@DisplayName` 注解
+2. spring/quarkus 中严禁使用特定框架的注解，例如：`@Autowired`必须使用 `@Resource` 替代
+3. 尽可能使用项目内JDK版本能使用的最大限度的新特性
+4. 禁止在单元测试中使用 `@DisplayName` 注解
+5. 单元测试方法名称使用英文命名，以及下划线分割
+6. 禁止单元测试方法名以 `test_`、`should_` 开头
+7. 记录日志时，格式为 `log.info("message param1: {}, param2{}")` 这种格式
+8. 禁止记录详细的敏感信息，例如：密码、身份证号、APIKEY、手机号等
+
+**Java 规则**
+
+所有JVM平台的编程语言：java、kotlin、groovy、scala 均需遵守以下原则
+
+1. 可使用 `import xxx.*` 导入来减少代码量，后续交由IDE进行处理
+2. 尽可能使用jdk的新特性
+3. 声明变量应尽量使用 `final var`
+4. 积极使用 lambda
+5. 严禁使用 `System.out.println` 记录输出
+
+**Kotlin 规则**
+
+1. 优先使用val声明不可变变量
+2. 避免!!操作符，使用?.或let{}
+3. 数据类替代多参数函数
+4. 严禁使用 `println` 记录输出
+5. 严禁在单元测试中使用 `mockito`，而是使用 `mockk`
+6. 扩展方法与纯函数应分开，不应在同一文件中
++ 扩展函数文件命名规范：使用 `*Extensions.kt` 后缀
++ 纯函数文件命名规范：使用 `*Functions.kt` 后缀
+
+**TypeScript规则**
+
+- TypeScript: 启用strict模式，避免any类型
+
+**SCSS 规则**
+
+- 禁止使用 `@import`，使用 `@use` 代替