Agent skill · software engineering · affaan-m
coding-standards
适用于TypeScript、JavaScript、React和Node.js开发的通用编码标准、最佳实践和模式。
Why this skill is useful
Codifies naming conventions and best practices for TypeScript, JavaScript, React, and Node.js, which the AI could infer but now doesn't have to guess.
What it needs
About 6k tokens when loaded. Last updated 2026-08-06. 238,342 stars on the source repository.
What this skill does
编码标准与最佳实践 适用于所有项目的通用编码标准。 何时激活 开始新项目或新模块时 审查代码质量和可维护性时 重构现有代码以遵循约定时 强制执行命名、格式或结构一致性时 设置代码检查、格式化或类型检查规则时 引导新贡献者熟悉编码规范时 代码质量原则 1. 可读性优先 代码被阅读的次数远多于被编写的次数 清晰的变量和函数名 优先选择自文档化代码，而非注释 一致的格式化 2. KISS (保持简单，傻瓜) 采用能工作的最简单方案 避免过度设计 不要过早优化 易于理解 > 聪明的代码 3. DRY (不要重复自己) 将通用逻辑提取到函数中 创建可复用的组件 跨模块共享工具函数 避免复制粘贴式编程 4. YAGNI (你不会需要它) 不要预先构建不需要的功能 避免推测性泛化 仅在需要时增加复杂性 从简单开始，需要时再重构 TypeScript/JavaScript 标准 变量命名 函数命名 不可变性模式 (关键) 错误处理 Async/Await 最佳实践 类型安全 React 最佳实践 组件结构 自定义 Hooks 状态管理 条件渲染 API 设计标准 REST API 约定 响应格式 输入验证 文件组织 项目结构 文件命名 注释与文档 何时添加注释 公共 API 的 JSDoc typescript const results = await searchMarkets('election', 5) console.log(results[0].name) // "Trump vs Biden" ` 性能最佳实践 记忆化 懒加载 数据库查询 测试标准 测试结构 (AAA 模式) 测试命名 代码异味检测 警惕以下反模式： 1. 长函数 2. 深层嵌套 3. 魔法数字 记住：代码质量不容妥协。清晰、可维护的代码能够实现快速开发和自信的重构。
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills affaan-m/coding-standards--e891e3