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,312 @@
|
|
|
1
|
+
# 1. Eliminating Waterfalls
|
|
2
|
+
|
|
3
|
+
> **Impact:** CRITICAL
|
|
4
|
+
> **Focus:** Waterfalls are the #1 performance killer. Each sequential await adds full network latency. Eliminating them yields the largest gains.
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Overview
|
|
9
|
+
|
|
10
|
+
This section contains **5 rules** focused on eliminating waterfalls.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Rule 1.1: Defer Await Until Needed
|
|
15
|
+
|
|
16
|
+
**Impact:** HIGH
|
|
17
|
+
**Tags:** async, await, conditional, optimization
|
|
18
|
+
|
|
19
|
+
## Defer Await Until Needed
|
|
20
|
+
|
|
21
|
+
Move `await` operations into the branches where they're actually used to avoid blocking code paths that don't need them.
|
|
22
|
+
|
|
23
|
+
**Incorrect (blocks both branches):**
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
async function handleRequest(userId: string, skipProcessing: boolean) {
|
|
27
|
+
const userData = await fetchUserData(userId)
|
|
28
|
+
|
|
29
|
+
if (skipProcessing) {
|
|
30
|
+
// Returns immediately but still waited for userData
|
|
31
|
+
return { skipped: true }
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
// Only this branch uses userData
|
|
35
|
+
return processUserData(userData)
|
|
36
|
+
}
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
**Correct (only blocks when needed):**
|
|
40
|
+
|
|
41
|
+
```typescript
|
|
42
|
+
async function handleRequest(userId: string, skipProcessing: boolean) {
|
|
43
|
+
if (skipProcessing) {
|
|
44
|
+
// Returns immediately without waiting
|
|
45
|
+
return { skipped: true }
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
// Fetch only when needed
|
|
49
|
+
const userData = await fetchUserData(userId)
|
|
50
|
+
return processUserData(userData)
|
|
51
|
+
}
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
**Another example (early return optimization):**
|
|
55
|
+
|
|
56
|
+
```typescript
|
|
57
|
+
// Incorrect: always fetches permissions
|
|
58
|
+
async function updateResource(resourceId: string, userId: string) {
|
|
59
|
+
const permissions = await fetchPermissions(userId)
|
|
60
|
+
const resource = await getResource(resourceId)
|
|
61
|
+
|
|
62
|
+
if (!resource) {
|
|
63
|
+
return { error: 'Not found' }
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
if (!permissions.canEdit) {
|
|
67
|
+
return { error: 'Forbidden' }
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
return await updateResourceData(resource, permissions)
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
// Correct: fetches only when needed
|
|
74
|
+
async function updateResource(resourceId: string, userId: string) {
|
|
75
|
+
const resource = await getResource(resourceId)
|
|
76
|
+
|
|
77
|
+
if (!resource) {
|
|
78
|
+
return { error: 'Not found' }
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
const permissions = await fetchPermissions(userId)
|
|
82
|
+
|
|
83
|
+
if (!permissions.canEdit) {
|
|
84
|
+
return { error: 'Forbidden' }
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
return await updateResourceData(resource, permissions)
|
|
88
|
+
}
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
This optimization is especially valuable when the skipped branch is frequently taken, or when the deferred operation is expensive.
|
|
92
|
+
|
|
93
|
+
---
|
|
94
|
+
|
|
95
|
+
## Rule 1.2: Dependency-Based Parallelization
|
|
96
|
+
|
|
97
|
+
**Impact:** CRITICAL
|
|
98
|
+
**Tags:** async, parallelization, dependencies, better-all
|
|
99
|
+
|
|
100
|
+
## Dependency-Based Parallelization
|
|
101
|
+
|
|
102
|
+
For operations with partial dependencies, use `better-all` to maximize parallelism. It automatically starts each task at the earliest possible moment.
|
|
103
|
+
|
|
104
|
+
**Incorrect (profile waits for config unnecessarily):**
|
|
105
|
+
|
|
106
|
+
```typescript
|
|
107
|
+
const [user, config] = await Promise.all([
|
|
108
|
+
fetchUser(),
|
|
109
|
+
fetchConfig()
|
|
110
|
+
])
|
|
111
|
+
const profile = await fetchProfile(user.id)
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
**Correct (config and profile run in parallel):**
|
|
115
|
+
|
|
116
|
+
```typescript
|
|
117
|
+
import { all } from 'better-all'
|
|
118
|
+
|
|
119
|
+
const { user, config, profile } = await all({
|
|
120
|
+
async user() { return fetchUser() },
|
|
121
|
+
async config() { return fetchConfig() },
|
|
122
|
+
async profile() {
|
|
123
|
+
return fetchProfile((await this.$.user).id)
|
|
124
|
+
}
|
|
125
|
+
})
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
**Alternative without extra dependencies:**
|
|
129
|
+
|
|
130
|
+
We can also create all the promises first, and do `Promise.all()` at the end.
|
|
131
|
+
|
|
132
|
+
```typescript
|
|
133
|
+
const userPromise = fetchUser()
|
|
134
|
+
const profilePromise = userPromise.then(user => fetchProfile(user.id))
|
|
135
|
+
|
|
136
|
+
const [user, config, profile] = await Promise.all([
|
|
137
|
+
userPromise,
|
|
138
|
+
fetchConfig(),
|
|
139
|
+
profilePromise
|
|
140
|
+
])
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
Reference: [https://github.com/shuding/better-all](https://github.com/shuding/better-all)
|
|
144
|
+
|
|
145
|
+
---
|
|
146
|
+
|
|
147
|
+
## Rule 1.3: Prevent Waterfall Chains in API Routes
|
|
148
|
+
|
|
149
|
+
**Impact:** CRITICAL
|
|
150
|
+
**Tags:** api-routes, server-actions, waterfalls, parallelization
|
|
151
|
+
|
|
152
|
+
## Prevent Waterfall Chains in API Routes
|
|
153
|
+
|
|
154
|
+
In API routes and Server Actions, start independent operations immediately, even if you don't await them yet.
|
|
155
|
+
|
|
156
|
+
**Incorrect (config waits for auth, data waits for both):**
|
|
157
|
+
|
|
158
|
+
```typescript
|
|
159
|
+
export async function GET(request: Request) {
|
|
160
|
+
const session = await auth()
|
|
161
|
+
const config = await fetchConfig()
|
|
162
|
+
const data = await fetchData(session.user.id)
|
|
163
|
+
return Response.json({ data, config })
|
|
164
|
+
}
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
**Correct (auth and config start immediately):**
|
|
168
|
+
|
|
169
|
+
```typescript
|
|
170
|
+
export async function GET(request: Request) {
|
|
171
|
+
const sessionPromise = auth()
|
|
172
|
+
const configPromise = fetchConfig()
|
|
173
|
+
const session = await sessionPromise
|
|
174
|
+
const [config, data] = await Promise.all([
|
|
175
|
+
configPromise,
|
|
176
|
+
fetchData(session.user.id)
|
|
177
|
+
])
|
|
178
|
+
return Response.json({ data, config })
|
|
179
|
+
}
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
For operations with more complex dependency chains, use `better-all` to automatically maximize parallelism (see Dependency-Based Parallelization).
|
|
183
|
+
|
|
184
|
+
---
|
|
185
|
+
|
|
186
|
+
## Rule 1.4: Promise.all() for Independent Operations
|
|
187
|
+
|
|
188
|
+
**Impact:** CRITICAL
|
|
189
|
+
**Tags:** async, parallelization, promises, waterfalls
|
|
190
|
+
|
|
191
|
+
## Promise.all() for Independent Operations
|
|
192
|
+
|
|
193
|
+
When async operations have no interdependencies, execute them concurrently using `Promise.all()`.
|
|
194
|
+
|
|
195
|
+
**Incorrect (sequential execution, 3 round trips):**
|
|
196
|
+
|
|
197
|
+
```typescript
|
|
198
|
+
const user = await fetchUser()
|
|
199
|
+
const posts = await fetchPosts()
|
|
200
|
+
const comments = await fetchComments()
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
**Correct (parallel execution, 1 round trip):**
|
|
204
|
+
|
|
205
|
+
```typescript
|
|
206
|
+
const [user, posts, comments] = await Promise.all([
|
|
207
|
+
fetchUser(),
|
|
208
|
+
fetchPosts(),
|
|
209
|
+
fetchComments()
|
|
210
|
+
])
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
---
|
|
214
|
+
|
|
215
|
+
## Rule 1.5: Strategic Suspense Boundaries
|
|
216
|
+
|
|
217
|
+
**Impact:** HIGH
|
|
218
|
+
**Tags:** async, suspense, streaming, layout-shift
|
|
219
|
+
|
|
220
|
+
## Strategic Suspense Boundaries
|
|
221
|
+
|
|
222
|
+
Instead of awaiting data in async components before returning JSX, use Suspense boundaries to show the wrapper UI faster while data loads.
|
|
223
|
+
|
|
224
|
+
**Incorrect (wrapper blocked by data fetching):**
|
|
225
|
+
|
|
226
|
+
```tsx
|
|
227
|
+
async function Page() {
|
|
228
|
+
const data = await fetchData() // Blocks entire page
|
|
229
|
+
|
|
230
|
+
return (
|
|
231
|
+
<div>
|
|
232
|
+
<div>Sidebar</div>
|
|
233
|
+
<div>Header</div>
|
|
234
|
+
<div>
|
|
235
|
+
<DataDisplay data={data} />
|
|
236
|
+
</div>
|
|
237
|
+
<div>Footer</div>
|
|
238
|
+
</div>
|
|
239
|
+
)
|
|
240
|
+
}
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
The entire layout waits for data even though only the middle section needs it.
|
|
244
|
+
|
|
245
|
+
**Correct (wrapper shows immediately, data streams in):**
|
|
246
|
+
|
|
247
|
+
```tsx
|
|
248
|
+
function Page() {
|
|
249
|
+
return (
|
|
250
|
+
<div>
|
|
251
|
+
<div>Sidebar</div>
|
|
252
|
+
<div>Header</div>
|
|
253
|
+
<div>
|
|
254
|
+
<Suspense fallback={<Skeleton />}>
|
|
255
|
+
<DataDisplay />
|
|
256
|
+
</Suspense>
|
|
257
|
+
</div>
|
|
258
|
+
<div>Footer</div>
|
|
259
|
+
</div>
|
|
260
|
+
)
|
|
261
|
+
}
|
|
262
|
+
|
|
263
|
+
async function DataDisplay() {
|
|
264
|
+
const data = await fetchData() // Only blocks this component
|
|
265
|
+
return <div>{data.content}</div>
|
|
266
|
+
}
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
Sidebar, Header, and Footer render immediately. Only DataDisplay waits for data.
|
|
270
|
+
|
|
271
|
+
**Alternative (share promise across components):**
|
|
272
|
+
|
|
273
|
+
```tsx
|
|
274
|
+
function Page() {
|
|
275
|
+
// Start fetch immediately, but don't await
|
|
276
|
+
const dataPromise = fetchData()
|
|
277
|
+
|
|
278
|
+
return (
|
|
279
|
+
<div>
|
|
280
|
+
<div>Sidebar</div>
|
|
281
|
+
<div>Header</div>
|
|
282
|
+
<Suspense fallback={<Skeleton />}>
|
|
283
|
+
<DataDisplay dataPromise={dataPromise} />
|
|
284
|
+
<DataSummary dataPromise={dataPromise} />
|
|
285
|
+
</Suspense>
|
|
286
|
+
<div>Footer</div>
|
|
287
|
+
</div>
|
|
288
|
+
)
|
|
289
|
+
}
|
|
290
|
+
|
|
291
|
+
function DataDisplay({ dataPromise }: { dataPromise: Promise<Data> }) {
|
|
292
|
+
const data = use(dataPromise) // Unwraps the promise
|
|
293
|
+
return <div>{data.content}</div>
|
|
294
|
+
}
|
|
295
|
+
|
|
296
|
+
function DataSummary({ dataPromise }: { dataPromise: Promise<Data> }) {
|
|
297
|
+
const data = use(dataPromise) // Reuses the same promise
|
|
298
|
+
return <div>{data.summary}</div>
|
|
299
|
+
}
|
|
300
|
+
```
|
|
301
|
+
|
|
302
|
+
Both components share the same promise, so only one fetch occurs. Layout renders immediately while both components wait together.
|
|
303
|
+
|
|
304
|
+
**When NOT to use this pattern:**
|
|
305
|
+
|
|
306
|
+
- Critical data needed for layout decisions (affects positioning)
|
|
307
|
+
- SEO-critical content above the fold
|
|
308
|
+
- Small, fast queries where suspense overhead isn't worth it
|
|
309
|
+
- When you want to avoid layout shift (loading → content jump)
|
|
310
|
+
|
|
311
|
+
**Trade-off:** Faster initial paint vs potential layout shift. Choose based on your UX priorities.
|
|
312
|
+
|
|
@@ -0,0 +1,240 @@
|
|
|
1
|
+
# 2. Bundle Size Optimization
|
|
2
|
+
|
|
3
|
+
> **Impact:** CRITICAL
|
|
4
|
+
> **Focus:** Reducing initial bundle size improves Time to Interactive and Largest Contentful Paint.
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Overview
|
|
9
|
+
|
|
10
|
+
This section contains **5 rules** focused on bundle size optimization.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Rule 2.1: Avoid Barrel File Imports
|
|
15
|
+
|
|
16
|
+
**Impact:** CRITICAL
|
|
17
|
+
**Tags:** bundle, imports, tree-shaking, barrel-files, performance
|
|
18
|
+
|
|
19
|
+
## Avoid Barrel File Imports
|
|
20
|
+
|
|
21
|
+
Import directly from source files instead of barrel files to avoid loading thousands of unused modules. **Barrel files** are entry points that re-export multiple modules (e.g., `index.js` that does `export * from './module'`).
|
|
22
|
+
|
|
23
|
+
Popular icon and component libraries can have **up to 10,000 re-exports** in their entry file. For many React packages, **it takes 200-800ms just to import them**, affecting both development speed and production cold starts.
|
|
24
|
+
|
|
25
|
+
**Why tree-shaking doesn't help:** When a library is marked as external (not bundled), the bundler can't optimize it. If you bundle it to enable tree-shaking, builds become substantially slower analyzing the entire module graph.
|
|
26
|
+
|
|
27
|
+
**Incorrect (imports entire library):**
|
|
28
|
+
|
|
29
|
+
```tsx
|
|
30
|
+
import { Check, X, Menu } from 'lucide-react'
|
|
31
|
+
// Loads 1,583 modules, takes ~2.8s extra in dev
|
|
32
|
+
// Runtime cost: 200-800ms on every cold start
|
|
33
|
+
|
|
34
|
+
import { Button, TextField } from '@mui/material'
|
|
35
|
+
// Loads 2,225 modules, takes ~4.2s extra in dev
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
**Correct (imports only what you need):**
|
|
39
|
+
|
|
40
|
+
```tsx
|
|
41
|
+
import Check from 'lucide-react/dist/esm/icons/check'
|
|
42
|
+
import X from 'lucide-react/dist/esm/icons/x'
|
|
43
|
+
import Menu from 'lucide-react/dist/esm/icons/menu'
|
|
44
|
+
// Loads only 3 modules (~2KB vs ~1MB)
|
|
45
|
+
|
|
46
|
+
import Button from '@mui/material/Button'
|
|
47
|
+
import TextField from '@mui/material/TextField'
|
|
48
|
+
// Loads only what you use
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
**Alternative (Next.js 13.5+):**
|
|
52
|
+
|
|
53
|
+
```js
|
|
54
|
+
// next.config.js - use optimizePackageImports
|
|
55
|
+
module.exports = {
|
|
56
|
+
experimental: {
|
|
57
|
+
optimizePackageImports: ['lucide-react', '@mui/material']
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
// Then you can keep the ergonomic barrel imports:
|
|
62
|
+
import { Check, X, Menu } from 'lucide-react'
|
|
63
|
+
// Automatically transformed to direct imports at build time
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Direct imports provide 15-70% faster dev boot, 28% faster builds, 40% faster cold starts, and significantly faster HMR.
|
|
67
|
+
|
|
68
|
+
Libraries commonly affected: `lucide-react`, `@mui/material`, `@mui/icons-material`, `@tabler/icons-react`, `react-icons`, `@headlessui/react`, `@radix-ui/react-*`, `lodash`, `ramda`, `date-fns`, `rxjs`, `react-use`.
|
|
69
|
+
|
|
70
|
+
Reference: [How we optimized package imports in Next.js](https://vercel.com/blog/how-we-optimized-package-imports-in-next-js)
|
|
71
|
+
|
|
72
|
+
---
|
|
73
|
+
|
|
74
|
+
## Rule 2.2: Conditional Module Loading
|
|
75
|
+
|
|
76
|
+
**Impact:** HIGH
|
|
77
|
+
**Tags:** bundle, conditional-loading, lazy-loading
|
|
78
|
+
|
|
79
|
+
## Conditional Module Loading
|
|
80
|
+
|
|
81
|
+
Load large data or modules only when a feature is activated.
|
|
82
|
+
|
|
83
|
+
**Example (lazy-load animation frames):**
|
|
84
|
+
|
|
85
|
+
```tsx
|
|
86
|
+
function AnimationPlayer({ enabled, setEnabled }: { enabled: boolean; setEnabled: React.Dispatch<React.SetStateAction<boolean>> }) {
|
|
87
|
+
const [frames, setFrames] = useState<Frame[] | null>(null)
|
|
88
|
+
|
|
89
|
+
useEffect(() => {
|
|
90
|
+
if (enabled && !frames && typeof window !== 'undefined') {
|
|
91
|
+
import('./animation-frames.js')
|
|
92
|
+
.then(mod => setFrames(mod.frames))
|
|
93
|
+
.catch(() => setEnabled(false))
|
|
94
|
+
}
|
|
95
|
+
}, [enabled, frames, setEnabled])
|
|
96
|
+
|
|
97
|
+
if (!frames) return <Skeleton />
|
|
98
|
+
return <Canvas frames={frames} />
|
|
99
|
+
}
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
The `typeof window !== 'undefined'` check prevents bundling this module for SSR, optimizing server bundle size and build speed.
|
|
103
|
+
|
|
104
|
+
---
|
|
105
|
+
|
|
106
|
+
## Rule 2.3: Defer Non-Critical Third-Party Libraries
|
|
107
|
+
|
|
108
|
+
**Impact:** MEDIUM
|
|
109
|
+
**Tags:** bundle, third-party, analytics, defer
|
|
110
|
+
|
|
111
|
+
## Defer Non-Critical Third-Party Libraries
|
|
112
|
+
|
|
113
|
+
Analytics, logging, and error tracking don't block user interaction. Load them after hydration.
|
|
114
|
+
|
|
115
|
+
**Incorrect (blocks initial bundle):**
|
|
116
|
+
|
|
117
|
+
```tsx
|
|
118
|
+
import { Analytics } from '@vercel/analytics/react'
|
|
119
|
+
|
|
120
|
+
export default function RootLayout({ children }) {
|
|
121
|
+
return (
|
|
122
|
+
<html>
|
|
123
|
+
<body>
|
|
124
|
+
{children}
|
|
125
|
+
<Analytics />
|
|
126
|
+
</body>
|
|
127
|
+
</html>
|
|
128
|
+
)
|
|
129
|
+
}
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
**Correct (loads after hydration):**
|
|
133
|
+
|
|
134
|
+
```tsx
|
|
135
|
+
import dynamic from 'next/dynamic'
|
|
136
|
+
|
|
137
|
+
const Analytics = dynamic(
|
|
138
|
+
() => import('@vercel/analytics/react').then(m => m.Analytics),
|
|
139
|
+
{ ssr: false }
|
|
140
|
+
)
|
|
141
|
+
|
|
142
|
+
export default function RootLayout({ children }) {
|
|
143
|
+
return (
|
|
144
|
+
<html>
|
|
145
|
+
<body>
|
|
146
|
+
{children}
|
|
147
|
+
<Analytics />
|
|
148
|
+
</body>
|
|
149
|
+
</html>
|
|
150
|
+
)
|
|
151
|
+
}
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
---
|
|
155
|
+
|
|
156
|
+
## Rule 2.4: Dynamic Imports for Heavy Components
|
|
157
|
+
|
|
158
|
+
**Impact:** CRITICAL
|
|
159
|
+
**Tags:** bundle, dynamic-import, code-splitting, next-dynamic
|
|
160
|
+
|
|
161
|
+
## Dynamic Imports for Heavy Components
|
|
162
|
+
|
|
163
|
+
Use `next/dynamic` to lazy-load large components not needed on initial render.
|
|
164
|
+
|
|
165
|
+
**Incorrect (Monaco bundles with main chunk ~300KB):**
|
|
166
|
+
|
|
167
|
+
```tsx
|
|
168
|
+
import { MonacoEditor } from './monaco-editor'
|
|
169
|
+
|
|
170
|
+
function CodePanel({ code }: { code: string }) {
|
|
171
|
+
return <MonacoEditor value={code} />
|
|
172
|
+
}
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
**Correct (Monaco loads on demand):**
|
|
176
|
+
|
|
177
|
+
```tsx
|
|
178
|
+
import dynamic from 'next/dynamic'
|
|
179
|
+
|
|
180
|
+
const MonacoEditor = dynamic(
|
|
181
|
+
() => import('./monaco-editor').then(m => m.MonacoEditor),
|
|
182
|
+
{ ssr: false }
|
|
183
|
+
)
|
|
184
|
+
|
|
185
|
+
function CodePanel({ code }: { code: string }) {
|
|
186
|
+
return <MonacoEditor value={code} />
|
|
187
|
+
}
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
---
|
|
191
|
+
|
|
192
|
+
## Rule 2.5: Preload Based on User Intent
|
|
193
|
+
|
|
194
|
+
**Impact:** MEDIUM
|
|
195
|
+
**Tags:** bundle, preload, user-intent, hover
|
|
196
|
+
|
|
197
|
+
## Preload Based on User Intent
|
|
198
|
+
|
|
199
|
+
Preload heavy bundles before they're needed to reduce perceived latency.
|
|
200
|
+
|
|
201
|
+
**Example (preload on hover/focus):**
|
|
202
|
+
|
|
203
|
+
```tsx
|
|
204
|
+
function EditorButton({ onClick }: { onClick: () => void }) {
|
|
205
|
+
const preload = () => {
|
|
206
|
+
if (typeof window !== 'undefined') {
|
|
207
|
+
void import('./monaco-editor')
|
|
208
|
+
}
|
|
209
|
+
}
|
|
210
|
+
|
|
211
|
+
return (
|
|
212
|
+
<button
|
|
213
|
+
onMouseEnter={preload}
|
|
214
|
+
onFocus={preload}
|
|
215
|
+
onClick={onClick}
|
|
216
|
+
>
|
|
217
|
+
Open Editor
|
|
218
|
+
</button>
|
|
219
|
+
)
|
|
220
|
+
}
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
**Example (preload when feature flag is enabled):**
|
|
224
|
+
|
|
225
|
+
```tsx
|
|
226
|
+
function FlagsProvider({ children, flags }: Props) {
|
|
227
|
+
useEffect(() => {
|
|
228
|
+
if (flags.editorEnabled && typeof window !== 'undefined') {
|
|
229
|
+
void import('./monaco-editor').then(mod => mod.init())
|
|
230
|
+
}
|
|
231
|
+
}, [flags.editorEnabled])
|
|
232
|
+
|
|
233
|
+
return <FlagsContext.Provider value={flags}>
|
|
234
|
+
{children}
|
|
235
|
+
</FlagsContext.Provider>
|
|
236
|
+
}
|
|
237
|
+
```
|
|
238
|
+
|
|
239
|
+
The `typeof window !== 'undefined'` check prevents bundling preloaded modules for SSR, optimizing server bundle size and build speed.
|
|
240
|
+
|