Macro代码规范CS/FE规则集解析200条Code Review风格指南【免费下载链接】macroMacro is a unified workspace for teams: email, chat, docs, tasks, agents, calls, and CRM — -linked together with shared AI memory.项目地址: https://gitcode.com/GitHub_Trending/macro3/macroMacro 是一个集成邮件、聊天、文档、任务、AI Agent、通话与 CRM 的统一团队工作区所有信息通过 -链接互通。它的开源仓库里藏着一份极其完整的Macro 代码规范按 CSRust 后端/ FE前端双轨编号的 Code Review 风格指南配合自动化质量门禁形成 200 检查点的质量矩阵。本文带你完整读懂这套规则集的设计思路。 CS/FE 双轨编号一套可引用的规则体系风格指南 docs/STYLE_GUIDE.md 中的每条规则都遵循统一格式规则ID [作用域标签] 规则说明 (证据 · 执行手段 · 关联文档)规则集覆盖范围编号示例CS-##Rust 后端crates/、services/、tooling/CS-01、CS-30、CS-55FE-##前端与共享 TypeScriptapps/web、packages/FE-01、FE-25、FE-33两个值得借鉴的设计细节ID 永不重排评审时可以直接写“见 CS-30”“FE-25”规则删除后留下空号而不是回填——规则集因此成为一份可长期引用的“坐标系”。作用域标签可 grepCS 用[db][types][cfg][err][arch][api][sec][rust][perf][test]十个标签FE 用[data][solid][async][arch][ts][ui]六个标签一条命令即可捞出某个领域下的全部约定。 55 条 CS 规则Rust 后端评审要点CS 规则集覆盖从数据库到 AI 遥测的 55 条约定。下面是 Code Review 中最常出现的几条规则一句话解读CS-01ID 在应用代码里生成 UUIDv7——v7 天然按创建时间排序禁用数据库gen_random_uuid()CS-08默认使用编译期检查的sqlx::query!由 clippydisallowed-methods直接拦截非宏写法CS-14环境访问一律走macro_env_var/macro_config禁止std::env::varCS-15快速失败——缺环境变量应该在服务启动时就终止而不是拖到请求内部CS-24源文件控制在约 1000 行以内在评审人开口之前就拆好CS-26先复用再实现——服务客户端、权限检查、oauth 工具先找现成的别写第二份CS-30Axum handler 通过State拿共享服务不用Extensionast-grep 强制执行CS-41用#[expect(..., reason)]替代#[allow(...)]——lint 失效时expect会报警CS-51领域层不出现 AWS/redis/reqwest 等基础设施——六边形架构依赖只允许指向内层CS-01 至 CS-09 清一色[db]标签与 docs/DATABASE_DEVELOPMENT.md 的工作流一一对应改动数据库前建议先读它。⚡ 33 条 FE 规则SolidJS 前端约定FE 规则集覆盖数据获取、SolidJS 响应式、异步与 UI 约定四大板块精选如下规则一句话解读FE-01UI 代码禁止直接调用 service client——取数一律走queries包缓存层避免重复请求FE-08不搞临时全局状态模块共享状态挂在清晰所有权边界的 Context 上FE-10createEffect只用于外部/命令式系统DOM、三方库——派生状态请用派生信号FE-21禁用any用正经类型或unknown 类型守卫FE-25用语义化颜色 token不用裸 Tailwind 调色板——默认调色板已被禁用text-red-500会静默失效FE-33新功能采用分层 feature 架构以features/activity为参考实现其中 FE-33 展开为完整的 docs/FRONTEND_FEATURE_ARCHITECTURE.mdcore/放纯类型与函数、queries/放 wire 适配器、primitives/放无 JSX 响应式状态、components/放纯 props 表现组件、views/放用例组合——这是前端模块化的可执行蓝图。️ 规则如何被机器强制执行just check 四层门禁Macro 代码规范最实用的地方在于规则不只是给人看的而是被机器执行的。本地门禁只有一个命令just check定义见 tooling/just/check.just范围限定——只检查相对origin/main变更过的文件历史代码的问题永远不会干扰你快速模式——just check秒级跑完 rustfmt biome oxlint ast-grep完整模式——just check full追加 tsc clippy-Dwarnings -Dclippy::disallowed_methods可读输出——所有结果以file:line [规则ID]打印并附上修复命令背后是四层强制工具ast-greprules/ast-grep/ 下 25 个规则文件AST 级匹配代码模式。例如 rust-no-axum-extension-param.yml 就是 CS-30 的执法者文件note里直接回链规则编号clippyclippy.toml 用disallowed-methods拉黑std::env::var、sqlx::query等并写明一条换法理由oxlint落地 FE-12 的promise/prefer-await-to-then.then()/.catch()链无处遁形biomeTS/TSX 格式化 lint参数与 CI 完全一致 新手参与贡献三步上手规则集克隆并准备环境git clone https://gitcode.com/GitHub_Trending/macro3/macro按 docs/RUNNING_LOCALLY.md 完成本地搭建只改前端可不搭本地栈。提交前先自检跑just check改过 SQL 就先just prepare_db刷新 sqlx 缓存受影响包用cargo test -p crate验证。PR 里引用规则号评审人习惯直接写“见 CS-30 / FE-25”分支与 PR 标题采用 Conventional Commits 命名如feat(chat): ...完整流程见 CONTRIBUTING.md。仓库还配有 AGENTS.md 作为 AI 编码代理的入口指南前端细节在 apps/web/AGENTS.md——这套规则集本身也是“人机共读”的文档。✅ 总结Macro 代码规范规则集的最大特色每条规则都有稳定编号、作用域标签和机器执行路径。55 条 CS 规则 33 条 FE 规则叠加 25 个 ast-grep 规则文件与 clippy / oxlint / biome 多重强制层最终由just check一条命令收敛成本地质量门禁。无论你是想参与贡献还是想借鉴工程实践都值得通读一遍 docs/STYLE_GUIDE.md——这本质上是一份被压缩成 88 行的完整 Code Review 方法论。【免费下载链接】macroMacro is a unified workspace for teams: email, chat, docs, tasks, agents, calls, and CRM — -linked together with shared AI memory.项目地址: https://gitcode.com/GitHub_Trending/macro3/macro创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考 Macro代码规范CS/FE规则集解析：200+条Code Review风格指南
Macro代码规范CS/FE规则集解析200条Code Review风格指南【免费下载链接】macroMacro is a unified workspace for teams: email, chat, docs, tasks, agents, calls, and CRM — -linked together with shared AI memory.项目地址: https://gitcode.com/GitHub_Trending/macro3/macroMacro 是一个集成邮件、聊天、文档、任务、AI Agent、通话与 CRM 的统一团队工作区所有信息通过 -链接互通。它的开源仓库里藏着一份极其完整的Macro 代码规范按 CSRust 后端/ FE前端双轨编号的 Code Review 风格指南配合自动化质量门禁形成 200 检查点的质量矩阵。本文带你完整读懂这套规则集的设计思路。 CS/FE 双轨编号一套可引用的规则体系风格指南 docs/STYLE_GUIDE.md 中的每条规则都遵循统一格式规则ID [作用域标签] 规则说明 (证据 · 执行手段 · 关联文档)规则集覆盖范围编号示例CS-##Rust 后端crates/、services/、tooling/CS-01、CS-30、CS-55FE-##前端与共享 TypeScriptapps/web、packages/FE-01、FE-25、FE-33两个值得借鉴的设计细节ID 永不重排评审时可以直接写“见 CS-30”“FE-25”规则删除后留下空号而不是回填——规则集因此成为一份可长期引用的“坐标系”。作用域标签可 grepCS 用[db][types][cfg][err][arch][api][sec][rust][perf][test]十个标签FE 用[data][solid][async][arch][ts][ui]六个标签一条命令即可捞出某个领域下的全部约定。 55 条 CS 规则Rust 后端评审要点CS 规则集覆盖从数据库到 AI 遥测的 55 条约定。下面是 Code Review 中最常出现的几条规则一句话解读CS-01ID 在应用代码里生成 UUIDv7——v7 天然按创建时间排序禁用数据库gen_random_uuid()CS-08默认使用编译期检查的sqlx::query!由 clippydisallowed-methods直接拦截非宏写法CS-14环境访问一律走macro_env_var/macro_config禁止std::env::varCS-15快速失败——缺环境变量应该在服务启动时就终止而不是拖到请求内部CS-24源文件控制在约 1000 行以内在评审人开口之前就拆好CS-26先复用再实现——服务客户端、权限检查、oauth 工具先找现成的别写第二份CS-30Axum handler 通过State拿共享服务不用Extensionast-grep 强制执行CS-41用#[expect(..., reason)]替代#[allow(...)]——lint 失效时expect会报警CS-51领域层不出现 AWS/redis/reqwest 等基础设施——六边形架构依赖只允许指向内层CS-01 至 CS-09 清一色[db]标签与 docs/DATABASE_DEVELOPMENT.md 的工作流一一对应改动数据库前建议先读它。⚡ 33 条 FE 规则SolidJS 前端约定FE 规则集覆盖数据获取、SolidJS 响应式、异步与 UI 约定四大板块精选如下规则一句话解读FE-01UI 代码禁止直接调用 service client——取数一律走queries包缓存层避免重复请求FE-08不搞临时全局状态模块共享状态挂在清晰所有权边界的 Context 上FE-10createEffect只用于外部/命令式系统DOM、三方库——派生状态请用派生信号FE-21禁用any用正经类型或unknown 类型守卫FE-25用语义化颜色 token不用裸 Tailwind 调色板——默认调色板已被禁用text-red-500会静默失效FE-33新功能采用分层 feature 架构以features/activity为参考实现其中 FE-33 展开为完整的 docs/FRONTEND_FEATURE_ARCHITECTURE.mdcore/放纯类型与函数、queries/放 wire 适配器、primitives/放无 JSX 响应式状态、components/放纯 props 表现组件、views/放用例组合——这是前端模块化的可执行蓝图。️ 规则如何被机器强制执行just check 四层门禁Macro 代码规范最实用的地方在于规则不只是给人看的而是被机器执行的。本地门禁只有一个命令just check定义见 tooling/just/check.just范围限定——只检查相对origin/main变更过的文件历史代码的问题永远不会干扰你快速模式——just check秒级跑完 rustfmt biome oxlint ast-grep完整模式——just check full追加 tsc clippy-Dwarnings -Dclippy::disallowed_methods可读输出——所有结果以file:line [规则ID]打印并附上修复命令背后是四层强制工具ast-greprules/ast-grep/ 下 25 个规则文件AST 级匹配代码模式。例如 rust-no-axum-extension-param.yml 就是 CS-30 的执法者文件note里直接回链规则编号clippyclippy.toml 用disallowed-methods拉黑std::env::var、sqlx::query等并写明一条换法理由oxlint落地 FE-12 的promise/prefer-await-to-then.then()/.catch()链无处遁形biomeTS/TSX 格式化 lint参数与 CI 完全一致 新手参与贡献三步上手规则集克隆并准备环境git clone https://gitcode.com/GitHub_Trending/macro3/macro按 docs/RUNNING_LOCALLY.md 完成本地搭建只改前端可不搭本地栈。提交前先自检跑just check改过 SQL 就先just prepare_db刷新 sqlx 缓存受影响包用cargo test -p crate验证。PR 里引用规则号评审人习惯直接写“见 CS-30 / FE-25”分支与 PR 标题采用 Conventional Commits 命名如feat(chat): ...完整流程见 CONTRIBUTING.md。仓库还配有 AGENTS.md 作为 AI 编码代理的入口指南前端细节在 apps/web/AGENTS.md——这套规则集本身也是“人机共读”的文档。✅ 总结Macro 代码规范规则集的最大特色每条规则都有稳定编号、作用域标签和机器执行路径。55 条 CS 规则 33 条 FE 规则叠加 25 个 ast-grep 规则文件与 clippy / oxlint / biome 多重强制层最终由just check一条命令收敛成本地质量门禁。无论你是想参与贡献还是想借鉴工程实践都值得通读一遍 docs/STYLE_GUIDE.md——这本质上是一份被压缩成 88 行的完整 Code Review 方法论。【免费下载链接】macroMacro is a unified workspace for teams: email, chat, docs, tasks, agents, calls, and CRM — -linked together with shared AI memory.项目地址: https://gitcode.com/GitHub_Trending/macro3/macro创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考