nodejs-best-practices
544
总安装量
544
周安装量
#528
全站排名
安装命令
npx skills add https://github.com/sickn33/antigravity-awesome-skills --skill nodejs-best-practices
Agent 安装分布
gemini-cli
357
opencode
349
claude-code
341
antigravity
296
github-copilot
273
Skill 文档
Node.js Best Practices
Principles and decision-making for Node.js development in 2025. Learn to THINK, not memorize code patterns.
â ï¸ How to Use This Skill
This skill teaches decision-making principles, not fixed code to copy.
- ASK user for preferences when unclear
- Choose framework/pattern based on CONTEXT
- Don’t default to same solution every time
1. Framework Selection (2025)
Decision Tree
What are you building?
â
âââ Edge/Serverless (Cloudflare, Vercel)
â âââ Hono (zero-dependency, ultra-fast cold starts)
â
âââ High Performance API
â âââ Fastify (2-3x faster than Express)
â
âââ Enterprise/Team familiarity
â âââ NestJS (structured, DI, decorators)
â
âââ Legacy/Stable/Maximum ecosystem
â âââ Express (mature, most middleware)
â
âââ Full-stack with frontend
âââ Next.js API Routes or tRPC
Comparison Principles
| Factor | Hono | Fastify | Express |
|---|---|---|---|
| Best for | Edge, serverless | Performance | Legacy, learning |
| Cold start | Fastest | Fast | Moderate |
| Ecosystem | Growing | Good | Largest |
| TypeScript | Native | Excellent | Good |
| Learning curve | Low | Medium | Low |
Selection Questions to Ask:
- What’s the deployment target?
- Is cold start time critical?
- Does team have existing experience?
- Is there legacy code to maintain?
2. Runtime Considerations (2025)
Native TypeScript
Node.js 22+: --experimental-strip-types
âââ Run .ts files directly
âââ No build step needed for simple projects
âââ Consider for: scripts, simple APIs
Module System Decision
ESM (import/export)
âââ Modern standard
âââ Better tree-shaking
âââ Async module loading
âââ Use for: new projects
CommonJS (require)
âââ Legacy compatibility
âââ More npm packages support
âââ Use for: existing codebases, some edge cases
Runtime Selection
| Runtime | Best For |
|---|---|
| Node.js | General purpose, largest ecosystem |
| Bun | Performance, built-in bundler |
| Deno | Security-first, built-in TypeScript |
3. Architecture Principles
Layered Structure Concept
Request Flow:
â
âââ Controller/Route Layer
â âââ Handles HTTP specifics
â âââ Input validation at boundary
â âââ Calls service layer
â
âââ Service Layer
â âââ Business logic
â âââ Framework-agnostic
â âââ Calls repository layer
â
âââ Repository Layer
âââ Data access only
âââ Database queries
âââ ORM interactions
Why This Matters:
- Testability: Mock layers independently
- Flexibility: Swap database without touching business logic
- Clarity: Each layer has single responsibility
When to Simplify:
- Small scripts â Single file OK
- Prototypes â Less structure acceptable
- Always ask: “Will this grow?”
4. Error Handling Principles
Centralized Error Handling
Pattern:
âââ Create custom error classes
âââ Throw from any layer
âââ Catch at top level (middleware)
âââ Format consistent response
Error Response Philosophy
Client gets:
âââ Appropriate HTTP status
âââ Error code for programmatic handling
âââ User-friendly message
âââ NO internal details (security!)
Logs get:
âââ Full stack trace
âââ Request context
âââ User ID (if applicable)
âââ Timestamp
Status Code Selection
| Situation | Status | When |
|---|---|---|
| Bad input | 400 | Client sent invalid data |
| No auth | 401 | Missing or invalid credentials |
| No permission | 403 | Valid auth, but not allowed |
| Not found | 404 | Resource doesn’t exist |
| Conflict | 409 | Duplicate or state conflict |
| Validation | 422 | Schema valid but business rules fail |
| Server error | 500 | Our fault, log everything |
5. Async Patterns Principles
When to Use Each
| Pattern | Use When |
|---|---|
async/await |
Sequential async operations |
Promise.all |
Parallel independent operations |
Promise.allSettled |
Parallel where some can fail |
Promise.race |
Timeout or first response wins |
Event Loop Awareness
I/O-bound (async helps):
âââ Database queries
âââ HTTP requests
âââ File system
âââ Network operations
CPU-bound (async doesn't help):
âââ Crypto operations
âââ Image processing
âââ Complex calculations
âââ â Use worker threads or offload
Avoiding Event Loop Blocking
- Never use sync methods in production (fs.readFileSync, etc.)
- Offload CPU-intensive work
- Use streaming for large data
6. Validation Principles
Validate at Boundaries
Where to validate:
âââ API entry point (request body/params)
âââ Before database operations
âââ External data (API responses, file uploads)
âââ Environment variables (startup)
Validation Library Selection
| Library | Best For |
|---|---|
| Zod | TypeScript first, inference |
| Valibot | Smaller bundle (tree-shakeable) |
| ArkType | Performance critical |
| Yup | Existing React Form usage |
Validation Philosophy
- Fail fast: Validate early
- Be specific: Clear error messages
- Don’t trust: Even “internal” data
7. Security Principles
Security Checklist (Not Code)
- Input validation: All inputs validated
- Parameterized queries: No string concatenation for SQL
- Password hashing: bcrypt or argon2
- JWT verification: Always verify signature and expiry
- Rate limiting: Protect from abuse
- Security headers: Helmet.js or equivalent
- HTTPS: Everywhere in production
- CORS: Properly configured
- Secrets: Environment variables only
- Dependencies: Regularly audited
Security Mindset
Trust nothing:
âââ Query params â validate
âââ Request body â validate
âââ Headers â verify
âââ Cookies â validate
âââ File uploads â scan
âââ External APIs â validate response
8. Testing Principles
Test Strategy Selection
| Type | Purpose | Tools |
|---|---|---|
| Unit | Business logic | node:test, Vitest |
| Integration | API endpoints | Supertest |
| E2E | Full flows | Playwright |
What to Test (Priorities)
- Critical paths: Auth, payments, core business
- Edge cases: Empty inputs, boundaries
- Error handling: What happens when things fail?
- Not worth testing: Framework code, trivial getters
Built-in Test Runner (Node.js 22+)
node --test src/**/*.test.ts
âââ No external dependency
âââ Good coverage reporting
âââ Watch mode available
10. Anti-Patterns to Avoid
â DON’T:
- Use Express for new edge projects (use Hono)
- Use sync methods in production code
- Put business logic in controllers
- Skip input validation
- Hardcode secrets
- Trust external data without validation
- Block event loop with CPU work
â DO:
- Choose framework based on context
- Ask user for preferences when unclear
- Use layered architecture for growing projects
- Validate all inputs
- Use environment variables for secrets
- Profile before optimizing
11. Decision Checklist
Before implementing:
- Asked user about stack preference?
- Chosen framework for THIS context? (not just default)
- Considered deployment target?
- Planned error handling strategy?
- Identified validation points?
- Considered security requirements?
Remember: Node.js best practices are about decision-making, not memorizing patterns. Every project deserves fresh consideration based on its requirements.