cp-toolkit 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +130 -0
- package/bin/cp-kit.js +72 -0
- package/package.json +46 -0
- package/src/commands/add.js +212 -0
- package/src/commands/doctor.js +149 -0
- package/src/commands/init.js +662 -0
- package/src/commands/list.js +128 -0
- package/src/index.js +13 -0
- package/templates/agents/backend-specialist.md +263 -0
- package/templates/agents/code-archaeologist.md +106 -0
- package/templates/agents/database-architect.md +226 -0
- package/templates/agents/debugger.md +225 -0
- package/templates/agents/devops-engineer.md +242 -0
- package/templates/agents/documentation-writer.md +104 -0
- package/templates/agents/explorer-agent.md +73 -0
- package/templates/agents/frontend-specialist.md +556 -0
- package/templates/agents/game-developer.md +162 -0
- package/templates/agents/mobile-developer.md +377 -0
- package/templates/agents/orchestrator.md +416 -0
- package/templates/agents/penetration-tester.md +188 -0
- package/templates/agents/performance-optimizer.md +187 -0
- package/templates/agents/product-manager.md +112 -0
- package/templates/agents/product-owner.md +95 -0
- package/templates/agents/project-planner.md +406 -0
- package/templates/agents/qa-automation-engineer.md +103 -0
- package/templates/agents/security-auditor.md +170 -0
- package/templates/agents/seo-specialist.md +111 -0
- package/templates/agents/test-engineer.md +158 -0
- package/templates/github/agents/backend-specialist.md +67 -0
- package/templates/github/agents/code-archaeologist.md +61 -0
- package/templates/github/agents/database-architect.md +73 -0
- package/templates/github/agents/debugger.md +71 -0
- package/templates/github/agents/devops-engineer.md +85 -0
- package/templates/github/agents/documentation-writer.md +107 -0
- package/templates/github/agents/explorer-agent.md +87 -0
- package/templates/github/agents/frontend-specialist.md +54 -0
- package/templates/github/agents/game-developer.md +94 -0
- package/templates/github/agents/mobile-developer.md +75 -0
- package/templates/github/agents/orchestrator.md +48 -0
- package/templates/github/agents/penetration-tester.md +87 -0
- package/templates/github/agents/performance-optimizer.md +70 -0
- package/templates/github/agents/product-manager.md +85 -0
- package/templates/github/agents/product-owner.md +77 -0
- package/templates/github/agents/project-planner.md +83 -0
- package/templates/github/agents/qa-automation-engineer.md +95 -0
- package/templates/github/agents/security-auditor.md +72 -0
- package/templates/github/agents/seo-specialist.md +78 -0
- package/templates/github/agents/test-engineer.md +79 -0
- package/templates/github/instructions/database.instructions.md +74 -0
- package/templates/github/instructions/python.instructions.md +76 -0
- package/templates/github/instructions/security.instructions.md +73 -0
- package/templates/github/instructions/typescript.instructions.md +50 -0
- package/templates/rules/GEMINI.md +273 -0
- package/templates/scripts/mcp-server.js +704 -0
- package/templates/skills/core/behavioral-modes/SKILL.md +242 -0
- package/templates/skills/core/brainstorming/SKILL.md +163 -0
- package/templates/skills/core/brainstorming/dynamic-questioning.md +350 -0
- package/templates/skills/core/clean-code/SKILL.md +201 -0
- package/templates/skills/core/intelligent-routing/SKILL.md +335 -0
- package/templates/skills/core/mcp-builder/SKILL.md +176 -0
- package/templates/skills/core/parallel-agents/SKILL.md +175 -0
- package/templates/skills/core/plan-writing/SKILL.md +152 -0
- package/templates/skills/optional/api-patterns/SKILL.md +81 -0
- package/templates/skills/optional/api-patterns/api-style.md +42 -0
- package/templates/skills/optional/api-patterns/auth.md +24 -0
- package/templates/skills/optional/api-patterns/documentation.md +26 -0
- package/templates/skills/optional/api-patterns/graphql.md +41 -0
- package/templates/skills/optional/api-patterns/rate-limiting.md +31 -0
- package/templates/skills/optional/api-patterns/response.md +37 -0
- package/templates/skills/optional/api-patterns/rest.md +40 -0
- package/templates/skills/optional/api-patterns/scripts/api_validator.py +211 -0
- package/templates/skills/optional/api-patterns/security-testing.md +122 -0
- package/templates/skills/optional/api-patterns/trpc.md +41 -0
- package/templates/skills/optional/api-patterns/versioning.md +22 -0
- package/templates/skills/optional/app-builder/SKILL.md +75 -0
- package/templates/skills/optional/app-builder/agent-coordination.md +71 -0
- package/templates/skills/optional/app-builder/feature-building.md +53 -0
- package/templates/skills/optional/app-builder/project-detection.md +34 -0
- package/templates/skills/optional/app-builder/scaffolding.md +118 -0
- package/templates/skills/optional/app-builder/tech-stack.md +40 -0
- package/templates/skills/optional/app-builder/templates/SKILL.md +39 -0
- package/templates/skills/optional/app-builder/templates/astro-static/TEMPLATE.md +76 -0
- package/templates/skills/optional/app-builder/templates/chrome-extension/TEMPLATE.md +92 -0
- package/templates/skills/optional/app-builder/templates/cli-tool/TEMPLATE.md +88 -0
- package/templates/skills/optional/app-builder/templates/electron-desktop/TEMPLATE.md +88 -0
- package/templates/skills/optional/app-builder/templates/express-api/TEMPLATE.md +83 -0
- package/templates/skills/optional/app-builder/templates/flutter-app/TEMPLATE.md +90 -0
- package/templates/skills/optional/app-builder/templates/monorepo-turborepo/TEMPLATE.md +90 -0
- package/templates/skills/optional/app-builder/templates/nextjs-fullstack/TEMPLATE.md +82 -0
- package/templates/skills/optional/app-builder/templates/nextjs-saas/TEMPLATE.md +100 -0
- package/templates/skills/optional/app-builder/templates/nextjs-static/TEMPLATE.md +106 -0
- package/templates/skills/optional/app-builder/templates/nuxt-app/TEMPLATE.md +101 -0
- package/templates/skills/optional/app-builder/templates/python-fastapi/TEMPLATE.md +83 -0
- package/templates/skills/optional/app-builder/templates/react-native-app/TEMPLATE.md +93 -0
- package/templates/skills/optional/architecture/SKILL.md +55 -0
- package/templates/skills/optional/architecture/context-discovery.md +43 -0
- package/templates/skills/optional/architecture/examples.md +94 -0
- package/templates/skills/optional/architecture/pattern-selection.md +68 -0
- package/templates/skills/optional/architecture/patterns-reference.md +50 -0
- package/templates/skills/optional/architecture/trade-off-analysis.md +77 -0
- package/templates/skills/optional/bash-linux/SKILL.md +199 -0
- package/templates/skills/optional/code-review-checklist/SKILL.md +109 -0
- package/templates/skills/optional/database-design/SKILL.md +52 -0
- package/templates/skills/optional/database-design/database-selection.md +43 -0
- package/templates/skills/optional/database-design/indexing.md +39 -0
- package/templates/skills/optional/database-design/migrations.md +48 -0
- package/templates/skills/optional/database-design/optimization.md +36 -0
- package/templates/skills/optional/database-design/orm-selection.md +30 -0
- package/templates/skills/optional/database-design/schema-design.md +56 -0
- package/templates/skills/optional/database-design/scripts/schema_validator.py +172 -0
- package/templates/skills/optional/deployment-procedures/SKILL.md +241 -0
- package/templates/skills/optional/documentation-templates/SKILL.md +194 -0
- package/templates/skills/optional/frontend-design/SKILL.md +418 -0
- package/templates/skills/optional/frontend-design/animation-guide.md +331 -0
- package/templates/skills/optional/frontend-design/color-system.md +311 -0
- package/templates/skills/optional/frontend-design/decision-trees.md +418 -0
- package/templates/skills/optional/frontend-design/motion-graphics.md +306 -0
- package/templates/skills/optional/frontend-design/scripts/accessibility_checker.py +183 -0
- package/templates/skills/optional/frontend-design/scripts/ux_audit.py +722 -0
- package/templates/skills/optional/frontend-design/typography-system.md +345 -0
- package/templates/skills/optional/frontend-design/ux-psychology.md +541 -0
- package/templates/skills/optional/frontend-design/visual-effects.md +383 -0
- package/templates/skills/optional/game-development/2d-games/SKILL.md +119 -0
- package/templates/skills/optional/game-development/3d-games/SKILL.md +135 -0
- package/templates/skills/optional/game-development/SKILL.md +167 -0
- package/templates/skills/optional/game-development/game-art/SKILL.md +185 -0
- package/templates/skills/optional/game-development/game-audio/SKILL.md +190 -0
- package/templates/skills/optional/game-development/game-design/SKILL.md +129 -0
- package/templates/skills/optional/game-development/mobile-games/SKILL.md +108 -0
- package/templates/skills/optional/game-development/multiplayer/SKILL.md +132 -0
- package/templates/skills/optional/game-development/pc-games/SKILL.md +144 -0
- package/templates/skills/optional/game-development/vr-ar/SKILL.md +123 -0
- package/templates/skills/optional/game-development/web-games/SKILL.md +150 -0
- package/templates/skills/optional/geo-fundamentals/SKILL.md +156 -0
- package/templates/skills/optional/geo-fundamentals/scripts/geo_checker.py +289 -0
- package/templates/skills/optional/i18n-localization/SKILL.md +154 -0
- package/templates/skills/optional/i18n-localization/scripts/i18n_checker.py +241 -0
- package/templates/skills/optional/lint-and-validate/SKILL.md +45 -0
- package/templates/skills/optional/lint-and-validate/scripts/lint_runner.py +172 -0
- package/templates/skills/optional/lint-and-validate/scripts/type_coverage.py +173 -0
- package/templates/skills/optional/mobile-design/SKILL.md +394 -0
- package/templates/skills/optional/mobile-design/decision-trees.md +516 -0
- package/templates/skills/optional/mobile-design/mobile-backend.md +491 -0
- package/templates/skills/optional/mobile-design/mobile-color-system.md +420 -0
- package/templates/skills/optional/mobile-design/mobile-debugging.md +122 -0
- package/templates/skills/optional/mobile-design/mobile-design-thinking.md +357 -0
- package/templates/skills/optional/mobile-design/mobile-navigation.md +458 -0
- package/templates/skills/optional/mobile-design/mobile-performance.md +767 -0
- package/templates/skills/optional/mobile-design/mobile-testing.md +356 -0
- package/templates/skills/optional/mobile-design/mobile-typography.md +433 -0
- package/templates/skills/optional/mobile-design/platform-android.md +666 -0
- package/templates/skills/optional/mobile-design/platform-ios.md +561 -0
- package/templates/skills/optional/mobile-design/scripts/mobile_audit.py +670 -0
- package/templates/skills/optional/mobile-design/touch-psychology.md +537 -0
- package/templates/skills/optional/nextjs-react-expert/1-async-eliminating-waterfalls.md +312 -0
- package/templates/skills/optional/nextjs-react-expert/2-bundle-bundle-size-optimization.md +240 -0
- package/templates/skills/optional/nextjs-react-expert/3-server-server-side-performance.md +490 -0
- package/templates/skills/optional/nextjs-react-expert/4-client-client-side-data-fetching.md +264 -0
- package/templates/skills/optional/nextjs-react-expert/5-rerender-re-render-optimization.md +581 -0
- package/templates/skills/optional/nextjs-react-expert/6-rendering-rendering-performance.md +432 -0
- package/templates/skills/optional/nextjs-react-expert/7-js-javascript-performance.md +684 -0
- package/templates/skills/optional/nextjs-react-expert/8-advanced-advanced-patterns.md +150 -0
- package/templates/skills/optional/nextjs-react-expert/SKILL.md +267 -0
- package/templates/skills/optional/nextjs-react-expert/scripts/convert_rules.py +222 -0
- package/templates/skills/optional/nextjs-react-expert/scripts/react_performance_checker.py +252 -0
- package/templates/skills/optional/nodejs-best-practices/SKILL.md +333 -0
- package/templates/skills/optional/performance-profiling/SKILL.md +143 -0
- package/templates/skills/optional/performance-profiling/scripts/lighthouse_audit.py +76 -0
- package/templates/skills/optional/powershell-windows/SKILL.md +167 -0
- package/templates/skills/optional/python-patterns/SKILL.md +441 -0
- package/templates/skills/optional/red-team-tactics/SKILL.md +199 -0
- package/templates/skills/optional/seo-fundamentals/SKILL.md +129 -0
- package/templates/skills/optional/seo-fundamentals/scripts/seo_checker.py +219 -0
- package/templates/skills/optional/server-management/SKILL.md +161 -0
- package/templates/skills/optional/systematic-debugging/SKILL.md +109 -0
- package/templates/skills/optional/tailwind-patterns/SKILL.md +269 -0
- package/templates/skills/optional/tdd-workflow/SKILL.md +149 -0
- package/templates/skills/optional/testing-patterns/SKILL.md +178 -0
- package/templates/skills/optional/testing-patterns/scripts/test_runner.py +219 -0
- package/templates/skills/optional/vulnerability-scanner/SKILL.md +276 -0
- package/templates/skills/optional/vulnerability-scanner/checklists.md +121 -0
- package/templates/skills/optional/vulnerability-scanner/scripts/security_scan.py +458 -0
- package/templates/skills/optional/web-design-guidelines/SKILL.md +57 -0
- package/templates/skills/optional/webapp-testing/SKILL.md +187 -0
- package/templates/skills/optional/webapp-testing/scripts/playwright_runner.py +173 -0
- package/templates/workflows/brainstorm.md +113 -0
- package/templates/workflows/create.md +59 -0
- package/templates/workflows/debug.md +103 -0
- package/templates/workflows/deploy.md +176 -0
- package/templates/workflows/enhance.md +63 -0
- package/templates/workflows/orchestrate.md +237 -0
- package/templates/workflows/plan.md +89 -0
- package/templates/workflows/preview.md +81 -0
- package/templates/workflows/status.md +86 -0
- package/templates/workflows/test.md +144 -0
- package/templates/workflows/ui-ux-pro-max.md +296 -0
|
@@ -0,0 +1,252 @@
|
|
|
1
|
+
#!/usr/bin/env python3
|
|
2
|
+
"""
|
|
3
|
+
React Performance Checker
|
|
4
|
+
Automated performance audit for React/Next.js projects
|
|
5
|
+
Based on Vercel Engineering best practices
|
|
6
|
+
"""
|
|
7
|
+
|
|
8
|
+
import os
|
|
9
|
+
import re
|
|
10
|
+
import json
|
|
11
|
+
from pathlib import Path
|
|
12
|
+
from typing import List, Dict, Tuple
|
|
13
|
+
|
|
14
|
+
class PerformanceChecker:
|
|
15
|
+
def __init__(self, project_path: str):
|
|
16
|
+
self.project_path = Path(project_path)
|
|
17
|
+
self.issues = []
|
|
18
|
+
self.warnings = []
|
|
19
|
+
self.passed = []
|
|
20
|
+
|
|
21
|
+
def check_waterfalls(self):
|
|
22
|
+
"""Check for sequential await patterns (Section 1)"""
|
|
23
|
+
print("\n[*] Checking for waterfalls (sequential awaits)...")
|
|
24
|
+
|
|
25
|
+
for filepath in self.project_path.rglob('*.{ts,tsx,js,jsx}'):
|
|
26
|
+
if 'node_modules' in str(filepath):
|
|
27
|
+
continue
|
|
28
|
+
|
|
29
|
+
try:
|
|
30
|
+
content = filepath.read_text(encoding='utf-8')
|
|
31
|
+
|
|
32
|
+
# Pattern: multiple awaits in sequence without Promise.all
|
|
33
|
+
sequential_awaits = re.findall(r'await\s+\w+.*?\n\s*await\s+\w+', content)
|
|
34
|
+
|
|
35
|
+
if sequential_awaits:
|
|
36
|
+
self.issues.append({
|
|
37
|
+
'file': str(filepath.relative_to(self.project_path)),
|
|
38
|
+
'type': 'CRITICAL',
|
|
39
|
+
'issue': 'Sequential awaits detected (waterfall)',
|
|
40
|
+
'fix': 'Use Promise.all() for parallel fetching',
|
|
41
|
+
'section': '1-async-eliminating-waterfalls.md'
|
|
42
|
+
})
|
|
43
|
+
except Exception as e:
|
|
44
|
+
continue
|
|
45
|
+
|
|
46
|
+
def check_barrel_imports(self):
|
|
47
|
+
"""Check for barrel imports (Section 2)"""
|
|
48
|
+
print("[*] Checking for barrel imports...")
|
|
49
|
+
|
|
50
|
+
for filepath in self.project_path.rglob('*.{ts,tsx,js,jsx}'):
|
|
51
|
+
if 'node_modules' in str(filepath):
|
|
52
|
+
continue
|
|
53
|
+
|
|
54
|
+
try:
|
|
55
|
+
content = filepath.read_text(encoding='utf-8')
|
|
56
|
+
|
|
57
|
+
# Pattern: import from index files or barrel exports
|
|
58
|
+
barrel_imports = re.findall(r"import.*from\s+['\"](@/.*?)/index['\"]", content)
|
|
59
|
+
barrel_imports += re.findall(r"import.*from\s+['\"]\.\.?/.*?['\"](?!.*?\.tsx?)", content)
|
|
60
|
+
|
|
61
|
+
if barrel_imports:
|
|
62
|
+
self.warnings.append({
|
|
63
|
+
'file': str(filepath.relative_to(self.project_path)),
|
|
64
|
+
'type': 'CRITICAL',
|
|
65
|
+
'issue': 'Potential barrel imports detected',
|
|
66
|
+
'fix': 'Import directly from specific files',
|
|
67
|
+
'section': '2-bundle-bundle-size-optimization.md'
|
|
68
|
+
})
|
|
69
|
+
except Exception as e:
|
|
70
|
+
continue
|
|
71
|
+
|
|
72
|
+
def check_dynamic_imports(self):
|
|
73
|
+
"""Check if large components use dynamic imports (Section 2)"""
|
|
74
|
+
print("[*] Checking for missing dynamic imports...")
|
|
75
|
+
|
|
76
|
+
for filepath in self.project_path.rglob('*.{ts,tsx}'):
|
|
77
|
+
if 'node_modules' in str(filepath):
|
|
78
|
+
continue
|
|
79
|
+
|
|
80
|
+
try:
|
|
81
|
+
content = filepath.read_text(encoding='utf-8')
|
|
82
|
+
|
|
83
|
+
# Check file size - if > 10KB, should probably use dynamic import
|
|
84
|
+
if len(content) > 10000:
|
|
85
|
+
# Check if it's imported statically somewhere
|
|
86
|
+
filename = filepath.stem
|
|
87
|
+
|
|
88
|
+
# Search for static imports of this component
|
|
89
|
+
for check_file in self.project_path.rglob('*.{ts,tsx}'):
|
|
90
|
+
if check_file == filepath or 'node_modules' in str(check_file):
|
|
91
|
+
continue
|
|
92
|
+
|
|
93
|
+
check_content = check_file.read_text(encoding='utf-8')
|
|
94
|
+
if f"import {filename}" in check_content or f"import {{ {filename}" in check_content:
|
|
95
|
+
if 'dynamic(' not in check_content:
|
|
96
|
+
self.warnings.append({
|
|
97
|
+
'file': str(check_file.relative_to(self.project_path)),
|
|
98
|
+
'type': 'CRITICAL',
|
|
99
|
+
'issue': f'Large component {filename} imported statically',
|
|
100
|
+
'fix': 'Use dynamic() for code splitting',
|
|
101
|
+
'section': '2-bundle-bundle-size-optimization.md'
|
|
102
|
+
})
|
|
103
|
+
break
|
|
104
|
+
except Exception as e:
|
|
105
|
+
continue
|
|
106
|
+
|
|
107
|
+
def check_useEffect_fetching(self):
|
|
108
|
+
"""Check for data fetching in useEffect (Section 4)"""
|
|
109
|
+
print("[*] Checking for useEffect data fetching...")
|
|
110
|
+
|
|
111
|
+
for filepath in self.project_path.rglob('*.{ts,tsx}'):
|
|
112
|
+
if 'node_modules' in str(filepath):
|
|
113
|
+
continue
|
|
114
|
+
|
|
115
|
+
try:
|
|
116
|
+
content = filepath.read_text(encoding='utf-8')
|
|
117
|
+
|
|
118
|
+
# Pattern: fetch or axios in useEffect
|
|
119
|
+
if 'useEffect' in content:
|
|
120
|
+
if re.search(r'useEffect.*?fetch\(', content, re.DOTALL):
|
|
121
|
+
self.warnings.append({
|
|
122
|
+
'file': str(filepath.relative_to(self.project_path)),
|
|
123
|
+
'type': 'MEDIUM-HIGH',
|
|
124
|
+
'issue': 'Data fetching in useEffect',
|
|
125
|
+
'fix': 'Consider using SWR or React Query for deduplication',
|
|
126
|
+
'section': '4-client-client-side-data-fetching.md'
|
|
127
|
+
})
|
|
128
|
+
except Exception as e:
|
|
129
|
+
continue
|
|
130
|
+
|
|
131
|
+
def check_missing_memoization(self):
|
|
132
|
+
"""Check for missing React.memo, useMemo, useCallback (Section 5)"""
|
|
133
|
+
print("[*] Checking for missing memoization...")
|
|
134
|
+
|
|
135
|
+
for filepath in self.project_path.rglob('*.{tsx}'):
|
|
136
|
+
if 'node_modules' in str(filepath):
|
|
137
|
+
continue
|
|
138
|
+
|
|
139
|
+
try:
|
|
140
|
+
content = filepath.read_text(encoding='utf-8')
|
|
141
|
+
|
|
142
|
+
# Check for component definitions without memo
|
|
143
|
+
components = re.findall(r'(?:export\s+)?(?:const|function)\s+([A-Z]\w+)', content)
|
|
144
|
+
|
|
145
|
+
if components and 'React.memo' not in content and 'memo(' not in content:
|
|
146
|
+
# Check if component receives props
|
|
147
|
+
if 'props:' in content or 'Props>' in content:
|
|
148
|
+
self.warnings.append({
|
|
149
|
+
'file': str(filepath.relative_to(self.project_path)),
|
|
150
|
+
'type': 'MEDIUM',
|
|
151
|
+
'issue': 'Component with props not memoized',
|
|
152
|
+
'fix': 'Consider using React.memo if props are stable',
|
|
153
|
+
'section': '5-rerender-re-render-optimization.md'
|
|
154
|
+
})
|
|
155
|
+
except Exception as e:
|
|
156
|
+
continue
|
|
157
|
+
|
|
158
|
+
def check_image_optimization(self):
|
|
159
|
+
"""Check for unoptimized images (Section 6)"""
|
|
160
|
+
print("[*] Checking for image optimization...")
|
|
161
|
+
|
|
162
|
+
for filepath in self.project_path.rglob('*.{ts,tsx,js,jsx}'):
|
|
163
|
+
if 'node_modules' in str(filepath):
|
|
164
|
+
continue
|
|
165
|
+
|
|
166
|
+
try:
|
|
167
|
+
content = filepath.read_text(encoding='utf-8')
|
|
168
|
+
|
|
169
|
+
# Check for <img> tags instead of next/image
|
|
170
|
+
if '<img' in content and 'next/image' not in content:
|
|
171
|
+
self.warnings.append({
|
|
172
|
+
'file': str(filepath.relative_to(self.project_path)),
|
|
173
|
+
'type': 'MEDIUM',
|
|
174
|
+
'issue': 'Using <img> instead of next/image',
|
|
175
|
+
'fix': 'Use next/image for automatic optimization',
|
|
176
|
+
'section': '6-rendering-rendering-performance.md'
|
|
177
|
+
})
|
|
178
|
+
except Exception as e:
|
|
179
|
+
continue
|
|
180
|
+
|
|
181
|
+
def generate_report(self):
|
|
182
|
+
"""Generate final report"""
|
|
183
|
+
print("\n" + "="*60)
|
|
184
|
+
print("REACT PERFORMANCE AUDIT REPORT")
|
|
185
|
+
print("="*60)
|
|
186
|
+
|
|
187
|
+
print(f"\n[CRITICAL ISSUES] ({len([i for i in self.issues if i['type'] == 'CRITICAL'])})")
|
|
188
|
+
for issue in self.issues:
|
|
189
|
+
if issue['type'] == 'CRITICAL':
|
|
190
|
+
print(f" - {issue['file']}")
|
|
191
|
+
print(f" Issue: {issue['issue']}")
|
|
192
|
+
print(f" Fix: {issue['fix']}")
|
|
193
|
+
print(f" Reference: {issue['section']}\n")
|
|
194
|
+
|
|
195
|
+
print(f"\n[WARNINGS] ({len(self.warnings)})")
|
|
196
|
+
for warning in self.warnings[:10]: # Show first 10
|
|
197
|
+
print(f" - {warning['file']}")
|
|
198
|
+
print(f" Issue: {warning['issue']}")
|
|
199
|
+
print(f" Fix: {warning['fix']}")
|
|
200
|
+
print(f" Reference: {warning['section']}\n")
|
|
201
|
+
|
|
202
|
+
if len(self.warnings) > 10:
|
|
203
|
+
print(f" ... and {len(self.warnings) - 10} more warnings")
|
|
204
|
+
|
|
205
|
+
print("\n" + "="*60)
|
|
206
|
+
print(f"SUMMARY:")
|
|
207
|
+
print(f" Critical Issues: {len([i for i in self.issues if i['type'] == 'CRITICAL'])}")
|
|
208
|
+
print(f" Warnings: {len(self.warnings)}")
|
|
209
|
+
print("="*60)
|
|
210
|
+
|
|
211
|
+
if len(self.issues) == 0 and len(self.warnings) == 0:
|
|
212
|
+
print("\n[SUCCESS] No major performance issues detected!")
|
|
213
|
+
else:
|
|
214
|
+
print("\n[ACTION REQUIRED] Review and fix issues above")
|
|
215
|
+
print("Priority: CRITICAL > HIGH > MEDIUM > LOW")
|
|
216
|
+
|
|
217
|
+
def run(self):
|
|
218
|
+
"""Run all checks"""
|
|
219
|
+
print("="*60)
|
|
220
|
+
print("React Performance Checker (Vercel Engineering)")
|
|
221
|
+
print("="*60)
|
|
222
|
+
print(f"Scanning: {self.project_path}")
|
|
223
|
+
|
|
224
|
+
self.check_waterfalls()
|
|
225
|
+
self.check_barrel_imports()
|
|
226
|
+
self.check_dynamic_imports()
|
|
227
|
+
self.check_useEffect_fetching()
|
|
228
|
+
self.check_missing_memoization()
|
|
229
|
+
self.check_image_optimization()
|
|
230
|
+
|
|
231
|
+
self.generate_report()
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
def main():
|
|
235
|
+
import sys
|
|
236
|
+
|
|
237
|
+
if len(sys.argv) < 2:
|
|
238
|
+
print("Usage: python react_performance_checker.py <project_path>")
|
|
239
|
+
sys.exit(1)
|
|
240
|
+
|
|
241
|
+
project_path = sys.argv[1]
|
|
242
|
+
|
|
243
|
+
if not os.path.exists(project_path):
|
|
244
|
+
print(f"[ERROR] Path not found: {project_path}")
|
|
245
|
+
sys.exit(1)
|
|
246
|
+
|
|
247
|
+
checker = PerformanceChecker(project_path)
|
|
248
|
+
checker.run()
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
if __name__ == '__main__':
|
|
252
|
+
main()
|
|
@@ -0,0 +1,333 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: nodejs-best-practices
|
|
3
|
+
description: Node.js development principles and decision-making. Framework selection, async patterns, security, and architecture. Teaches thinking, not copying.
|
|
4
|
+
allowed-tools: Read, Write, Edit, Glob, Grep
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Node.js Best Practices
|
|
8
|
+
|
|
9
|
+
> Principles and decision-making for Node.js development in 2025.
|
|
10
|
+
> **Learn to THINK, not memorize code patterns.**
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## ⚠️ How to Use This Skill
|
|
15
|
+
|
|
16
|
+
This skill teaches **decision-making principles**, not fixed code to copy.
|
|
17
|
+
|
|
18
|
+
- ASK user for preferences when unclear
|
|
19
|
+
- Choose framework/pattern based on CONTEXT
|
|
20
|
+
- Don't default to same solution every time
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## 1. Framework Selection (2025)
|
|
25
|
+
|
|
26
|
+
### Decision Tree
|
|
27
|
+
|
|
28
|
+
```
|
|
29
|
+
What are you building?
|
|
30
|
+
│
|
|
31
|
+
├── Edge/Serverless (Cloudflare, Vercel)
|
|
32
|
+
│ └── Hono (zero-dependency, ultra-fast cold starts)
|
|
33
|
+
│
|
|
34
|
+
├── High Performance API
|
|
35
|
+
│ └── Fastify (2-3x faster than Express)
|
|
36
|
+
│
|
|
37
|
+
├── Enterprise/Team familiarity
|
|
38
|
+
│ └── NestJS (structured, DI, decorators)
|
|
39
|
+
│
|
|
40
|
+
├── Legacy/Stable/Maximum ecosystem
|
|
41
|
+
│ └── Express (mature, most middleware)
|
|
42
|
+
│
|
|
43
|
+
└── Full-stack with frontend
|
|
44
|
+
└── Next.js API Routes or tRPC
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### Comparison Principles
|
|
48
|
+
|
|
49
|
+
| Factor | Hono | Fastify | Express |
|
|
50
|
+
|--------|------|---------|---------|
|
|
51
|
+
| **Best for** | Edge, serverless | Performance | Legacy, learning |
|
|
52
|
+
| **Cold start** | Fastest | Fast | Moderate |
|
|
53
|
+
| **Ecosystem** | Growing | Good | Largest |
|
|
54
|
+
| **TypeScript** | Native | Excellent | Good |
|
|
55
|
+
| **Learning curve** | Low | Medium | Low |
|
|
56
|
+
|
|
57
|
+
### Selection Questions to Ask:
|
|
58
|
+
1. What's the deployment target?
|
|
59
|
+
2. Is cold start time critical?
|
|
60
|
+
3. Does team have existing experience?
|
|
61
|
+
4. Is there legacy code to maintain?
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
65
|
+
## 2. Runtime Considerations (2025)
|
|
66
|
+
|
|
67
|
+
### Native TypeScript
|
|
68
|
+
|
|
69
|
+
```
|
|
70
|
+
Node.js 22+: --experimental-strip-types
|
|
71
|
+
├── Run .ts files directly
|
|
72
|
+
├── No build step needed for simple projects
|
|
73
|
+
└── Consider for: scripts, simple APIs
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
### Module System Decision
|
|
77
|
+
|
|
78
|
+
```
|
|
79
|
+
ESM (import/export)
|
|
80
|
+
├── Modern standard
|
|
81
|
+
├── Better tree-shaking
|
|
82
|
+
├── Async module loading
|
|
83
|
+
└── Use for: new projects
|
|
84
|
+
|
|
85
|
+
CommonJS (require)
|
|
86
|
+
├── Legacy compatibility
|
|
87
|
+
├── More npm packages support
|
|
88
|
+
└── Use for: existing codebases, some edge cases
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
### Runtime Selection
|
|
92
|
+
|
|
93
|
+
| Runtime | Best For |
|
|
94
|
+
|---------|----------|
|
|
95
|
+
| **Node.js** | General purpose, largest ecosystem |
|
|
96
|
+
| **Bun** | Performance, built-in bundler |
|
|
97
|
+
| **Deno** | Security-first, built-in TypeScript |
|
|
98
|
+
|
|
99
|
+
---
|
|
100
|
+
|
|
101
|
+
## 3. Architecture Principles
|
|
102
|
+
|
|
103
|
+
### Layered Structure Concept
|
|
104
|
+
|
|
105
|
+
```
|
|
106
|
+
Request Flow:
|
|
107
|
+
│
|
|
108
|
+
├── Controller/Route Layer
|
|
109
|
+
│ ├── Handles HTTP specifics
|
|
110
|
+
│ ├── Input validation at boundary
|
|
111
|
+
│ └── Calls service layer
|
|
112
|
+
│
|
|
113
|
+
├── Service Layer
|
|
114
|
+
│ ├── Business logic
|
|
115
|
+
│ ├── Framework-agnostic
|
|
116
|
+
│ └── Calls repository layer
|
|
117
|
+
│
|
|
118
|
+
└── Repository Layer
|
|
119
|
+
├── Data access only
|
|
120
|
+
├── Database queries
|
|
121
|
+
└── ORM interactions
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
### Why This Matters:
|
|
125
|
+
- **Testability**: Mock layers independently
|
|
126
|
+
- **Flexibility**: Swap database without touching business logic
|
|
127
|
+
- **Clarity**: Each layer has single responsibility
|
|
128
|
+
|
|
129
|
+
### When to Simplify:
|
|
130
|
+
- Small scripts → Single file OK
|
|
131
|
+
- Prototypes → Less structure acceptable
|
|
132
|
+
- Always ask: "Will this grow?"
|
|
133
|
+
|
|
134
|
+
---
|
|
135
|
+
|
|
136
|
+
## 4. Error Handling Principles
|
|
137
|
+
|
|
138
|
+
### Centralized Error Handling
|
|
139
|
+
|
|
140
|
+
```
|
|
141
|
+
Pattern:
|
|
142
|
+
├── Create custom error classes
|
|
143
|
+
├── Throw from any layer
|
|
144
|
+
├── Catch at top level (middleware)
|
|
145
|
+
└── Format consistent response
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
### Error Response Philosophy
|
|
149
|
+
|
|
150
|
+
```
|
|
151
|
+
Client gets:
|
|
152
|
+
├── Appropriate HTTP status
|
|
153
|
+
├── Error code for programmatic handling
|
|
154
|
+
├── User-friendly message
|
|
155
|
+
└── NO internal details (security!)
|
|
156
|
+
|
|
157
|
+
Logs get:
|
|
158
|
+
├── Full stack trace
|
|
159
|
+
├── Request context
|
|
160
|
+
├── User ID (if applicable)
|
|
161
|
+
└── Timestamp
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
### Status Code Selection
|
|
165
|
+
|
|
166
|
+
| Situation | Status | When |
|
|
167
|
+
|-----------|--------|------|
|
|
168
|
+
| Bad input | 400 | Client sent invalid data |
|
|
169
|
+
| No auth | 401 | Missing or invalid credentials |
|
|
170
|
+
| No permission | 403 | Valid auth, but not allowed |
|
|
171
|
+
| Not found | 404 | Resource doesn't exist |
|
|
172
|
+
| Conflict | 409 | Duplicate or state conflict |
|
|
173
|
+
| Validation | 422 | Schema valid but business rules fail |
|
|
174
|
+
| Server error | 500 | Our fault, log everything |
|
|
175
|
+
|
|
176
|
+
---
|
|
177
|
+
|
|
178
|
+
## 5. Async Patterns Principles
|
|
179
|
+
|
|
180
|
+
### When to Use Each
|
|
181
|
+
|
|
182
|
+
| Pattern | Use When |
|
|
183
|
+
|---------|----------|
|
|
184
|
+
| `async/await` | Sequential async operations |
|
|
185
|
+
| `Promise.all` | Parallel independent operations |
|
|
186
|
+
| `Promise.allSettled` | Parallel where some can fail |
|
|
187
|
+
| `Promise.race` | Timeout or first response wins |
|
|
188
|
+
|
|
189
|
+
### Event Loop Awareness
|
|
190
|
+
|
|
191
|
+
```
|
|
192
|
+
I/O-bound (async helps):
|
|
193
|
+
├── Database queries
|
|
194
|
+
├── HTTP requests
|
|
195
|
+
├── File system
|
|
196
|
+
└── Network operations
|
|
197
|
+
|
|
198
|
+
CPU-bound (async doesn't help):
|
|
199
|
+
├── Crypto operations
|
|
200
|
+
├── Image processing
|
|
201
|
+
├── Complex calculations
|
|
202
|
+
└── → Use worker threads or offload
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
### Avoiding Event Loop Blocking
|
|
206
|
+
|
|
207
|
+
- Never use sync methods in production (fs.readFileSync, etc.)
|
|
208
|
+
- Offload CPU-intensive work
|
|
209
|
+
- Use streaming for large data
|
|
210
|
+
|
|
211
|
+
---
|
|
212
|
+
|
|
213
|
+
## 6. Validation Principles
|
|
214
|
+
|
|
215
|
+
### Validate at Boundaries
|
|
216
|
+
|
|
217
|
+
```
|
|
218
|
+
Where to validate:
|
|
219
|
+
├── API entry point (request body/params)
|
|
220
|
+
├── Before database operations
|
|
221
|
+
├── External data (API responses, file uploads)
|
|
222
|
+
└── Environment variables (startup)
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
### Validation Library Selection
|
|
226
|
+
|
|
227
|
+
| Library | Best For |
|
|
228
|
+
|---------|----------|
|
|
229
|
+
| **Zod** | TypeScript first, inference |
|
|
230
|
+
| **Valibot** | Smaller bundle (tree-shakeable) |
|
|
231
|
+
| **ArkType** | Performance critical |
|
|
232
|
+
| **Yup** | Existing React Form usage |
|
|
233
|
+
|
|
234
|
+
### Validation Philosophy
|
|
235
|
+
|
|
236
|
+
- Fail fast: Validate early
|
|
237
|
+
- Be specific: Clear error messages
|
|
238
|
+
- Don't trust: Even "internal" data
|
|
239
|
+
|
|
240
|
+
---
|
|
241
|
+
|
|
242
|
+
## 7. Security Principles
|
|
243
|
+
|
|
244
|
+
### Security Checklist (Not Code)
|
|
245
|
+
|
|
246
|
+
- [ ] **Input validation**: All inputs validated
|
|
247
|
+
- [ ] **Parameterized queries**: No string concatenation for SQL
|
|
248
|
+
- [ ] **Password hashing**: bcrypt or argon2
|
|
249
|
+
- [ ] **JWT verification**: Always verify signature and expiry
|
|
250
|
+
- [ ] **Rate limiting**: Protect from abuse
|
|
251
|
+
- [ ] **Security headers**: Helmet.js or equivalent
|
|
252
|
+
- [ ] **HTTPS**: Everywhere in production
|
|
253
|
+
- [ ] **CORS**: Properly configured
|
|
254
|
+
- [ ] **Secrets**: Environment variables only
|
|
255
|
+
- [ ] **Dependencies**: Regularly audited
|
|
256
|
+
|
|
257
|
+
### Security Mindset
|
|
258
|
+
|
|
259
|
+
```
|
|
260
|
+
Trust nothing:
|
|
261
|
+
├── Query params → validate
|
|
262
|
+
├── Request body → validate
|
|
263
|
+
├── Headers → verify
|
|
264
|
+
├── Cookies → validate
|
|
265
|
+
├── File uploads → scan
|
|
266
|
+
└── External APIs → validate response
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
---
|
|
270
|
+
|
|
271
|
+
## 8. Testing Principles
|
|
272
|
+
|
|
273
|
+
### Test Strategy Selection
|
|
274
|
+
|
|
275
|
+
| Type | Purpose | Tools |
|
|
276
|
+
|------|---------|-------|
|
|
277
|
+
| **Unit** | Business logic | node:test, Vitest |
|
|
278
|
+
| **Integration** | API endpoints | Supertest |
|
|
279
|
+
| **E2E** | Full flows | Playwright |
|
|
280
|
+
|
|
281
|
+
### What to Test (Priorities)
|
|
282
|
+
|
|
283
|
+
1. **Critical paths**: Auth, payments, core business
|
|
284
|
+
2. **Edge cases**: Empty inputs, boundaries
|
|
285
|
+
3. **Error handling**: What happens when things fail?
|
|
286
|
+
4. **Not worth testing**: Framework code, trivial getters
|
|
287
|
+
|
|
288
|
+
### Built-in Test Runner (Node.js 22+)
|
|
289
|
+
|
|
290
|
+
```
|
|
291
|
+
node --test src/**/*.test.ts
|
|
292
|
+
├── No external dependency
|
|
293
|
+
├── Good coverage reporting
|
|
294
|
+
└── Watch mode available
|
|
295
|
+
```
|
|
296
|
+
|
|
297
|
+
---
|
|
298
|
+
|
|
299
|
+
## 10. Anti-Patterns to Avoid
|
|
300
|
+
|
|
301
|
+
### ❌ DON'T:
|
|
302
|
+
- Use Express for new edge projects (use Hono)
|
|
303
|
+
- Use sync methods in production code
|
|
304
|
+
- Put business logic in controllers
|
|
305
|
+
- Skip input validation
|
|
306
|
+
- Hardcode secrets
|
|
307
|
+
- Trust external data without validation
|
|
308
|
+
- Block event loop with CPU work
|
|
309
|
+
|
|
310
|
+
### ✅ DO:
|
|
311
|
+
- Choose framework based on context
|
|
312
|
+
- Ask user for preferences when unclear
|
|
313
|
+
- Use layered architecture for growing projects
|
|
314
|
+
- Validate all inputs
|
|
315
|
+
- Use environment variables for secrets
|
|
316
|
+
- Profile before optimizing
|
|
317
|
+
|
|
318
|
+
---
|
|
319
|
+
|
|
320
|
+
## 11. Decision Checklist
|
|
321
|
+
|
|
322
|
+
Before implementing:
|
|
323
|
+
|
|
324
|
+
- [ ] **Asked user about stack preference?**
|
|
325
|
+
- [ ] **Chosen framework for THIS context?** (not just default)
|
|
326
|
+
- [ ] **Considered deployment target?**
|
|
327
|
+
- [ ] **Planned error handling strategy?**
|
|
328
|
+
- [ ] **Identified validation points?**
|
|
329
|
+
- [ ] **Considered security requirements?**
|
|
330
|
+
|
|
331
|
+
---
|
|
332
|
+
|
|
333
|
+
> **Remember**: Node.js best practices are about decision-making, not memorizing patterns. Every project deserves fresh consideration based on its requirements.
|