nodejs-best-practices

Name: nodejs-best-practices
Author: nearform

github.com/nearform开发79 次安装

关于 nodejs-best-practices

nodejs-best-practices 是 Nearform 维护的 Node.js 与 Fastify 开发指南，面向编写、审查和重构相关应用的开发者。指南按影响优先级组织 48 条规则，涵盖性能、安全、API、错误处理及监控等主题。

主要功能

01涵盖 8 个类别的 48 条规则
02按影响程度排列规则优先级
03包含 Node.js 与 Fastify 实践
04提供错误与正确代码示例
05可查阅独立规则文件和汇编文档

适用场景

01设计新的 Node.js API 或 Fastify 路由
02审查数据库操作及 API 性能
03排查安全、错误处理和日志问题
04重构应用或优化 API 响应时间

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/nearform/agent-skills --skill nodejs-best-practices

安装后在 Claude Code 中输入/nodejs-best-practices确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

AGENTS.md

metadata.json

README.md

rules/

_sections.md

_template.md

api-connection-pooling.md

api-n-plus-one.md

api-pagination.md

api-query-optimization.md

api-rest-design.md

api-transactions.md

async-backpressure.md

async-error-handling.md

async-parallel.md

async-queue-management.md

async-rate-limiting.md

async-timeout.md

cache-database.md

cache-http-headers.md

cache-invalidation.md

cache-lru.md

cache-redis.md

cache-stale-revalidate.md

code-config-management.md

code-dependency-injection.md

code-env-variables.md

code-module-structure.md

code-testing.md

code-typescript.md

error-async-errors.md

详细介绍

Node.js 最佳实践

面向 Node.js 和 Fastify 应用的综合指南，由 Nearform 维护。包含 8 个类别中的 48 条规则，并按影响程度排序，以指导自动重构和代码生成。

适用场景

在以下情况下参考这些指南：

编写新的 Node.js API 或 Fastify 路由
实现数据库操作
检查代码中的性能或安全问题
重构现有的 Node.js/Fastify 代码
优化 API 响应时间
处理错误和日志记录
设置监控和可观测性

按优先级划分的规则类别

优先级	类别	影响	前缀
1	性能与安全	严重	`perf-`
2	API 设计与数据库	严重	`api-`
3	错误处理与日志记录	高	`error-`
4	Fastify 优化	中高	`fastify-`
5	异步模式	中	`async-`
6	缓存与状态	中	`cache-`
7	代码组织	中低	`code-`
8	监控与诊断	低	`monitor-`

快速参考

1. 性能与安全（严重）

perf-block-event-loop - 检测并防止事件循环阻塞
perf-security-headers - 实施必要的安全标头
perf-input-validation - 验证并清理所有输入
perf-streaming - 使用流处理大型负载
perf-memory-leaks - 防止内存泄漏
perf-compression - 实施压缩策略

2. API 设计与数据库（严重）

api-rest-design - 遵循 RESTful 设计原则
api-pagination - 实施高效分页
api-connection-pooling - 使用连接池
api-query-optimization - 优化数据库查询
api-n-plus-one - 防止 N+1 查询问题
api-transactions - 正确处理事务

3. 错误处理与日志记录（高）

error-middleware - 集中处理错误
error-structured-logging - 使用结构化日志记录（Pino）
error-async-errors - 正确处理异步错误
error-sensitive-data - 不要在错误中泄露敏感数据
error-unhandled-rejection - 处理未处理的拒绝
error-request-logging - 高效记录请求日志

4. Fastify 优化（中高）

fastify-schema-validation - 使用 JSON 模式验证
fastify-hooks - 优化钩子用法
fastify-plugins - 设计可复用的插件
fastify-decorators - 有效使用装饰器
fastify-serialization - 优化 JSON 序列化
fastify-content-type - 正确处理内容类型

5. 异步模式（中）

async-parallel - 并行执行相互独立的操作
async-error-handling - 妥善处理异步错误
async-backpressure - 处理流中的背压
async-rate-limiting - 实施速率限制
async-queue-management - 使用队列处理后台任务
async-timeout - 为操作设置超时

6. 缓存与状态（中）

cache-lru - 使用内存中的 LRU 缓存
cache-redis - 实施 Redis 缓存
cache-http-headers - 使用 HTTP 缓存标头
cache-invalidation - 实施缓存失效机制
cache-stale-revalidate - 使用 stale-while-revalidate 模式
cache-database - 缓存数据库查询

7. 代码组织（中低）

code-module-structure - 按功能组织代码
code-dependency-injection - 使用依赖注入
code-config-management - 正确管理配置
code-env-variables - 处理环境变量
code-testing - 编写可测试的代码
code-typescript - 有效使用 TypeScript

8. 监控与诊断（低）

monitor-health-check - 实施运行状况检查端点
monitor-metrics - 收集应用指标
monitor-apm - 集成 APM 工具
monitor-memory - 监控内存使用情况
monitor-cpu - 分析 CPU 使用情况
monitor-distributed-tracing - 实施分布式追踪

使用方法

阅读各个规则文件，了解详细说明和代码示例：

rules/perf-block-event-loop.md
rules/api-n-plus-one.md
rules/_sections.md

每个规则文件都包含：

简要说明其重要性
错误代码示例及说明
正确代码示例及说明
补充背景信息和参考资料

完整编译文档

如需查看包含所有展开规则的完整指南：AGENTS.md

支持 Markdown

登录后评论

基本信息

作者: nearform
仓库: nearform/agent-skills
分类: 开发
安装次数: 79

报告问题