@sentry/warden 0.1.1 → 0.3.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.
Files changed (589) hide show
  1. package/dist/cli/commands/init.d.ts.map +1 -1
  2. package/dist/cli/commands/init.js +36 -2
  3. package/dist/cli/commands/init.js.map +1 -1
  4. package/dist/cli/commands/setup-app/manifest.d.ts.map +1 -1
  5. package/dist/cli/commands/setup-app/manifest.js +3 -1
  6. package/dist/cli/commands/setup-app/manifest.js.map +1 -1
  7. package/dist/cli/commands/setup-app.js +1 -1
  8. package/dist/cli/commands/setup-app.js.map +1 -1
  9. package/dist/cli/diff-apply.d.ts +15 -0
  10. package/dist/cli/diff-apply.d.ts.map +1 -0
  11. package/dist/cli/diff-apply.js +69 -0
  12. package/dist/cli/diff-apply.js.map +1 -0
  13. package/dist/cli/files.d.ts +11 -1
  14. package/dist/cli/files.d.ts.map +1 -1
  15. package/dist/cli/files.js +145 -4
  16. package/dist/cli/files.js.map +1 -1
  17. package/dist/cli/fix.d.ts +1 -5
  18. package/dist/cli/fix.d.ts.map +1 -1
  19. package/dist/cli/fix.js +3 -62
  20. package/dist/cli/fix.js.map +1 -1
  21. package/dist/cli/git.d.ts.map +1 -1
  22. package/dist/cli/git.js +5 -9
  23. package/dist/cli/git.js.map +1 -1
  24. package/dist/cli/index.js +0 -0
  25. package/dist/cli/output/tasks.d.ts.map +1 -1
  26. package/dist/cli/output/tasks.js +5 -1
  27. package/dist/cli/output/tasks.js.map +1 -1
  28. package/dist/config/schema.d.ts.map +1 -1
  29. package/dist/config/schema.js +15 -1
  30. package/dist/config/schema.js.map +1 -1
  31. package/dist/diff/coalesce.d.ts +32 -2
  32. package/dist/diff/coalesce.d.ts.map +1 -1
  33. package/dist/diff/coalesce.js +174 -2
  34. package/dist/diff/coalesce.js.map +1 -1
  35. package/dist/output/dedup.d.ts +7 -4
  36. package/dist/output/dedup.d.ts.map +1 -1
  37. package/dist/output/dedup.js +48 -12
  38. package/dist/output/dedup.js.map +1 -1
  39. package/dist/output/renderer.d.ts.map +1 -1
  40. package/dist/output/renderer.js +52 -7
  41. package/dist/output/renderer.js.map +1 -1
  42. package/dist/output/stale.d.ts.map +1 -1
  43. package/dist/output/stale.js +7 -0
  44. package/dist/output/stale.js.map +1 -1
  45. package/dist/output/types.d.ts +15 -1
  46. package/dist/output/types.d.ts.map +1 -1
  47. package/dist/sdk/analyze.d.ts +18 -0
  48. package/dist/sdk/analyze.d.ts.map +1 -0
  49. package/dist/sdk/analyze.js +421 -0
  50. package/dist/sdk/analyze.js.map +1 -0
  51. package/dist/sdk/errors.d.ts +23 -0
  52. package/dist/sdk/errors.d.ts.map +1 -0
  53. package/dist/sdk/errors.js +74 -0
  54. package/dist/sdk/errors.js.map +1 -0
  55. package/dist/sdk/extract.d.ts +44 -0
  56. package/dist/sdk/extract.d.ts.map +1 -0
  57. package/dist/sdk/extract.js +224 -0
  58. package/dist/sdk/extract.js.map +1 -0
  59. package/dist/sdk/prepare.d.ts +13 -0
  60. package/dist/sdk/prepare.d.ts.map +1 -0
  61. package/dist/sdk/prepare.js +73 -0
  62. package/dist/sdk/prepare.js.map +1 -0
  63. package/dist/sdk/prompt.d.ts +30 -0
  64. package/dist/sdk/prompt.d.ts.map +1 -0
  65. package/dist/sdk/prompt.js +109 -0
  66. package/dist/sdk/prompt.js.map +1 -0
  67. package/dist/sdk/retry.d.ts +12 -0
  68. package/dist/sdk/retry.d.ts.map +1 -0
  69. package/dist/sdk/retry.js +31 -0
  70. package/dist/sdk/retry.js.map +1 -0
  71. package/dist/sdk/runner.d.ts +22 -199
  72. package/dist/sdk/runner.d.ts.map +1 -1
  73. package/dist/sdk/runner.js +26 -884
  74. package/dist/sdk/runner.js.map +1 -1
  75. package/dist/sdk/types.d.ts +127 -0
  76. package/dist/sdk/types.d.ts.map +1 -0
  77. package/dist/sdk/types.js +5 -0
  78. package/dist/sdk/types.js.map +1 -0
  79. package/dist/sdk/usage.d.ts +20 -0
  80. package/dist/sdk/usage.d.ts.map +1 -0
  81. package/dist/sdk/usage.js +44 -0
  82. package/dist/sdk/usage.js.map +1 -0
  83. package/dist/skills/remote.d.ts.map +1 -1
  84. package/dist/skills/remote.js +3 -7
  85. package/dist/skills/remote.js.map +1 -1
  86. package/dist/types/index.d.ts +1 -0
  87. package/dist/types/index.d.ts.map +1 -1
  88. package/dist/types/index.js +2 -0
  89. package/dist/types/index.js.map +1 -1
  90. package/dist/utils/exec.d.ts +61 -0
  91. package/dist/utils/exec.d.ts.map +1 -0
  92. package/dist/utils/exec.js +111 -0
  93. package/dist/utils/exec.js.map +1 -0
  94. package/dist/utils/index.d.ts +2 -0
  95. package/dist/utils/index.d.ts.map +1 -1
  96. package/dist/utils/index.js +1 -0
  97. package/dist/utils/index.js.map +1 -1
  98. package/package.json +15 -16
  99. package/.agents/skills/find-bugs/SKILL.md +0 -75
  100. package/.agents/skills/vercel-react-best-practices/AGENTS.md +0 -2934
  101. package/.agents/skills/vercel-react-best-practices/SKILL.md +0 -136
  102. package/.agents/skills/vercel-react-best-practices/rules/advanced-event-handler-refs.md +0 -55
  103. package/.agents/skills/vercel-react-best-practices/rules/advanced-init-once.md +0 -42
  104. package/.agents/skills/vercel-react-best-practices/rules/advanced-use-latest.md +0 -39
  105. package/.agents/skills/vercel-react-best-practices/rules/async-api-routes.md +0 -38
  106. package/.agents/skills/vercel-react-best-practices/rules/async-defer-await.md +0 -80
  107. package/.agents/skills/vercel-react-best-practices/rules/async-dependencies.md +0 -51
  108. package/.agents/skills/vercel-react-best-practices/rules/async-parallel.md +0 -28
  109. package/.agents/skills/vercel-react-best-practices/rules/async-suspense-boundaries.md +0 -99
  110. package/.agents/skills/vercel-react-best-practices/rules/bundle-barrel-imports.md +0 -59
  111. package/.agents/skills/vercel-react-best-practices/rules/bundle-conditional.md +0 -31
  112. package/.agents/skills/vercel-react-best-practices/rules/bundle-defer-third-party.md +0 -49
  113. package/.agents/skills/vercel-react-best-practices/rules/bundle-dynamic-imports.md +0 -35
  114. package/.agents/skills/vercel-react-best-practices/rules/bundle-preload.md +0 -50
  115. package/.agents/skills/vercel-react-best-practices/rules/client-event-listeners.md +0 -74
  116. package/.agents/skills/vercel-react-best-practices/rules/client-localstorage-schema.md +0 -71
  117. package/.agents/skills/vercel-react-best-practices/rules/client-passive-event-listeners.md +0 -48
  118. package/.agents/skills/vercel-react-best-practices/rules/client-swr-dedup.md +0 -56
  119. package/.agents/skills/vercel-react-best-practices/rules/js-batch-dom-css.md +0 -107
  120. package/.agents/skills/vercel-react-best-practices/rules/js-cache-function-results.md +0 -80
  121. package/.agents/skills/vercel-react-best-practices/rules/js-cache-property-access.md +0 -28
  122. package/.agents/skills/vercel-react-best-practices/rules/js-cache-storage.md +0 -70
  123. package/.agents/skills/vercel-react-best-practices/rules/js-combine-iterations.md +0 -32
  124. package/.agents/skills/vercel-react-best-practices/rules/js-early-exit.md +0 -50
  125. package/.agents/skills/vercel-react-best-practices/rules/js-hoist-regexp.md +0 -45
  126. package/.agents/skills/vercel-react-best-practices/rules/js-index-maps.md +0 -37
  127. package/.agents/skills/vercel-react-best-practices/rules/js-length-check-first.md +0 -49
  128. package/.agents/skills/vercel-react-best-practices/rules/js-min-max-loop.md +0 -82
  129. package/.agents/skills/vercel-react-best-practices/rules/js-set-map-lookups.md +0 -24
  130. package/.agents/skills/vercel-react-best-practices/rules/js-tosorted-immutable.md +0 -57
  131. package/.agents/skills/vercel-react-best-practices/rules/rendering-activity.md +0 -26
  132. package/.agents/skills/vercel-react-best-practices/rules/rendering-animate-svg-wrapper.md +0 -47
  133. package/.agents/skills/vercel-react-best-practices/rules/rendering-conditional-render.md +0 -40
  134. package/.agents/skills/vercel-react-best-practices/rules/rendering-content-visibility.md +0 -38
  135. package/.agents/skills/vercel-react-best-practices/rules/rendering-hoist-jsx.md +0 -46
  136. package/.agents/skills/vercel-react-best-practices/rules/rendering-hydration-no-flicker.md +0 -82
  137. package/.agents/skills/vercel-react-best-practices/rules/rendering-hydration-suppress-warning.md +0 -30
  138. package/.agents/skills/vercel-react-best-practices/rules/rendering-svg-precision.md +0 -28
  139. package/.agents/skills/vercel-react-best-practices/rules/rendering-usetransition-loading.md +0 -75
  140. package/.agents/skills/vercel-react-best-practices/rules/rerender-defer-reads.md +0 -39
  141. package/.agents/skills/vercel-react-best-practices/rules/rerender-dependencies.md +0 -45
  142. package/.agents/skills/vercel-react-best-practices/rules/rerender-derived-state-no-effect.md +0 -40
  143. package/.agents/skills/vercel-react-best-practices/rules/rerender-derived-state.md +0 -29
  144. package/.agents/skills/vercel-react-best-practices/rules/rerender-functional-setstate.md +0 -74
  145. package/.agents/skills/vercel-react-best-practices/rules/rerender-lazy-state-init.md +0 -58
  146. package/.agents/skills/vercel-react-best-practices/rules/rerender-memo-with-default-value.md +0 -38
  147. package/.agents/skills/vercel-react-best-practices/rules/rerender-memo.md +0 -44
  148. package/.agents/skills/vercel-react-best-practices/rules/rerender-move-effect-to-event.md +0 -45
  149. package/.agents/skills/vercel-react-best-practices/rules/rerender-simple-expression-in-memo.md +0 -35
  150. package/.agents/skills/vercel-react-best-practices/rules/rerender-transitions.md +0 -40
  151. package/.agents/skills/vercel-react-best-practices/rules/rerender-use-ref-transient-values.md +0 -73
  152. package/.agents/skills/vercel-react-best-practices/rules/server-after-nonblocking.md +0 -73
  153. package/.agents/skills/vercel-react-best-practices/rules/server-auth-actions.md +0 -96
  154. package/.agents/skills/vercel-react-best-practices/rules/server-cache-lru.md +0 -41
  155. package/.agents/skills/vercel-react-best-practices/rules/server-cache-react.md +0 -76
  156. package/.agents/skills/vercel-react-best-practices/rules/server-dedup-props.md +0 -65
  157. package/.agents/skills/vercel-react-best-practices/rules/server-parallel-fetching.md +0 -83
  158. package/.agents/skills/vercel-react-best-practices/rules/server-serialization.md +0 -38
  159. package/.claude/settings.json +0 -57
  160. package/.claude/skills/agent-prompt/SKILL.md +0 -54
  161. package/.claude/skills/agent-prompt/references/agentic-patterns.md +0 -94
  162. package/.claude/skills/agent-prompt/references/anti-patterns.md +0 -140
  163. package/.claude/skills/agent-prompt/references/context-design.md +0 -124
  164. package/.claude/skills/agent-prompt/references/core-principles.md +0 -75
  165. package/.claude/skills/agent-prompt/references/model-guidance.md +0 -118
  166. package/.claude/skills/agent-prompt/references/output-formats.md +0 -98
  167. package/.claude/skills/agent-prompt/references/skill-structure.md +0 -115
  168. package/.claude/skills/agent-prompt/references/system-prompts.md +0 -115
  169. package/.claude/skills/notseer/SKILL.md +0 -131
  170. package/.claude/skills/skill-writer/SKILL.md +0 -140
  171. package/.claude/skills/testing-guidelines/SKILL.md +0 -132
  172. package/.claude/skills/warden-skill/SKILL.md +0 -226
  173. package/.claude/skills/warden-skill/references/config-schema.md +0 -116
  174. package/.dex/config.toml +0 -2
  175. package/.github/workflows/ci.yml +0 -33
  176. package/.github/workflows/release.yml +0 -59
  177. package/.github/workflows/warden.yml +0 -40
  178. package/AGENTS.md +0 -89
  179. package/CONTRIBUTING.md +0 -60
  180. package/SPEC.md +0 -263
  181. package/action.yml +0 -87
  182. package/assets/favicon.png +0 -0
  183. package/assets/warden-icon-bw.svg +0 -5
  184. package/assets/warden-icon-purple.png +0 -0
  185. package/assets/warden-icon-purple.svg +0 -5
  186. package/dist/action/159.index.js +0 -523
  187. package/dist/action/159.index.js.map +0 -1
  188. package/dist/action/action/index.d.ts +0 -2
  189. package/dist/action/action/index.d.ts.map +0 -1
  190. package/dist/action/action/main.d.ts +0 -2
  191. package/dist/action/action/main.d.ts.map +0 -1
  192. package/dist/action/cli/args.d.ts +0 -74
  193. package/dist/action/cli/args.d.ts.map +0 -1
  194. package/dist/action/cli/args.test.d.ts +0 -2
  195. package/dist/action/cli/args.test.d.ts.map +0 -1
  196. package/dist/action/cli/commands/add.d.ts +0 -7
  197. package/dist/action/cli/commands/add.d.ts.map +0 -1
  198. package/dist/action/cli/commands/init.d.ts +0 -10
  199. package/dist/action/cli/commands/init.d.ts.map +0 -1
  200. package/dist/action/cli/commands/init.test.d.ts +0 -2
  201. package/dist/action/cli/commands/init.test.d.ts.map +0 -1
  202. package/dist/action/cli/commands/setup-app/browser.d.ts +0 -9
  203. package/dist/action/cli/commands/setup-app/browser.d.ts.map +0 -1
  204. package/dist/action/cli/commands/setup-app/credentials.d.ts +0 -15
  205. package/dist/action/cli/commands/setup-app/credentials.d.ts.map +0 -1
  206. package/dist/action/cli/commands/setup-app/manifest.d.ts +0 -24
  207. package/dist/action/cli/commands/setup-app/manifest.d.ts.map +0 -1
  208. package/dist/action/cli/commands/setup-app/server.d.ts +0 -28
  209. package/dist/action/cli/commands/setup-app/server.d.ts.map +0 -1
  210. package/dist/action/cli/commands/setup-app.d.ts +0 -11
  211. package/dist/action/cli/commands/setup-app.d.ts.map +0 -1
  212. package/dist/action/cli/commands/sync.d.ts +0 -9
  213. package/dist/action/cli/commands/sync.d.ts.map +0 -1
  214. package/dist/action/cli/context.d.ts +0 -27
  215. package/dist/action/cli/context.d.ts.map +0 -1
  216. package/dist/action/cli/files.d.ts +0 -22
  217. package/dist/action/cli/files.d.ts.map +0 -1
  218. package/dist/action/cli/files.test.d.ts +0 -2
  219. package/dist/action/cli/files.test.d.ts.map +0 -1
  220. package/dist/action/cli/fix.d.ts +0 -41
  221. package/dist/action/cli/fix.d.ts.map +0 -1
  222. package/dist/action/cli/fix.test.d.ts +0 -2
  223. package/dist/action/cli/fix.test.d.ts.map +0 -1
  224. package/dist/action/cli/git.d.ts +0 -73
  225. package/dist/action/cli/git.d.ts.map +0 -1
  226. package/dist/action/cli/git.test.d.ts +0 -2
  227. package/dist/action/cli/git.test.d.ts.map +0 -1
  228. package/dist/action/cli/index.d.ts +0 -3
  229. package/dist/action/cli/index.d.ts.map +0 -1
  230. package/dist/action/cli/main.d.ts +0 -7
  231. package/dist/action/cli/main.d.ts.map +0 -1
  232. package/dist/action/cli/output/box.d.ts +0 -75
  233. package/dist/action/cli/output/box.d.ts.map +0 -1
  234. package/dist/action/cli/output/formatters.d.ts +0 -90
  235. package/dist/action/cli/output/formatters.d.ts.map +0 -1
  236. package/dist/action/cli/output/formatters.test.d.ts +0 -2
  237. package/dist/action/cli/output/formatters.test.d.ts.map +0 -1
  238. package/dist/action/cli/output/icons.d.ts +0 -15
  239. package/dist/action/cli/output/icons.d.ts.map +0 -1
  240. package/dist/action/cli/output/index.d.ts +0 -10
  241. package/dist/action/cli/output/index.d.ts.map +0 -1
  242. package/dist/action/cli/output/ink-runner.d.ts +0 -29
  243. package/dist/action/cli/output/ink-runner.d.ts.map +0 -1
  244. package/dist/action/cli/output/jsonl.d.ts +0 -43
  245. package/dist/action/cli/output/jsonl.d.ts.map +0 -1
  246. package/dist/action/cli/output/jsonl.test.d.ts +0 -2
  247. package/dist/action/cli/output/jsonl.test.d.ts.map +0 -1
  248. package/dist/action/cli/output/reporter.d.ts +0 -108
  249. package/dist/action/cli/output/reporter.d.ts.map +0 -1
  250. package/dist/action/cli/output/tasks.d.ts +0 -89
  251. package/dist/action/cli/output/tasks.d.ts.map +0 -1
  252. package/dist/action/cli/output/tty.d.ts +0 -21
  253. package/dist/action/cli/output/tty.d.ts.map +0 -1
  254. package/dist/action/cli/output/tty.test.d.ts +0 -2
  255. package/dist/action/cli/output/tty.test.d.ts.map +0 -1
  256. package/dist/action/cli/output/verbosity.d.ts +0 -20
  257. package/dist/action/cli/output/verbosity.d.ts.map +0 -1
  258. package/dist/action/cli/output/verbosity.test.d.ts +0 -2
  259. package/dist/action/cli/output/verbosity.test.d.ts.map +0 -1
  260. package/dist/action/cli/terminal.d.ts +0 -19
  261. package/dist/action/cli/terminal.d.ts.map +0 -1
  262. package/dist/action/cli/terminal.test.d.ts +0 -2
  263. package/dist/action/cli/terminal.test.d.ts.map +0 -1
  264. package/dist/action/config/index.d.ts +0 -4
  265. package/dist/action/config/index.d.ts.map +0 -1
  266. package/dist/action/config/loader.d.ts +0 -27
  267. package/dist/action/config/loader.d.ts.map +0 -1
  268. package/dist/action/config/loader.test.d.ts +0 -2
  269. package/dist/action/config/loader.test.d.ts.map +0 -1
  270. package/dist/action/config/schema.d.ts +0 -318
  271. package/dist/action/config/schema.d.ts.map +0 -1
  272. package/dist/action/config/writer.d.ts +0 -11
  273. package/dist/action/config/writer.d.ts.map +0 -1
  274. package/dist/action/config/writer.test.d.ts +0 -2
  275. package/dist/action/config/writer.test.d.ts.map +0 -1
  276. package/dist/action/diff/classify.d.ts +0 -29
  277. package/dist/action/diff/classify.d.ts.map +0 -1
  278. package/dist/action/diff/classify.test.d.ts +0 -2
  279. package/dist/action/diff/classify.test.d.ts.map +0 -1
  280. package/dist/action/diff/coalesce.d.ts +0 -42
  281. package/dist/action/diff/coalesce.d.ts.map +0 -1
  282. package/dist/action/diff/coalesce.test.d.ts +0 -2
  283. package/dist/action/diff/coalesce.test.d.ts.map +0 -1
  284. package/dist/action/diff/context.d.ts +0 -30
  285. package/dist/action/diff/context.d.ts.map +0 -1
  286. package/dist/action/diff/context.test.d.ts +0 -2
  287. package/dist/action/diff/context.test.d.ts.map +0 -1
  288. package/dist/action/diff/index.d.ts +0 -5
  289. package/dist/action/diff/index.d.ts.map +0 -1
  290. package/dist/action/diff/parser.d.ts +0 -52
  291. package/dist/action/diff/parser.d.ts.map +0 -1
  292. package/dist/action/diff/parser.test.d.ts +0 -2
  293. package/dist/action/diff/parser.test.d.ts.map +0 -1
  294. package/dist/action/event/context.d.ts +0 -9
  295. package/dist/action/event/context.d.ts.map +0 -1
  296. package/dist/action/event/index.d.ts +0 -3
  297. package/dist/action/event/index.d.ts.map +0 -1
  298. package/dist/action/event/schedule-context.d.ts +0 -30
  299. package/dist/action/event/schedule-context.d.ts.map +0 -1
  300. package/dist/action/examples/examples.integration.test.d.ts +0 -2
  301. package/dist/action/examples/examples.integration.test.d.ts.map +0 -1
  302. package/dist/action/examples/index.d.ts +0 -50
  303. package/dist/action/examples/index.d.ts.map +0 -1
  304. package/dist/action/examples/index.test.d.ts +0 -2
  305. package/dist/action/examples/index.test.d.ts.map +0 -1
  306. package/dist/action/examples/setup.d.ts +0 -2
  307. package/dist/action/examples/setup.d.ts.map +0 -1
  308. package/dist/action/index.d.ts +0 -11
  309. package/dist/action/index.d.ts.map +0 -1
  310. package/dist/action/index.js +0 -38231
  311. package/dist/action/index.js.map +0 -1
  312. package/dist/action/licenses.txt +0 -992
  313. package/dist/action/main.d.ts +0 -2
  314. package/dist/action/main.d.ts.map +0 -1
  315. package/dist/action/main.js +0 -707
  316. package/dist/action/main.js.map +0 -1
  317. package/dist/action/output/dedup.d.ts +0 -153
  318. package/dist/action/output/dedup.d.ts.map +0 -1
  319. package/dist/action/output/dedup.test.d.ts +0 -2
  320. package/dist/action/output/dedup.test.d.ts.map +0 -1
  321. package/dist/action/output/github-checks.d.ts +0 -106
  322. package/dist/action/output/github-checks.d.ts.map +0 -1
  323. package/dist/action/output/github-checks.test.d.ts +0 -2
  324. package/dist/action/output/github-checks.test.d.ts.map +0 -1
  325. package/dist/action/output/github-issues.d.ts +0 -35
  326. package/dist/action/output/github-issues.d.ts.map +0 -1
  327. package/dist/action/output/index.d.ts +0 -6
  328. package/dist/action/output/index.d.ts.map +0 -1
  329. package/dist/action/output/issue-renderer.d.ts +0 -20
  330. package/dist/action/output/issue-renderer.d.ts.map +0 -1
  331. package/dist/action/output/renderer.d.ts +0 -4
  332. package/dist/action/output/renderer.d.ts.map +0 -1
  333. package/dist/action/output/renderer.test.d.ts +0 -2
  334. package/dist/action/output/renderer.test.d.ts.map +0 -1
  335. package/dist/action/output/stale.d.ts +0 -31
  336. package/dist/action/output/stale.d.ts.map +0 -1
  337. package/dist/action/output/stale.test.d.ts +0 -2
  338. package/dist/action/output/stale.test.d.ts.map +0 -1
  339. package/dist/action/output/types.d.ts +0 -31
  340. package/dist/action/output/types.d.ts.map +0 -1
  341. package/dist/action/package.json +0 -3
  342. package/dist/action/sdk/index.d.ts +0 -2
  343. package/dist/action/sdk/index.d.ts.map +0 -1
  344. package/dist/action/sdk/runner.d.ts +0 -202
  345. package/dist/action/sdk/runner.d.ts.map +0 -1
  346. package/dist/action/sdk/runner.test.d.ts +0 -2
  347. package/dist/action/sdk/runner.test.d.ts.map +0 -1
  348. package/dist/action/skills/index.d.ts +0 -5
  349. package/dist/action/skills/index.d.ts.map +0 -1
  350. package/dist/action/skills/loader.d.ts +0 -111
  351. package/dist/action/skills/loader.d.ts.map +0 -1
  352. package/dist/action/skills/loader.test.d.ts +0 -2
  353. package/dist/action/skills/loader.test.d.ts.map +0 -1
  354. package/dist/action/skills/remote.d.ts +0 -117
  355. package/dist/action/skills/remote.d.ts.map +0 -1
  356. package/dist/action/skills/remote.test.d.ts +0 -2
  357. package/dist/action/skills/remote.test.d.ts.map +0 -1
  358. package/dist/action/sourcemap-register.cjs +0 -1
  359. package/dist/action/triggers/matcher.d.ts +0 -30
  360. package/dist/action/triggers/matcher.d.ts.map +0 -1
  361. package/dist/action/triggers/matcher.test.d.ts +0 -2
  362. package/dist/action/triggers/matcher.test.d.ts.map +0 -1
  363. package/dist/action/types/index.d.ts +0 -269
  364. package/dist/action/types/index.d.ts.map +0 -1
  365. package/dist/action/utils/async.d.ts +0 -5
  366. package/dist/action/utils/async.d.ts.map +0 -1
  367. package/dist/action/utils/index.d.ts +0 -16
  368. package/dist/action/utils/index.d.ts.map +0 -1
  369. package/dist/action/utils/index.test.d.ts +0 -2
  370. package/dist/action/utils/index.test.d.ts.map +0 -1
  371. package/dist/action/utils/version.d.ts +0 -3
  372. package/dist/action/utils/version.d.ts.map +0 -1
  373. package/dist/cli/args.test.d.ts +0 -2
  374. package/dist/cli/args.test.d.ts.map +0 -1
  375. package/dist/cli/args.test.js +0 -392
  376. package/dist/cli/args.test.js.map +0 -1
  377. package/dist/cli/commands/init.test.d.ts +0 -2
  378. package/dist/cli/commands/init.test.d.ts.map +0 -1
  379. package/dist/cli/commands/init.test.js +0 -117
  380. package/dist/cli/commands/init.test.js.map +0 -1
  381. package/dist/cli/files.test.d.ts +0 -2
  382. package/dist/cli/files.test.d.ts.map +0 -1
  383. package/dist/cli/files.test.js +0 -117
  384. package/dist/cli/files.test.js.map +0 -1
  385. package/dist/cli/fix.test.d.ts +0 -2
  386. package/dist/cli/fix.test.d.ts.map +0 -1
  387. package/dist/cli/fix.test.js +0 -251
  388. package/dist/cli/fix.test.js.map +0 -1
  389. package/dist/cli/git.test.d.ts +0 -2
  390. package/dist/cli/git.test.d.ts.map +0 -1
  391. package/dist/cli/git.test.js +0 -96
  392. package/dist/cli/git.test.js.map +0 -1
  393. package/dist/cli/output/formatters.test.d.ts +0 -2
  394. package/dist/cli/output/formatters.test.d.ts.map +0 -1
  395. package/dist/cli/output/formatters.test.js +0 -152
  396. package/dist/cli/output/formatters.test.js.map +0 -1
  397. package/dist/cli/output/jsonl.test.d.ts +0 -2
  398. package/dist/cli/output/jsonl.test.d.ts.map +0 -1
  399. package/dist/cli/output/jsonl.test.js +0 -284
  400. package/dist/cli/output/jsonl.test.js.map +0 -1
  401. package/dist/cli/output/tty.test.d.ts +0 -2
  402. package/dist/cli/output/tty.test.d.ts.map +0 -1
  403. package/dist/cli/output/tty.test.js +0 -105
  404. package/dist/cli/output/tty.test.js.map +0 -1
  405. package/dist/cli/output/verbosity.test.d.ts +0 -2
  406. package/dist/cli/output/verbosity.test.d.ts.map +0 -1
  407. package/dist/cli/output/verbosity.test.js +0 -35
  408. package/dist/cli/output/verbosity.test.js.map +0 -1
  409. package/dist/cli/terminal.test.d.ts +0 -2
  410. package/dist/cli/terminal.test.d.ts.map +0 -1
  411. package/dist/cli/terminal.test.js +0 -123
  412. package/dist/cli/terminal.test.js.map +0 -1
  413. package/dist/config/loader.test.d.ts +0 -2
  414. package/dist/config/loader.test.d.ts.map +0 -1
  415. package/dist/config/loader.test.js +0 -263
  416. package/dist/config/loader.test.js.map +0 -1
  417. package/dist/config/writer.test.d.ts +0 -2
  418. package/dist/config/writer.test.d.ts.map +0 -1
  419. package/dist/config/writer.test.js +0 -98
  420. package/dist/config/writer.test.js.map +0 -1
  421. package/dist/diff/classify.test.d.ts +0 -2
  422. package/dist/diff/classify.test.d.ts.map +0 -1
  423. package/dist/diff/classify.test.js +0 -140
  424. package/dist/diff/classify.test.js.map +0 -1
  425. package/dist/diff/coalesce.test.d.ts +0 -2
  426. package/dist/diff/coalesce.test.d.ts.map +0 -1
  427. package/dist/diff/coalesce.test.js +0 -159
  428. package/dist/diff/coalesce.test.js.map +0 -1
  429. package/dist/diff/context.test.d.ts +0 -2
  430. package/dist/diff/context.test.d.ts.map +0 -1
  431. package/dist/diff/context.test.js +0 -190
  432. package/dist/diff/context.test.js.map +0 -1
  433. package/dist/diff/parser.test.d.ts +0 -2
  434. package/dist/diff/parser.test.d.ts.map +0 -1
  435. package/dist/diff/parser.test.js +0 -178
  436. package/dist/diff/parser.test.js.map +0 -1
  437. package/dist/examples/examples.integration.test.d.ts +0 -2
  438. package/dist/examples/examples.integration.test.d.ts.map +0 -1
  439. package/dist/examples/examples.integration.test.js +0 -55
  440. package/dist/examples/examples.integration.test.js.map +0 -1
  441. package/dist/examples/index.test.d.ts +0 -2
  442. package/dist/examples/index.test.d.ts.map +0 -1
  443. package/dist/examples/index.test.js +0 -88
  444. package/dist/examples/index.test.js.map +0 -1
  445. package/dist/output/dedup.test.d.ts +0 -2
  446. package/dist/output/dedup.test.d.ts.map +0 -1
  447. package/dist/output/dedup.test.js +0 -357
  448. package/dist/output/dedup.test.js.map +0 -1
  449. package/dist/output/github-checks.test.d.ts +0 -2
  450. package/dist/output/github-checks.test.d.ts.map +0 -1
  451. package/dist/output/github-checks.test.js +0 -255
  452. package/dist/output/github-checks.test.js.map +0 -1
  453. package/dist/output/renderer.test.d.ts +0 -2
  454. package/dist/output/renderer.test.d.ts.map +0 -1
  455. package/dist/output/renderer.test.js +0 -645
  456. package/dist/output/renderer.test.js.map +0 -1
  457. package/dist/output/stale.test.d.ts +0 -2
  458. package/dist/output/stale.test.d.ts.map +0 -1
  459. package/dist/output/stale.test.js +0 -330
  460. package/dist/output/stale.test.js.map +0 -1
  461. package/dist/sdk/runner.test.d.ts +0 -2
  462. package/dist/sdk/runner.test.d.ts.map +0 -1
  463. package/dist/sdk/runner.test.js +0 -677
  464. package/dist/sdk/runner.test.js.map +0 -1
  465. package/dist/skills/loader.test.d.ts +0 -2
  466. package/dist/skills/loader.test.d.ts.map +0 -1
  467. package/dist/skills/loader.test.js +0 -241
  468. package/dist/skills/loader.test.js.map +0 -1
  469. package/dist/skills/remote.test.d.ts +0 -2
  470. package/dist/skills/remote.test.d.ts.map +0 -1
  471. package/dist/skills/remote.test.js +0 -582
  472. package/dist/skills/remote.test.js.map +0 -1
  473. package/dist/triggers/matcher.test.d.ts +0 -2
  474. package/dist/triggers/matcher.test.d.ts.map +0 -1
  475. package/dist/triggers/matcher.test.js +0 -234
  476. package/dist/triggers/matcher.test.js.map +0 -1
  477. package/dist/utils/index.test.d.ts +0 -2
  478. package/dist/utils/index.test.d.ts.map +0 -1
  479. package/dist/utils/index.test.js +0 -68
  480. package/dist/utils/index.test.js.map +0 -1
  481. package/docs/astro.config.mjs +0 -43
  482. package/docs/package.json +0 -19
  483. package/docs/pnpm-lock.yaml +0 -4000
  484. package/docs/public/favicon.svg +0 -5
  485. package/docs/src/components/Code.astro +0 -141
  486. package/docs/src/components/PackageManagerTabs.astro +0 -183
  487. package/docs/src/components/Terminal.astro +0 -212
  488. package/docs/src/layouts/Base.astro +0 -380
  489. package/docs/src/pages/cli.astro +0 -167
  490. package/docs/src/pages/config.astro +0 -395
  491. package/docs/src/pages/guide.astro +0 -450
  492. package/docs/src/pages/index.astro +0 -490
  493. package/docs/src/styles/global.css +0 -551
  494. package/docs/src/utils/version.ts +0 -6
  495. package/docs/tsconfig.json +0 -3
  496. package/docs/vercel.json +0 -5
  497. package/eslint.config.js +0 -33
  498. package/src/action/index.ts +0 -1
  499. package/src/action/main.ts +0 -868
  500. package/src/cli/args.test.ts +0 -477
  501. package/src/cli/args.ts +0 -414
  502. package/src/cli/commands/add.ts +0 -447
  503. package/src/cli/commands/init.test.ts +0 -137
  504. package/src/cli/commands/init.ts +0 -134
  505. package/src/cli/commands/setup-app/browser.ts +0 -38
  506. package/src/cli/commands/setup-app/credentials.ts +0 -45
  507. package/src/cli/commands/setup-app/manifest.ts +0 -48
  508. package/src/cli/commands/setup-app/server.ts +0 -172
  509. package/src/cli/commands/setup-app.ts +0 -156
  510. package/src/cli/commands/sync.ts +0 -114
  511. package/src/cli/context.ts +0 -131
  512. package/src/cli/files.test.ts +0 -155
  513. package/src/cli/files.ts +0 -89
  514. package/src/cli/fix.test.ts +0 -310
  515. package/src/cli/fix.ts +0 -387
  516. package/src/cli/git.test.ts +0 -119
  517. package/src/cli/git.ts +0 -318
  518. package/src/cli/index.ts +0 -14
  519. package/src/cli/main.ts +0 -672
  520. package/src/cli/output/box.ts +0 -235
  521. package/src/cli/output/formatters.test.ts +0 -187
  522. package/src/cli/output/formatters.ts +0 -269
  523. package/src/cli/output/icons.ts +0 -19
  524. package/src/cli/output/index.ts +0 -44
  525. package/src/cli/output/ink-runner.tsx +0 -366
  526. package/src/cli/output/jsonl.test.ts +0 -347
  527. package/src/cli/output/jsonl.ts +0 -126
  528. package/src/cli/output/reporter.ts +0 -434
  529. package/src/cli/output/tasks.ts +0 -374
  530. package/src/cli/output/tty.test.ts +0 -117
  531. package/src/cli/output/tty.ts +0 -60
  532. package/src/cli/output/verbosity.test.ts +0 -40
  533. package/src/cli/output/verbosity.ts +0 -31
  534. package/src/cli/terminal.test.ts +0 -148
  535. package/src/cli/terminal.ts +0 -301
  536. package/src/config/index.ts +0 -3
  537. package/src/config/loader.test.ts +0 -313
  538. package/src/config/loader.ts +0 -103
  539. package/src/config/schema.ts +0 -168
  540. package/src/config/writer.test.ts +0 -119
  541. package/src/config/writer.ts +0 -84
  542. package/src/diff/classify.test.ts +0 -162
  543. package/src/diff/classify.ts +0 -92
  544. package/src/diff/coalesce.test.ts +0 -208
  545. package/src/diff/coalesce.ts +0 -133
  546. package/src/diff/context.test.ts +0 -226
  547. package/src/diff/context.ts +0 -201
  548. package/src/diff/index.ts +0 -4
  549. package/src/diff/parser.test.ts +0 -212
  550. package/src/diff/parser.ts +0 -149
  551. package/src/event/context.ts +0 -132
  552. package/src/event/index.ts +0 -2
  553. package/src/event/schedule-context.ts +0 -101
  554. package/src/examples/examples.integration.test.ts +0 -66
  555. package/src/examples/index.test.ts +0 -101
  556. package/src/examples/index.ts +0 -122
  557. package/src/examples/setup.ts +0 -25
  558. package/src/index.ts +0 -115
  559. package/src/output/dedup.test.ts +0 -419
  560. package/src/output/dedup.ts +0 -607
  561. package/src/output/github-checks.test.ts +0 -300
  562. package/src/output/github-checks.ts +0 -476
  563. package/src/output/github-issues.ts +0 -329
  564. package/src/output/index.ts +0 -5
  565. package/src/output/issue-renderer.ts +0 -197
  566. package/src/output/renderer.test.ts +0 -727
  567. package/src/output/renderer.ts +0 -217
  568. package/src/output/stale.test.ts +0 -375
  569. package/src/output/stale.ts +0 -155
  570. package/src/output/types.ts +0 -34
  571. package/src/sdk/index.ts +0 -1
  572. package/src/sdk/runner.test.ts +0 -806
  573. package/src/sdk/runner.ts +0 -1232
  574. package/src/skills/index.ts +0 -36
  575. package/src/skills/loader.test.ts +0 -300
  576. package/src/skills/loader.ts +0 -423
  577. package/src/skills/remote.test.ts +0 -704
  578. package/src/skills/remote.ts +0 -604
  579. package/src/triggers/matcher.test.ts +0 -277
  580. package/src/triggers/matcher.ts +0 -152
  581. package/src/types/index.ts +0 -194
  582. package/src/utils/async.ts +0 -18
  583. package/src/utils/index.test.ts +0 -84
  584. package/src/utils/index.ts +0 -51
  585. package/src/utils/version.ts +0 -17
  586. package/tsconfig.json +0 -25
  587. package/vitest.config.ts +0 -8
  588. package/vitest.integration.config.ts +0 -11
  589. package/warden.toml +0 -19
@@ -1,28 +0,0 @@
1
- ---
2
- title: Optimize SVG Precision
3
- impact: LOW
4
- impactDescription: reduces file size
5
- tags: rendering, svg, optimization, svgo
6
- ---
7
-
8
- ## Optimize SVG Precision
9
-
10
- Reduce SVG coordinate precision to decrease file size. The optimal precision depends on the viewBox size, but in general reducing precision should be considered.
11
-
12
- **Incorrect (excessive precision):**
13
-
14
- ```svg
15
- <path d="M 10.293847 20.847362 L 30.938472 40.192837" />
16
- ```
17
-
18
- **Correct (1 decimal place):**
19
-
20
- ```svg
21
- <path d="M 10.3 20.8 L 30.9 40.2" />
22
- ```
23
-
24
- **Automate with SVGO:**
25
-
26
- ```bash
27
- npx svgo --precision=1 --multipass icon.svg
28
- ```
@@ -1,75 +0,0 @@
1
- ---
2
- title: Use useTransition Over Manual Loading States
3
- impact: LOW
4
- impactDescription: reduces re-renders and improves code clarity
5
- tags: rendering, transitions, useTransition, loading, state
6
- ---
7
-
8
- ## Use useTransition Over Manual Loading States
9
-
10
- Use `useTransition` instead of manual `useState` for loading states. This provides built-in `isPending` state and automatically manages transitions.
11
-
12
- **Incorrect (manual loading state):**
13
-
14
- ```tsx
15
- function SearchResults() {
16
- const [query, setQuery] = useState('')
17
- const [results, setResults] = useState([])
18
- const [isLoading, setIsLoading] = useState(false)
19
-
20
- const handleSearch = async (value: string) => {
21
- setIsLoading(true)
22
- setQuery(value)
23
- const data = await fetchResults(value)
24
- setResults(data)
25
- setIsLoading(false)
26
- }
27
-
28
- return (
29
- <>
30
- <input onChange={(e) => handleSearch(e.target.value)} />
31
- {isLoading && <Spinner />}
32
- <ResultsList results={results} />
33
- </>
34
- )
35
- }
36
- ```
37
-
38
- **Correct (useTransition with built-in pending state):**
39
-
40
- ```tsx
41
- import { useTransition, useState } from 'react'
42
-
43
- function SearchResults() {
44
- const [query, setQuery] = useState('')
45
- const [results, setResults] = useState([])
46
- const [isPending, startTransition] = useTransition()
47
-
48
- const handleSearch = (value: string) => {
49
- setQuery(value) // Update input immediately
50
-
51
- startTransition(async () => {
52
- // Fetch and update results
53
- const data = await fetchResults(value)
54
- setResults(data)
55
- })
56
- }
57
-
58
- return (
59
- <>
60
- <input onChange={(e) => handleSearch(e.target.value)} />
61
- {isPending && <Spinner />}
62
- <ResultsList results={results} />
63
- </>
64
- )
65
- }
66
- ```
67
-
68
- **Benefits:**
69
-
70
- - **Automatic pending state**: No need to manually manage `setIsLoading(true/false)`
71
- - **Error resilience**: Pending state correctly resets even if the transition throws
72
- - **Better responsiveness**: Keeps the UI responsive during updates
73
- - **Interrupt handling**: New transitions automatically cancel pending ones
74
-
75
- Reference: [useTransition](https://react.dev/reference/react/useTransition)
@@ -1,39 +0,0 @@
1
- ---
2
- title: Defer State Reads to Usage Point
3
- impact: MEDIUM
4
- impactDescription: avoids unnecessary subscriptions
5
- tags: rerender, searchParams, localStorage, optimization
6
- ---
7
-
8
- ## Defer State Reads to Usage Point
9
-
10
- Don't subscribe to dynamic state (searchParams, localStorage) if you only read it inside callbacks.
11
-
12
- **Incorrect (subscribes to all searchParams changes):**
13
-
14
- ```tsx
15
- function ShareButton({ chatId }: { chatId: string }) {
16
- const searchParams = useSearchParams()
17
-
18
- const handleShare = () => {
19
- const ref = searchParams.get('ref')
20
- shareChat(chatId, { ref })
21
- }
22
-
23
- return <button onClick={handleShare}>Share</button>
24
- }
25
- ```
26
-
27
- **Correct (reads on demand, no subscription):**
28
-
29
- ```tsx
30
- function ShareButton({ chatId }: { chatId: string }) {
31
- const handleShare = () => {
32
- const params = new URLSearchParams(window.location.search)
33
- const ref = params.get('ref')
34
- shareChat(chatId, { ref })
35
- }
36
-
37
- return <button onClick={handleShare}>Share</button>
38
- }
39
- ```
@@ -1,45 +0,0 @@
1
- ---
2
- title: Narrow Effect Dependencies
3
- impact: LOW
4
- impactDescription: minimizes effect re-runs
5
- tags: rerender, useEffect, dependencies, optimization
6
- ---
7
-
8
- ## Narrow Effect Dependencies
9
-
10
- Specify primitive dependencies instead of objects to minimize effect re-runs.
11
-
12
- **Incorrect (re-runs on any user field change):**
13
-
14
- ```tsx
15
- useEffect(() => {
16
- console.log(user.id)
17
- }, [user])
18
- ```
19
-
20
- **Correct (re-runs only when id changes):**
21
-
22
- ```tsx
23
- useEffect(() => {
24
- console.log(user.id)
25
- }, [user.id])
26
- ```
27
-
28
- **For derived state, compute outside effect:**
29
-
30
- ```tsx
31
- // Incorrect: runs on width=767, 766, 765...
32
- useEffect(() => {
33
- if (width < 768) {
34
- enableMobileMode()
35
- }
36
- }, [width])
37
-
38
- // Correct: runs only on boolean transition
39
- const isMobile = width < 768
40
- useEffect(() => {
41
- if (isMobile) {
42
- enableMobileMode()
43
- }
44
- }, [isMobile])
45
- ```
@@ -1,40 +0,0 @@
1
- ---
2
- title: Calculate Derived State During Rendering
3
- impact: MEDIUM
4
- impactDescription: avoids redundant renders and state drift
5
- tags: rerender, derived-state, useEffect, state
6
- ---
7
-
8
- ## Calculate Derived State During Rendering
9
-
10
- If a value can be computed from current props/state, do not store it in state or update it in an effect. Derive it during render to avoid extra renders and state drift. Do not set state in effects solely in response to prop changes; prefer derived values or keyed resets instead.
11
-
12
- **Incorrect (redundant state and effect):**
13
-
14
- ```tsx
15
- function Form() {
16
- const [firstName, setFirstName] = useState('First')
17
- const [lastName, setLastName] = useState('Last')
18
- const [fullName, setFullName] = useState('')
19
-
20
- useEffect(() => {
21
- setFullName(firstName + ' ' + lastName)
22
- }, [firstName, lastName])
23
-
24
- return <p>{fullName}</p>
25
- }
26
- ```
27
-
28
- **Correct (derive during render):**
29
-
30
- ```tsx
31
- function Form() {
32
- const [firstName, setFirstName] = useState('First')
33
- const [lastName, setLastName] = useState('Last')
34
- const fullName = firstName + ' ' + lastName
35
-
36
- return <p>{fullName}</p>
37
- }
38
- ```
39
-
40
- References: [You Might Not Need an Effect](https://react.dev/learn/you-might-not-need-an-effect)
@@ -1,29 +0,0 @@
1
- ---
2
- title: Subscribe to Derived State
3
- impact: MEDIUM
4
- impactDescription: reduces re-render frequency
5
- tags: rerender, derived-state, media-query, optimization
6
- ---
7
-
8
- ## Subscribe to Derived State
9
-
10
- Subscribe to derived boolean state instead of continuous values to reduce re-render frequency.
11
-
12
- **Incorrect (re-renders on every pixel change):**
13
-
14
- ```tsx
15
- function Sidebar() {
16
- const width = useWindowWidth() // updates continuously
17
- const isMobile = width < 768
18
- return <nav className={isMobile ? 'mobile' : 'desktop'} />
19
- }
20
- ```
21
-
22
- **Correct (re-renders only when boolean changes):**
23
-
24
- ```tsx
25
- function Sidebar() {
26
- const isMobile = useMediaQuery('(max-width: 767px)')
27
- return <nav className={isMobile ? 'mobile' : 'desktop'} />
28
- }
29
- ```
@@ -1,74 +0,0 @@
1
- ---
2
- title: Use Functional setState Updates
3
- impact: MEDIUM
4
- impactDescription: prevents stale closures and unnecessary callback recreations
5
- tags: react, hooks, useState, useCallback, callbacks, closures
6
- ---
7
-
8
- ## Use Functional setState Updates
9
-
10
- When updating state based on the current state value, use the functional update form of setState instead of directly referencing the state variable. This prevents stale closures, eliminates unnecessary dependencies, and creates stable callback references.
11
-
12
- **Incorrect (requires state as dependency):**
13
-
14
- ```tsx
15
- function TodoList() {
16
- const [items, setItems] = useState(initialItems)
17
-
18
- // Callback must depend on items, recreated on every items change
19
- const addItems = useCallback((newItems: Item[]) => {
20
- setItems([...items, ...newItems])
21
- }, [items]) // ❌ items dependency causes recreations
22
-
23
- // Risk of stale closure if dependency is forgotten
24
- const removeItem = useCallback((id: string) => {
25
- setItems(items.filter(item => item.id !== id))
26
- }, []) // ❌ Missing items dependency - will use stale items!
27
-
28
- return <ItemsEditor items={items} onAdd={addItems} onRemove={removeItem} />
29
- }
30
- ```
31
-
32
- The first callback is recreated every time `items` changes, which can cause child components to re-render unnecessarily. The second callback has a stale closure bug—it will always reference the initial `items` value.
33
-
34
- **Correct (stable callbacks, no stale closures):**
35
-
36
- ```tsx
37
- function TodoList() {
38
- const [items, setItems] = useState(initialItems)
39
-
40
- // Stable callback, never recreated
41
- const addItems = useCallback((newItems: Item[]) => {
42
- setItems(curr => [...curr, ...newItems])
43
- }, []) // ✅ No dependencies needed
44
-
45
- // Always uses latest state, no stale closure risk
46
- const removeItem = useCallback((id: string) => {
47
- setItems(curr => curr.filter(item => item.id !== id))
48
- }, []) // ✅ Safe and stable
49
-
50
- return <ItemsEditor items={items} onAdd={addItems} onRemove={removeItem} />
51
- }
52
- ```
53
-
54
- **Benefits:**
55
-
56
- 1. **Stable callback references** - Callbacks don't need to be recreated when state changes
57
- 2. **No stale closures** - Always operates on the latest state value
58
- 3. **Fewer dependencies** - Simplifies dependency arrays and reduces memory leaks
59
- 4. **Prevents bugs** - Eliminates the most common source of React closure bugs
60
-
61
- **When to use functional updates:**
62
-
63
- - Any setState that depends on the current state value
64
- - Inside useCallback/useMemo when state is needed
65
- - Event handlers that reference state
66
- - Async operations that update state
67
-
68
- **When direct updates are fine:**
69
-
70
- - Setting state to a static value: `setCount(0)`
71
- - Setting state from props/arguments only: `setName(newName)`
72
- - State doesn't depend on previous value
73
-
74
- **Note:** If your project has [React Compiler](https://react.dev/learn/react-compiler) enabled, the compiler can automatically optimize some cases, but functional updates are still recommended for correctness and to prevent stale closure bugs.
@@ -1,58 +0,0 @@
1
- ---
2
- title: Use Lazy State Initialization
3
- impact: MEDIUM
4
- impactDescription: wasted computation on every render
5
- tags: react, hooks, useState, performance, initialization
6
- ---
7
-
8
- ## Use Lazy State Initialization
9
-
10
- Pass a function to `useState` for expensive initial values. Without the function form, the initializer runs on every render even though the value is only used once.
11
-
12
- **Incorrect (runs on every render):**
13
-
14
- ```tsx
15
- function FilteredList({ items }: { items: Item[] }) {
16
- // buildSearchIndex() runs on EVERY render, even after initialization
17
- const [searchIndex, setSearchIndex] = useState(buildSearchIndex(items))
18
- const [query, setQuery] = useState('')
19
-
20
- // When query changes, buildSearchIndex runs again unnecessarily
21
- return <SearchResults index={searchIndex} query={query} />
22
- }
23
-
24
- function UserProfile() {
25
- // JSON.parse runs on every render
26
- const [settings, setSettings] = useState(
27
- JSON.parse(localStorage.getItem('settings') || '{}')
28
- )
29
-
30
- return <SettingsForm settings={settings} onChange={setSettings} />
31
- }
32
- ```
33
-
34
- **Correct (runs only once):**
35
-
36
- ```tsx
37
- function FilteredList({ items }: { items: Item[] }) {
38
- // buildSearchIndex() runs ONLY on initial render
39
- const [searchIndex, setSearchIndex] = useState(() => buildSearchIndex(items))
40
- const [query, setQuery] = useState('')
41
-
42
- return <SearchResults index={searchIndex} query={query} />
43
- }
44
-
45
- function UserProfile() {
46
- // JSON.parse runs only on initial render
47
- const [settings, setSettings] = useState(() => {
48
- const stored = localStorage.getItem('settings')
49
- return stored ? JSON.parse(stored) : {}
50
- })
51
-
52
- return <SettingsForm settings={settings} onChange={setSettings} />
53
- }
54
- ```
55
-
56
- Use lazy initialization when computing initial values from localStorage/sessionStorage, building data structures (indexes, maps), reading from the DOM, or performing heavy transformations.
57
-
58
- For simple primitives (`useState(0)`), direct references (`useState(props.value)`), or cheap literals (`useState({})`), the function form is unnecessary.
@@ -1,38 +0,0 @@
1
- ---
2
-
3
- title: Extract Default Non-primitive Parameter Value from Memoized Component to Constant
4
- impact: MEDIUM
5
- impactDescription: restores memoization by using a constant for default value
6
- tags: rerender, memo, optimization
7
-
8
- ---
9
-
10
- ## Extract Default Non-primitive Parameter Value from Memoized Component to Constant
11
-
12
- When memoized component has a default value for some non-primitive optional parameter, such as an array, function, or object, calling the component without that parameter results in broken memoization. This is because new value instances are created on every rerender, and they do not pass strict equality comparison in `memo()`.
13
-
14
- To address this issue, extract the default value into a constant.
15
-
16
- **Incorrect (`onClick` has different values on every rerender):**
17
-
18
- ```tsx
19
- const UserAvatar = memo(function UserAvatar({ onClick = () => {} }: { onClick?: () => void }) {
20
- // ...
21
- })
22
-
23
- // Used without optional onClick
24
- <UserAvatar />
25
- ```
26
-
27
- **Correct (stable default value):**
28
-
29
- ```tsx
30
- const NOOP = () => {};
31
-
32
- const UserAvatar = memo(function UserAvatar({ onClick = NOOP }: { onClick?: () => void }) {
33
- // ...
34
- })
35
-
36
- // Used without optional onClick
37
- <UserAvatar />
38
- ```
@@ -1,44 +0,0 @@
1
- ---
2
- title: Extract to Memoized Components
3
- impact: MEDIUM
4
- impactDescription: enables early returns
5
- tags: rerender, memo, useMemo, optimization
6
- ---
7
-
8
- ## Extract to Memoized Components
9
-
10
- Extract expensive work into memoized components to enable early returns before computation.
11
-
12
- **Incorrect (computes avatar even when loading):**
13
-
14
- ```tsx
15
- function Profile({ user, loading }: Props) {
16
- const avatar = useMemo(() => {
17
- const id = computeAvatarId(user)
18
- return <Avatar id={id} />
19
- }, [user])
20
-
21
- if (loading) return <Skeleton />
22
- return <div>{avatar}</div>
23
- }
24
- ```
25
-
26
- **Correct (skips computation when loading):**
27
-
28
- ```tsx
29
- const UserAvatar = memo(function UserAvatar({ user }: { user: User }) {
30
- const id = useMemo(() => computeAvatarId(user), [user])
31
- return <Avatar id={id} />
32
- })
33
-
34
- function Profile({ user, loading }: Props) {
35
- if (loading) return <Skeleton />
36
- return (
37
- <div>
38
- <UserAvatar user={user} />
39
- </div>
40
- )
41
- }
42
- ```
43
-
44
- **Note:** If your project has [React Compiler](https://react.dev/learn/react-compiler) enabled, manual memoization with `memo()` and `useMemo()` is not necessary. The compiler automatically optimizes re-renders.
@@ -1,45 +0,0 @@
1
- ---
2
- title: Put Interaction Logic in Event Handlers
3
- impact: MEDIUM
4
- impactDescription: avoids effect re-runs and duplicate side effects
5
- tags: rerender, useEffect, events, side-effects, dependencies
6
- ---
7
-
8
- ## Put Interaction Logic in Event Handlers
9
-
10
- If a side effect is triggered by a specific user action (submit, click, drag), run it in that event handler. Do not model the action as state + effect; it makes effects re-run on unrelated changes and can duplicate the action.
11
-
12
- **Incorrect (event modeled as state + effect):**
13
-
14
- ```tsx
15
- function Form() {
16
- const [submitted, setSubmitted] = useState(false)
17
- const theme = useContext(ThemeContext)
18
-
19
- useEffect(() => {
20
- if (submitted) {
21
- post('/api/register')
22
- showToast('Registered', theme)
23
- }
24
- }, [submitted, theme])
25
-
26
- return <button onClick={() => setSubmitted(true)}>Submit</button>
27
- }
28
- ```
29
-
30
- **Correct (do it in the handler):**
31
-
32
- ```tsx
33
- function Form() {
34
- const theme = useContext(ThemeContext)
35
-
36
- function handleSubmit() {
37
- post('/api/register')
38
- showToast('Registered', theme)
39
- }
40
-
41
- return <button onClick={handleSubmit}>Submit</button>
42
- }
43
- ```
44
-
45
- Reference: [Should this code move to an event handler?](https://react.dev/learn/removing-effect-dependencies#should-this-code-move-to-an-event-handler)
@@ -1,35 +0,0 @@
1
- ---
2
- title: Do not wrap a simple expression with a primitive result type in useMemo
3
- impact: LOW-MEDIUM
4
- impactDescription: wasted computation on every render
5
- tags: rerender, useMemo, optimization
6
- ---
7
-
8
- ## Do not wrap a simple expression with a primitive result type in useMemo
9
-
10
- When an expression is simple (few logical or arithmetical operators) and has a primitive result type (boolean, number, string), do not wrap it in `useMemo`.
11
- Calling `useMemo` and comparing hook dependencies may consume more resources than the expression itself.
12
-
13
- **Incorrect:**
14
-
15
- ```tsx
16
- function Header({ user, notifications }: Props) {
17
- const isLoading = useMemo(() => {
18
- return user.isLoading || notifications.isLoading
19
- }, [user.isLoading, notifications.isLoading])
20
-
21
- if (isLoading) return <Skeleton />
22
- // return some markup
23
- }
24
- ```
25
-
26
- **Correct:**
27
-
28
- ```tsx
29
- function Header({ user, notifications }: Props) {
30
- const isLoading = user.isLoading || notifications.isLoading
31
-
32
- if (isLoading) return <Skeleton />
33
- // return some markup
34
- }
35
- ```
@@ -1,40 +0,0 @@
1
- ---
2
- title: Use Transitions for Non-Urgent Updates
3
- impact: MEDIUM
4
- impactDescription: maintains UI responsiveness
5
- tags: rerender, transitions, startTransition, performance
6
- ---
7
-
8
- ## Use Transitions for Non-Urgent Updates
9
-
10
- Mark frequent, non-urgent state updates as transitions to maintain UI responsiveness.
11
-
12
- **Incorrect (blocks UI on every scroll):**
13
-
14
- ```tsx
15
- function ScrollTracker() {
16
- const [scrollY, setScrollY] = useState(0)
17
- useEffect(() => {
18
- const handler = () => setScrollY(window.scrollY)
19
- window.addEventListener('scroll', handler, { passive: true })
20
- return () => window.removeEventListener('scroll', handler)
21
- }, [])
22
- }
23
- ```
24
-
25
- **Correct (non-blocking updates):**
26
-
27
- ```tsx
28
- import { startTransition } from 'react'
29
-
30
- function ScrollTracker() {
31
- const [scrollY, setScrollY] = useState(0)
32
- useEffect(() => {
33
- const handler = () => {
34
- startTransition(() => setScrollY(window.scrollY))
35
- }
36
- window.addEventListener('scroll', handler, { passive: true })
37
- return () => window.removeEventListener('scroll', handler)
38
- }, [])
39
- }
40
- ```
@@ -1,73 +0,0 @@
1
- ---
2
- title: Use useRef for Transient Values
3
- impact: MEDIUM
4
- impactDescription: avoids unnecessary re-renders on frequent updates
5
- tags: rerender, useref, state, performance
6
- ---
7
-
8
- ## Use useRef for Transient Values
9
-
10
- When a value changes frequently and you don't want a re-render on every update (e.g., mouse trackers, intervals, transient flags), store it in `useRef` instead of `useState`. Keep component state for UI; use refs for temporary DOM-adjacent values. Updating a ref does not trigger a re-render.
11
-
12
- **Incorrect (renders every update):**
13
-
14
- ```tsx
15
- function Tracker() {
16
- const [lastX, setLastX] = useState(0)
17
-
18
- useEffect(() => {
19
- const onMove = (e: MouseEvent) => setLastX(e.clientX)
20
- window.addEventListener('mousemove', onMove)
21
- return () => window.removeEventListener('mousemove', onMove)
22
- }, [])
23
-
24
- return (
25
- <div
26
- style={{
27
- position: 'fixed',
28
- top: 0,
29
- left: lastX,
30
- width: 8,
31
- height: 8,
32
- background: 'black',
33
- }}
34
- />
35
- )
36
- }
37
- ```
38
-
39
- **Correct (no re-render for tracking):**
40
-
41
- ```tsx
42
- function Tracker() {
43
- const lastXRef = useRef(0)
44
- const dotRef = useRef<HTMLDivElement>(null)
45
-
46
- useEffect(() => {
47
- const onMove = (e: MouseEvent) => {
48
- lastXRef.current = e.clientX
49
- const node = dotRef.current
50
- if (node) {
51
- node.style.transform = `translateX(${e.clientX}px)`
52
- }
53
- }
54
- window.addEventListener('mousemove', onMove)
55
- return () => window.removeEventListener('mousemove', onMove)
56
- }, [])
57
-
58
- return (
59
- <div
60
- ref={dotRef}
61
- style={{
62
- position: 'fixed',
63
- top: 0,
64
- left: 0,
65
- width: 8,
66
- height: 8,
67
- background: 'black',
68
- transform: 'translateX(0px)',
69
- }}
70
- />
71
- )
72
- }
73
- ```