@peaske7/readit 0.3.0-rc.0 → 0.3.0-rc.2
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 +3 -3
- package/dist/.vite/manifest.json +1111 -0
- package/dist/assets/_basePickBy-BMMA4Tou.js +1 -0
- package/dist/assets/_baseUniq-D40qku1I.js +1 -0
- package/dist/assets/arc-Ckg65iy8.js +1 -0
- package/dist/assets/architecture-YZFGNWBL-Dv3EY0zV.js +1 -0
- package/dist/assets/architectureDiagram-Q4EWVU46-DQnkwSaB.js +36 -0
- package/dist/assets/array-Bjz-wYpJ.js +1 -0
- package/dist/assets/blockDiagram-DXYQGD6D-UB6_S1lm.js +132 -0
- package/dist/assets/c4Diagram-AHTNJAMY-sn3k2GND.js +10 -0
- package/dist/assets/channel-D9wPw2fQ.js +1 -0
- package/dist/assets/chunk-2KRD3SAO-DaFfaCGO.js +1 -0
- package/dist/assets/chunk-336JU56O-C8siO5Of.js +2 -0
- package/dist/assets/chunk-426QAEUC-BB478m3j.js +1 -0
- package/dist/assets/chunk-4BX2VUAB-DRuTD7x5.js +1 -0
- package/dist/assets/chunk-4TB4RGXK-_l6jvVAY.js +206 -0
- package/dist/assets/chunk-55IACEB6-BExiaAoD.js +1 -0
- package/dist/assets/chunk-5FUZZQ4R-HOSFTxuG.js +62 -0
- package/dist/assets/chunk-5PVQY5BW-BRVNNRAX.js +2 -0
- package/dist/assets/chunk-67CJDMHE-DMt8LNEX.js +1 -0
- package/dist/assets/chunk-7N4EOEYR-CzLGefVf.js +1 -0
- package/dist/assets/chunk-AA7GKIK3-B6GFAk4U.js +1 -0
- package/dist/assets/chunk-BSJP7CBP-BK29yehL.js +1 -0
- package/dist/assets/chunk-CIAEETIT-D7hBXImP.js +1 -0
- package/dist/assets/chunk-Dlc7tRH4.js +1 -0
- package/dist/assets/chunk-EDXVE4YY-CSvKh9DT.js +1 -0
- package/dist/assets/chunk-ENJZ2VHE-QApb5cYr.js +10 -0
- package/dist/assets/chunk-FMBD7UC4-2FWyCCAV.js +15 -0
- package/dist/assets/chunk-FOC6F5B3-DKFHrt4K.js +1 -0
- package/dist/assets/chunk-ICPOFSXX-agBjBxsW.js +122 -0
- package/dist/assets/chunk-K5T4RW27-D51O7IkG.js +94 -0
- package/dist/assets/chunk-KGLVRYIC-DMHSCH4T.js +1 -0
- package/dist/assets/chunk-LIHQZDEY-C2aANxt9.js +1 -0
- package/dist/assets/chunk-ORNJ4GCN-Db_37NRX.js +1 -0
- package/dist/assets/chunk-OYMX7WX6-HGUtT2Q9.js +231 -0
- package/dist/assets/chunk-QZHKN3VN-8Lcg9gti.js +1 -0
- package/dist/assets/chunk-U2HBQHQK-BFYYQeuC.js +70 -0
- package/dist/assets/chunk-X2U36JSP-p8ehTP6s.js +1 -0
- package/dist/assets/chunk-XPW4576I-Bqbompq4.js +32 -0
- package/dist/assets/chunk-YZCP3GAM-HIMez9pG.js +1 -0
- package/dist/assets/chunk-ZZ45TVLE-DRIE_0bu.js +1 -0
- package/dist/assets/classDiagram-6PBFFD2Q-BawhEeUl.js +1 -0
- package/dist/assets/classDiagram-v2-HSJHXN6E-CLNjgH9n.js +1 -0
- package/dist/assets/clone-BBjvuERA.js +1 -0
- package/dist/assets/cose-bilkent-S5V4N54A-q90QeGKv.js +1 -0
- package/dist/assets/cytoscape.esm-BfXff3fb.js +321 -0
- package/dist/assets/dagre-Dxbob2Lr.js +1 -0
- package/dist/assets/dagre-KV5264BT-BuvpNxMw.js +4 -0
- package/dist/assets/defaultLocale-BwmRmqJp.js +1 -0
- package/dist/assets/diagram-5BDNPKRD-DQLsxwwt.js +10 -0
- package/dist/assets/diagram-G4DWMVQ6-Jv9Eefw4.js +24 -0
- package/dist/assets/diagram-MMDJMWI5-D-0YgNhU.js +43 -0
- package/dist/assets/diagram-TYMM5635-BHwO7zQG.js +24 -0
- package/dist/assets/dist-BNz65Ibc.js +1 -0
- package/dist/assets/erDiagram-SMLLAGMA-BjZGGBJz.js +85 -0
- package/dist/assets/flowDiagram-DWJPFMVM-CFbFUm_m.js +162 -0
- package/dist/assets/ganttDiagram-T4ZO3ILL-CXk4TcBi.js +292 -0
- package/dist/assets/gitGraph-7Q5UKJZL-BGFRt2qs.js +1 -0
- package/dist/assets/gitGraphDiagram-UUTBAWPF-C8yZOxjo.js +106 -0
- package/dist/assets/graphlib-DGcD9J2L.js +1 -0
- package/dist/assets/index-D-m0LiFI.js +14 -0
- package/dist/assets/index-DANHO6J0.css +2 -0
- package/dist/assets/info-OMHHGYJF-DI6-Z9vh.js +1 -0
- package/dist/assets/infoDiagram-42DDH7IO-p-PXDra2.js +2 -0
- package/dist/assets/init-TPm5RB77.js +1 -0
- package/dist/assets/isArrayLikeObject-69BLnVNM.js +1 -0
- package/dist/assets/isEmpty-DUS28g5f.js +1 -0
- package/dist/assets/ishikawaDiagram-UXIWVN3A-BrIoEvtb.js +70 -0
- package/dist/assets/journeyDiagram-VCZTEJTY-aZpvKa9g.js +139 -0
- package/dist/assets/kanban-definition-6JOO6SKY-CoOAY9ji.js +89 -0
- package/dist/assets/katex-5SGEXwpi.js +261 -0
- package/dist/assets/line-4MF1lR4d.js +1 -0
- package/dist/assets/linear-CXMqTN8N.js +1 -0
- package/dist/assets/mermaid-config-C8a4L22x.js +1 -0
- package/dist/assets/mermaid-parser.core-DREsY2u4.js +4 -0
- package/dist/assets/mermaid.core-8ysLpTJi.js +11 -0
- package/dist/assets/mindmap-definition-QFDTVHPH-CsqUJCMn.js +96 -0
- package/dist/assets/ordinal-D7l-8DAO.js +1 -0
- package/dist/assets/packet-4T2RLAQJ-DidW3JFc.js +1 -0
- package/dist/assets/path-BVpCanzE.js +1 -0
- package/dist/assets/pie-ZZUOXDRM-Bff2e5hg.js +1 -0
- package/dist/assets/pieDiagram-DEJITSTG-k0Br4NDS.js +30 -0
- package/dist/assets/quadrantDiagram-34T5L4WZ-Be9oCSza.js +7 -0
- package/dist/assets/radar-PYXPWWZC-CsdZBH3M.js +1 -0
- package/dist/assets/requirementDiagram-MS252O5E-8ECT7dEs.js +84 -0
- package/dist/assets/rough.esm-BoTisKeL.js +1 -0
- package/dist/assets/sankeyDiagram-XADWPNL6-CoKpeJJ0.js +10 -0
- package/dist/assets/sequenceDiagram-FGHM5R23-BTT2fFxG.js +157 -0
- package/dist/assets/src-CrmkjRpa.js +1 -0
- package/dist/assets/stateDiagram-FHFEXIEX-CIF47NYe.js +1 -0
- package/dist/assets/stateDiagram-v2-QKLJ7IA2-Cy1rmPfG.js +1 -0
- package/dist/assets/timeline-definition-GMOUNBTQ-Bes4B58n.js +120 -0
- package/dist/assets/treeView-SZITEDCU-DPKseaET.js +1 -0
- package/dist/assets/treemap-W4RFUUIX-DH-7GZe_.js +1 -0
- package/dist/assets/vennDiagram-DHZGUBPP-3wx2huKk.js +34 -0
- package/dist/assets/wardley-RL74JXVD-AgyXyBN5.js +1 -0
- package/dist/assets/wardleyDiagram-NUSXRM2D-DzViT1Yx.js +20 -0
- package/dist/assets/xychartDiagram-5P7HB3ND-BO_dbU0r.js +7 -0
- package/{index.html → dist/index.html} +2 -1
- package/dist/index.js +2625 -0
- package/package.json +11 -1
- package/.agents/skills/remotion-best-practices/SKILL.md +0 -61
- package/.agents/skills/remotion-best-practices/rules/3d.md +0 -86
- package/.agents/skills/remotion-best-practices/rules/animations.md +0 -27
- package/.agents/skills/remotion-best-practices/rules/assets/charts-bar-chart.tsx +0 -178
- package/.agents/skills/remotion-best-practices/rules/assets/text-animations-typewriter.tsx +0 -100
- package/.agents/skills/remotion-best-practices/rules/assets/text-animations-word-highlight.tsx +0 -108
- package/.agents/skills/remotion-best-practices/rules/assets.md +0 -78
- package/.agents/skills/remotion-best-practices/rules/audio-visualization.md +0 -198
- package/.agents/skills/remotion-best-practices/rules/audio.md +0 -169
- package/.agents/skills/remotion-best-practices/rules/calculate-metadata.md +0 -134
- package/.agents/skills/remotion-best-practices/rules/can-decode.md +0 -75
- package/.agents/skills/remotion-best-practices/rules/charts.md +0 -120
- package/.agents/skills/remotion-best-practices/rules/compositions.md +0 -154
- package/.agents/skills/remotion-best-practices/rules/display-captions.md +0 -184
- package/.agents/skills/remotion-best-practices/rules/extract-frames.md +0 -229
- package/.agents/skills/remotion-best-practices/rules/ffmpeg.md +0 -38
- package/.agents/skills/remotion-best-practices/rules/fonts.md +0 -152
- package/.agents/skills/remotion-best-practices/rules/get-audio-duration.md +0 -58
- package/.agents/skills/remotion-best-practices/rules/get-video-dimensions.md +0 -68
- package/.agents/skills/remotion-best-practices/rules/get-video-duration.md +0 -60
- package/.agents/skills/remotion-best-practices/rules/gifs.md +0 -141
- package/.agents/skills/remotion-best-practices/rules/images.md +0 -134
- package/.agents/skills/remotion-best-practices/rules/import-srt-captions.md +0 -69
- package/.agents/skills/remotion-best-practices/rules/light-leaks.md +0 -73
- package/.agents/skills/remotion-best-practices/rules/lottie.md +0 -70
- package/.agents/skills/remotion-best-practices/rules/maps.md +0 -412
- package/.agents/skills/remotion-best-practices/rules/measuring-dom-nodes.md +0 -34
- package/.agents/skills/remotion-best-practices/rules/measuring-text.md +0 -140
- package/.agents/skills/remotion-best-practices/rules/parameters.md +0 -109
- package/.agents/skills/remotion-best-practices/rules/sequencing.md +0 -118
- package/.agents/skills/remotion-best-practices/rules/sfx.md +0 -26
- package/.agents/skills/remotion-best-practices/rules/subtitles.md +0 -36
- package/.agents/skills/remotion-best-practices/rules/tailwind.md +0 -11
- package/.agents/skills/remotion-best-practices/rules/text-animations.md +0 -20
- package/.agents/skills/remotion-best-practices/rules/timing.md +0 -179
- package/.agents/skills/remotion-best-practices/rules/transcribe-captions.md +0 -70
- package/.agents/skills/remotion-best-practices/rules/transitions.md +0 -197
- package/.agents/skills/remotion-best-practices/rules/transparent-videos.md +0 -106
- package/.agents/skills/remotion-best-practices/rules/trimming.md +0 -51
- package/.agents/skills/remotion-best-practices/rules/videos.md +0 -171
- package/.agents/skills/remotion-best-practices/rules/voiceover.md +0 -99
- package/.agents/skills/simple/SKILL.md +0 -52
- package/.agents/skills/vercel-react-best-practices/AGENTS.md +0 -3254
- package/.agents/skills/vercel-react-best-practices/README.md +0 -123
- package/.agents/skills/vercel-react-best-practices/SKILL.md +0 -141
- package/.agents/skills/vercel-react-best-practices/rules/advanced-event-handler-refs.md +0 -55
- package/.agents/skills/vercel-react-best-practices/rules/advanced-init-once.md +0 -42
- package/.agents/skills/vercel-react-best-practices/rules/advanced-use-latest.md +0 -39
- package/.agents/skills/vercel-react-best-practices/rules/async-api-routes.md +0 -38
- package/.agents/skills/vercel-react-best-practices/rules/async-defer-await.md +0 -80
- package/.agents/skills/vercel-react-best-practices/rules/async-dependencies.md +0 -51
- package/.agents/skills/vercel-react-best-practices/rules/async-parallel.md +0 -28
- package/.agents/skills/vercel-react-best-practices/rules/async-suspense-boundaries.md +0 -99
- package/.agents/skills/vercel-react-best-practices/rules/bundle-barrel-imports.md +0 -59
- package/.agents/skills/vercel-react-best-practices/rules/bundle-conditional.md +0 -31
- package/.agents/skills/vercel-react-best-practices/rules/bundle-defer-third-party.md +0 -49
- package/.agents/skills/vercel-react-best-practices/rules/bundle-dynamic-imports.md +0 -35
- package/.agents/skills/vercel-react-best-practices/rules/bundle-preload.md +0 -50
- package/.agents/skills/vercel-react-best-practices/rules/client-event-listeners.md +0 -74
- package/.agents/skills/vercel-react-best-practices/rules/client-localstorage-schema.md +0 -71
- package/.agents/skills/vercel-react-best-practices/rules/client-passive-event-listeners.md +0 -48
- package/.agents/skills/vercel-react-best-practices/rules/client-swr-dedup.md +0 -56
- package/.agents/skills/vercel-react-best-practices/rules/js-batch-dom-css.md +0 -107
- package/.agents/skills/vercel-react-best-practices/rules/js-cache-function-results.md +0 -80
- package/.agents/skills/vercel-react-best-practices/rules/js-cache-property-access.md +0 -28
- package/.agents/skills/vercel-react-best-practices/rules/js-cache-storage.md +0 -70
- package/.agents/skills/vercel-react-best-practices/rules/js-combine-iterations.md +0 -32
- package/.agents/skills/vercel-react-best-practices/rules/js-early-exit.md +0 -50
- package/.agents/skills/vercel-react-best-practices/rules/js-flatmap-filter.md +0 -60
- package/.agents/skills/vercel-react-best-practices/rules/js-hoist-regexp.md +0 -45
- package/.agents/skills/vercel-react-best-practices/rules/js-index-maps.md +0 -37
- package/.agents/skills/vercel-react-best-practices/rules/js-length-check-first.md +0 -49
- package/.agents/skills/vercel-react-best-practices/rules/js-min-max-loop.md +0 -82
- package/.agents/skills/vercel-react-best-practices/rules/js-set-map-lookups.md +0 -24
- package/.agents/skills/vercel-react-best-practices/rules/js-tosorted-immutable.md +0 -57
- package/.agents/skills/vercel-react-best-practices/rules/rendering-activity.md +0 -26
- package/.agents/skills/vercel-react-best-practices/rules/rendering-animate-svg-wrapper.md +0 -47
- package/.agents/skills/vercel-react-best-practices/rules/rendering-conditional-render.md +0 -40
- package/.agents/skills/vercel-react-best-practices/rules/rendering-content-visibility.md +0 -38
- package/.agents/skills/vercel-react-best-practices/rules/rendering-hoist-jsx.md +0 -46
- package/.agents/skills/vercel-react-best-practices/rules/rendering-hydration-no-flicker.md +0 -82
- package/.agents/skills/vercel-react-best-practices/rules/rendering-hydration-suppress-warning.md +0 -30
- package/.agents/skills/vercel-react-best-practices/rules/rendering-resource-hints.md +0 -85
- package/.agents/skills/vercel-react-best-practices/rules/rendering-script-defer-async.md +0 -68
- package/.agents/skills/vercel-react-best-practices/rules/rendering-svg-precision.md +0 -28
- package/.agents/skills/vercel-react-best-practices/rules/rendering-usetransition-loading.md +0 -75
- package/.agents/skills/vercel-react-best-practices/rules/rerender-defer-reads.md +0 -39
- package/.agents/skills/vercel-react-best-practices/rules/rerender-dependencies.md +0 -45
- package/.agents/skills/vercel-react-best-practices/rules/rerender-derived-state-no-effect.md +0 -40
- package/.agents/skills/vercel-react-best-practices/rules/rerender-derived-state.md +0 -29
- package/.agents/skills/vercel-react-best-practices/rules/rerender-functional-setstate.md +0 -74
- package/.agents/skills/vercel-react-best-practices/rules/rerender-lazy-state-init.md +0 -58
- package/.agents/skills/vercel-react-best-practices/rules/rerender-memo-with-default-value.md +0 -38
- package/.agents/skills/vercel-react-best-practices/rules/rerender-memo.md +0 -44
- package/.agents/skills/vercel-react-best-practices/rules/rerender-move-effect-to-event.md +0 -45
- package/.agents/skills/vercel-react-best-practices/rules/rerender-no-inline-components.md +0 -82
- package/.agents/skills/vercel-react-best-practices/rules/rerender-simple-expression-in-memo.md +0 -35
- package/.agents/skills/vercel-react-best-practices/rules/rerender-transitions.md +0 -40
- package/.agents/skills/vercel-react-best-practices/rules/rerender-use-ref-transient-values.md +0 -73
- package/.agents/skills/vercel-react-best-practices/rules/server-after-nonblocking.md +0 -73
- package/.agents/skills/vercel-react-best-practices/rules/server-auth-actions.md +0 -96
- package/.agents/skills/vercel-react-best-practices/rules/server-cache-lru.md +0 -41
- package/.agents/skills/vercel-react-best-practices/rules/server-cache-react.md +0 -76
- package/.agents/skills/vercel-react-best-practices/rules/server-dedup-props.md +0 -65
- package/.agents/skills/vercel-react-best-practices/rules/server-hoist-static-io.md +0 -142
- package/.agents/skills/vercel-react-best-practices/rules/server-parallel-fetching.md +0 -83
- package/.agents/skills/vercel-react-best-practices/rules/server-serialization.md +0 -38
- package/.claude/CLAUDE.md +0 -184
- package/.claude/commands/review.md +0 -120
- package/.claude/commands/sync-docs.md +0 -71
- package/.claude/roadmap.md +0 -121
- package/.claude/rules/style-guide.md +0 -830
- package/.claude/settings.json +0 -18
- package/.claude/user-stories.md +0 -333
- package/AGENTS.md +0 -68
- package/Makefile +0 -32
- package/biome.json +0 -79
- package/bun.lock +0 -854
- package/bunfig.toml +0 -2
- package/docs/design.md +0 -563
- package/docs/perf-baseline.md +0 -130
- package/docs/plans/2026-03-13-client-mode-design.md +0 -86
- package/docs/plans/2026-03-13-client-mode-plan.md +0 -605
- package/docs/plans/2026-03-13-keyboard-shortcuts-design.md +0 -129
- package/docs/plans/2026-03-13-keyboard-shortcuts-plan.md +0 -1471
- package/docs/plans/2026-03-13-multi-document-design.md +0 -183
- package/docs/plans/2026-03-13-performance-benchmarks-design.md +0 -121
- package/docs/superpowers/plans/2026-03-26-surgical-pruning.md +0 -1176
- package/docs/superpowers/specs/2026-03-27-go-server-rewrite-design.md +0 -284
- package/e2e/comments.spec.ts +0 -81
- package/e2e/document-load.spec.ts +0 -32
- package/e2e/export.spec.ts +0 -58
- package/e2e/fixtures/sample.md +0 -7
- package/e2e/perf/add-comment.spec.ts +0 -116
- package/e2e/perf/fixtures/generate.ts +0 -327
- package/e2e/perf/initial-load.spec.ts +0 -49
- package/e2e/perf/perf.setup.ts +0 -23
- package/e2e/perf/perf.teardown.ts +0 -9
- package/e2e/perf/screenshot-final.png +0 -0
- package/e2e/perf/scroll.spec.ts +0 -39
- package/e2e/perf/tab-switch.spec.ts +0 -69
- package/e2e/perf/text-selection.spec.ts +0 -119
- package/e2e/perf/utils/metrics.ts +0 -350
- package/e2e/perf/utils/perf-cli.ts +0 -86
- package/e2e/persistence-file.spec.ts +0 -357
- package/e2e/utils/cli.ts +0 -84
- package/e2e/utils/selection.ts +0 -79
- package/go/cmd/readit/main.go +0 -416
- package/go/go.mod +0 -20
- package/go/go.sum +0 -41
- package/go/internal/server/anchor.go +0 -302
- package/go/internal/server/anchor_test.go +0 -111
- package/go/internal/server/comments.go +0 -390
- package/go/internal/server/documents.go +0 -113
- package/go/internal/server/embed.go +0 -17
- package/go/internal/server/headings.go +0 -33
- package/go/internal/server/headings_test.go +0 -75
- package/go/internal/server/htmltext.go +0 -123
- package/go/internal/server/markdown.go +0 -157
- package/go/internal/server/markdown_bench_test.go +0 -42
- package/go/internal/server/markdown_test.go +0 -79
- package/go/internal/server/server.go +0 -453
- package/go/internal/server/server_bench_test.go +0 -122
- package/go/internal/server/settings.go +0 -110
- package/go/internal/server/sse.go +0 -140
- package/go/internal/server/storage.go +0 -275
- package/go/internal/server/storage_test.go +0 -152
- package/go/internal/server/template.go +0 -66
- package/go/internal/server/types.go +0 -101
- package/go/internal/server/watcher.go +0 -74
- package/lefthook.yml +0 -8
- package/nvim-readit/lua/readit/health.lua +0 -64
- package/nvim-readit/lua/readit/init.lua +0 -463
- package/nvim-readit/plugin/readit.lua +0 -19
- package/playwright.config.ts +0 -34
- package/skills-lock.json +0 -20
- package/src/App.svelte +0 -890
- package/src/cli.ts +0 -881
- package/src/components/ActionsMenu.svelte +0 -95
- package/src/components/CommentBadge.svelte +0 -67
- package/src/components/CommentErrorBanner.svelte +0 -33
- package/src/components/CommentInput.svelte +0 -75
- package/src/components/CommentListItem.svelte +0 -95
- package/src/components/CommentManager.svelte +0 -129
- package/src/components/CommentNav.svelte +0 -109
- package/src/components/DocumentViewer.svelte +0 -233
- package/src/components/FloatingComment.svelte +0 -107
- package/src/components/Header.svelte +0 -76
- package/src/components/InlineEditor.svelte +0 -72
- package/src/components/MarginNote.svelte +0 -167
- package/src/components/MarginNotesContainer.svelte +0 -33
- package/src/components/MermaidEnhancer.svelte +0 -218
- package/src/components/MermaidModal.svelte +0 -67
- package/src/components/RawModal.svelte +0 -126
- package/src/components/ReanchorConfirm.svelte +0 -30
- package/src/components/SettingsModal.svelte +0 -220
- package/src/components/ShortcutCapture.svelte +0 -82
- package/src/components/ShortcutList.svelte +0 -145
- package/src/components/TabBar.svelte +0 -52
- package/src/components/TableOfContents.svelte +0 -125
- package/src/components/ui/ActionLink.svelte +0 -40
- package/src/components/ui/Button.svelte +0 -53
- package/src/components/ui/Dialog.svelte +0 -97
- package/src/components/ui/DropdownMenu.svelte +0 -85
- package/src/components/ui/DropdownMenuItem.svelte +0 -38
- package/src/components/ui/DropdownMenuSeparator.svelte +0 -11
- package/src/components/ui/Text.svelte +0 -42
- package/src/env.d.ts +0 -6
- package/src/index.css +0 -859
- package/src/lib/__fixtures__/bench-data.ts +0 -114
- package/src/lib/anchor.bench.ts +0 -91
- package/src/lib/anchor.test.ts +0 -527
- package/src/lib/anchor.ts +0 -381
- package/src/lib/comment-storage.bench.ts +0 -49
- package/src/lib/comment-storage.test.ts +0 -694
- package/src/lib/comment-storage.ts +0 -226
- package/src/lib/export.bench.ts +0 -21
- package/src/lib/export.ts +0 -36
- package/src/lib/fetch-or-throw.test.ts +0 -59
- package/src/lib/fetch-or-throw.ts +0 -12
- package/src/lib/headings.test.ts +0 -103
- package/src/lib/headings.ts +0 -44
- package/src/lib/highlight/core.test.ts +0 -93
- package/src/lib/highlight/dom.ts +0 -187
- package/src/lib/highlight/highlight-registry.ts +0 -221
- package/src/lib/highlight/highlight.bench.ts +0 -92
- package/src/lib/highlight/highlighter.ts +0 -247
- package/src/lib/highlight/resolver.ts +0 -38
- package/src/lib/highlight/types.ts +0 -17
- package/src/lib/html-text.test.ts +0 -162
- package/src/lib/html-text.ts +0 -161
- package/src/lib/i18n/en.ts +0 -124
- package/src/lib/i18n/index.ts +0 -3
- package/src/lib/i18n/ja.ts +0 -126
- package/src/lib/i18n/translations.ts +0 -27
- package/src/lib/i18n/types.ts +0 -130
- package/src/lib/key-lock.test.ts +0 -104
- package/src/lib/key-lock.ts +0 -23
- package/src/lib/margin-layout.bench.ts +0 -61
- package/src/lib/margin-layout.ts +0 -71
- package/src/lib/markdown-renderer.test.ts +0 -154
- package/src/lib/markdown-renderer.ts +0 -178
- package/src/lib/mermaid-config.ts +0 -38
- package/src/lib/mermaid-renderer.ts +0 -162
- package/src/lib/mermaid-worker.ts +0 -60
- package/src/lib/positions.ts +0 -157
- package/src/lib/shortcut-registry.ts +0 -244
- package/src/lib/utils.ts +0 -15
- package/src/main.ts +0 -16
- package/src/schema.ts +0 -92
- package/src/server.ts +0 -1216
- package/src/stores/app.svelte.ts +0 -231
- package/src/stores/locale.svelte.ts +0 -46
- package/src/stores/settings.svelte.ts +0 -90
- package/src/stores/shortcuts.svelte.ts +0 -104
- package/src/stores/ui.svelte.ts +0 -12
- package/src/template.ts +0 -104
- package/src/test-setup.ts +0 -48
- package/svelte.config.js +0 -5
- package/test.md +0 -74
- package/tsconfig.cli.json +0 -12
- package/tsconfig.json +0 -20
- package/vite.config.ts +0 -47
- package/vitest.config.ts +0 -15
- package/vscode-readit/.mcp.json +0 -7
- package/vscode-readit/.vscodeignore +0 -7
- package/vscode-readit/bun.lock +0 -78
- package/vscode-readit/icon.svg +0 -10
- package/vscode-readit/package.json +0 -110
- package/vscode-readit/src/extension.ts +0 -117
- package/vscode-readit/src/server-manager.ts +0 -272
- package/vscode-readit/src/webview-provider.ts +0 -204
- package/vscode-readit/tsconfig.json +0 -20
|
@@ -1,46 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Hoist Static JSX Elements
|
|
3
|
-
impact: LOW
|
|
4
|
-
impactDescription: avoids re-creation
|
|
5
|
-
tags: rendering, jsx, static, optimization
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
## Hoist Static JSX Elements
|
|
9
|
-
|
|
10
|
-
Extract static JSX outside components to avoid re-creation.
|
|
11
|
-
|
|
12
|
-
**Incorrect (recreates element every render):**
|
|
13
|
-
|
|
14
|
-
```tsx
|
|
15
|
-
function LoadingSkeleton() {
|
|
16
|
-
return <div className="animate-pulse h-20 bg-gray-200" />
|
|
17
|
-
}
|
|
18
|
-
|
|
19
|
-
function Container() {
|
|
20
|
-
return (
|
|
21
|
-
<div>
|
|
22
|
-
{loading && <LoadingSkeleton />}
|
|
23
|
-
</div>
|
|
24
|
-
)
|
|
25
|
-
}
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
**Correct (reuses same element):**
|
|
29
|
-
|
|
30
|
-
```tsx
|
|
31
|
-
const loadingSkeleton = (
|
|
32
|
-
<div className="animate-pulse h-20 bg-gray-200" />
|
|
33
|
-
)
|
|
34
|
-
|
|
35
|
-
function Container() {
|
|
36
|
-
return (
|
|
37
|
-
<div>
|
|
38
|
-
{loading && loadingSkeleton}
|
|
39
|
-
</div>
|
|
40
|
-
)
|
|
41
|
-
}
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
This is especially helpful for large and static SVG nodes, which can be expensive to recreate on every render.
|
|
45
|
-
|
|
46
|
-
**Note:** If your project has [React Compiler](https://react.dev/learn/react-compiler) enabled, the compiler automatically hoists static JSX elements and optimizes component re-renders, making manual hoisting unnecessary.
|
|
@@ -1,82 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Prevent Hydration Mismatch Without Flickering
|
|
3
|
-
impact: MEDIUM
|
|
4
|
-
impactDescription: avoids visual flicker and hydration errors
|
|
5
|
-
tags: rendering, ssr, hydration, localStorage, flicker
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
## Prevent Hydration Mismatch Without Flickering
|
|
9
|
-
|
|
10
|
-
When rendering content that depends on client-side storage (localStorage, cookies), avoid both SSR breakage and post-hydration flickering by injecting a synchronous script that updates the DOM before React hydrates.
|
|
11
|
-
|
|
12
|
-
**Incorrect (breaks SSR):**
|
|
13
|
-
|
|
14
|
-
```tsx
|
|
15
|
-
function ThemeWrapper({ children }: { children: ReactNode }) {
|
|
16
|
-
// localStorage is not available on server - throws error
|
|
17
|
-
const theme = localStorage.getItem('theme') || 'light'
|
|
18
|
-
|
|
19
|
-
return (
|
|
20
|
-
<div className={theme}>
|
|
21
|
-
{children}
|
|
22
|
-
</div>
|
|
23
|
-
)
|
|
24
|
-
}
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
Server-side rendering will fail because `localStorage` is undefined.
|
|
28
|
-
|
|
29
|
-
**Incorrect (visual flickering):**
|
|
30
|
-
|
|
31
|
-
```tsx
|
|
32
|
-
function ThemeWrapper({ children }: { children: ReactNode }) {
|
|
33
|
-
const [theme, setTheme] = useState('light')
|
|
34
|
-
|
|
35
|
-
useEffect(() => {
|
|
36
|
-
// Runs after hydration - causes visible flash
|
|
37
|
-
const stored = localStorage.getItem('theme')
|
|
38
|
-
if (stored) {
|
|
39
|
-
setTheme(stored)
|
|
40
|
-
}
|
|
41
|
-
}, [])
|
|
42
|
-
|
|
43
|
-
return (
|
|
44
|
-
<div className={theme}>
|
|
45
|
-
{children}
|
|
46
|
-
</div>
|
|
47
|
-
)
|
|
48
|
-
}
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
Component first renders with default value (`light`), then updates after hydration, causing a visible flash of incorrect content.
|
|
52
|
-
|
|
53
|
-
**Correct (no flicker, no hydration mismatch):**
|
|
54
|
-
|
|
55
|
-
```tsx
|
|
56
|
-
function ThemeWrapper({ children }: { children: ReactNode }) {
|
|
57
|
-
return (
|
|
58
|
-
<>
|
|
59
|
-
<div id="theme-wrapper">
|
|
60
|
-
{children}
|
|
61
|
-
</div>
|
|
62
|
-
<script
|
|
63
|
-
dangerouslySetInnerHTML={{
|
|
64
|
-
__html: `
|
|
65
|
-
(function() {
|
|
66
|
-
try {
|
|
67
|
-
var theme = localStorage.getItem('theme') || 'light';
|
|
68
|
-
var el = document.getElementById('theme-wrapper');
|
|
69
|
-
if (el) el.className = theme;
|
|
70
|
-
} catch (e) {}
|
|
71
|
-
})();
|
|
72
|
-
`,
|
|
73
|
-
}}
|
|
74
|
-
/>
|
|
75
|
-
</>
|
|
76
|
-
)
|
|
77
|
-
}
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
The inline script executes synchronously before showing the element, ensuring the DOM already has the correct value. No flickering, no hydration mismatch.
|
|
81
|
-
|
|
82
|
-
This pattern is especially useful for theme toggles, user preferences, authentication states, and any client-only data that should render immediately without flashing default values.
|
package/.agents/skills/vercel-react-best-practices/rules/rendering-hydration-suppress-warning.md
DELETED
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Suppress Expected Hydration Mismatches
|
|
3
|
-
impact: LOW-MEDIUM
|
|
4
|
-
impactDescription: avoids noisy hydration warnings for known differences
|
|
5
|
-
tags: rendering, hydration, ssr, nextjs
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
## Suppress Expected Hydration Mismatches
|
|
9
|
-
|
|
10
|
-
In SSR frameworks (e.g., Next.js), some values are intentionally different on server vs client (random IDs, dates, locale/timezone formatting). For these *expected* mismatches, wrap the dynamic text in an element with `suppressHydrationWarning` to prevent noisy warnings. Do not use this to hide real bugs. Don’t overuse it.
|
|
11
|
-
|
|
12
|
-
**Incorrect (known mismatch warnings):**
|
|
13
|
-
|
|
14
|
-
```tsx
|
|
15
|
-
function Timestamp() {
|
|
16
|
-
return <span>{new Date().toLocaleString()}</span>
|
|
17
|
-
}
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
**Correct (suppress expected mismatch only):**
|
|
21
|
-
|
|
22
|
-
```tsx
|
|
23
|
-
function Timestamp() {
|
|
24
|
-
return (
|
|
25
|
-
<span suppressHydrationWarning>
|
|
26
|
-
{new Date().toLocaleString()}
|
|
27
|
-
</span>
|
|
28
|
-
)
|
|
29
|
-
}
|
|
30
|
-
```
|
|
@@ -1,85 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Use React DOM Resource Hints
|
|
3
|
-
impact: HIGH
|
|
4
|
-
impactDescription: reduces load time for critical resources
|
|
5
|
-
tags: rendering, preload, preconnect, prefetch, resource-hints
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
## Use React DOM Resource Hints
|
|
9
|
-
|
|
10
|
-
**Impact: HIGH (reduces load time for critical resources)**
|
|
11
|
-
|
|
12
|
-
React DOM provides APIs to hint the browser about resources it will need. These are especially useful in server components to start loading resources before the client even receives the HTML.
|
|
13
|
-
|
|
14
|
-
- **`prefetchDNS(href)`**: Resolve DNS for a domain you expect to connect to
|
|
15
|
-
- **`preconnect(href)`**: Establish connection (DNS + TCP + TLS) to a server
|
|
16
|
-
- **`preload(href, options)`**: Fetch a resource (stylesheet, font, script, image) you'll use soon
|
|
17
|
-
- **`preloadModule(href)`**: Fetch an ES module you'll use soon
|
|
18
|
-
- **`preinit(href, options)`**: Fetch and evaluate a stylesheet or script
|
|
19
|
-
- **`preinitModule(href)`**: Fetch and evaluate an ES module
|
|
20
|
-
|
|
21
|
-
**Example (preconnect to third-party APIs):**
|
|
22
|
-
|
|
23
|
-
```tsx
|
|
24
|
-
import { preconnect, prefetchDNS } from 'react-dom'
|
|
25
|
-
|
|
26
|
-
export default function App() {
|
|
27
|
-
prefetchDNS('https://analytics.example.com')
|
|
28
|
-
preconnect('https://api.example.com')
|
|
29
|
-
|
|
30
|
-
return <main>{/* content */}</main>
|
|
31
|
-
}
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
**Example (preload critical fonts and styles):**
|
|
35
|
-
|
|
36
|
-
```tsx
|
|
37
|
-
import { preload, preinit } from 'react-dom'
|
|
38
|
-
|
|
39
|
-
export default function RootLayout({ children }) {
|
|
40
|
-
// Preload font file
|
|
41
|
-
preload('/fonts/inter.woff2', { as: 'font', type: 'font/woff2', crossOrigin: 'anonymous' })
|
|
42
|
-
|
|
43
|
-
// Fetch and apply critical stylesheet immediately
|
|
44
|
-
preinit('/styles/critical.css', { as: 'style' })
|
|
45
|
-
|
|
46
|
-
return (
|
|
47
|
-
<html>
|
|
48
|
-
<body>{children}</body>
|
|
49
|
-
</html>
|
|
50
|
-
)
|
|
51
|
-
}
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
**Example (preload modules for code-split routes):**
|
|
55
|
-
|
|
56
|
-
```tsx
|
|
57
|
-
import { preloadModule, preinitModule } from 'react-dom'
|
|
58
|
-
|
|
59
|
-
function Navigation() {
|
|
60
|
-
const preloadDashboard = () => {
|
|
61
|
-
preloadModule('/dashboard.js', { as: 'script' })
|
|
62
|
-
}
|
|
63
|
-
|
|
64
|
-
return (
|
|
65
|
-
<nav>
|
|
66
|
-
<a href="/dashboard" onMouseEnter={preloadDashboard}>
|
|
67
|
-
Dashboard
|
|
68
|
-
</a>
|
|
69
|
-
</nav>
|
|
70
|
-
)
|
|
71
|
-
}
|
|
72
|
-
```
|
|
73
|
-
|
|
74
|
-
**When to use each:**
|
|
75
|
-
|
|
76
|
-
| API | Use case |
|
|
77
|
-
|-----|----------|
|
|
78
|
-
| `prefetchDNS` | Third-party domains you'll connect to later |
|
|
79
|
-
| `preconnect` | APIs or CDNs you'll fetch from immediately |
|
|
80
|
-
| `preload` | Critical resources needed for current page |
|
|
81
|
-
| `preloadModule` | JS modules for likely next navigation |
|
|
82
|
-
| `preinit` | Stylesheets/scripts that must execute early |
|
|
83
|
-
| `preinitModule` | ES modules that must execute early |
|
|
84
|
-
|
|
85
|
-
Reference: [React DOM Resource Preloading APIs](https://react.dev/reference/react-dom#resource-preloading-apis)
|
|
@@ -1,68 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Use defer or async on Script Tags
|
|
3
|
-
impact: HIGH
|
|
4
|
-
impactDescription: eliminates render-blocking
|
|
5
|
-
tags: rendering, script, defer, async, performance
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
## Use defer or async on Script Tags
|
|
9
|
-
|
|
10
|
-
**Impact: HIGH (eliminates render-blocking)**
|
|
11
|
-
|
|
12
|
-
Script tags without `defer` or `async` block HTML parsing while the script downloads and executes. This delays First Contentful Paint and Time to Interactive.
|
|
13
|
-
|
|
14
|
-
- **`defer`**: Downloads in parallel, executes after HTML parsing completes, maintains execution order
|
|
15
|
-
- **`async`**: Downloads in parallel, executes immediately when ready, no guaranteed order
|
|
16
|
-
|
|
17
|
-
Use `defer` for scripts that depend on DOM or other scripts. Use `async` for independent scripts like analytics.
|
|
18
|
-
|
|
19
|
-
**Incorrect (blocks rendering):**
|
|
20
|
-
|
|
21
|
-
```tsx
|
|
22
|
-
export default function Document() {
|
|
23
|
-
return (
|
|
24
|
-
<html>
|
|
25
|
-
<head>
|
|
26
|
-
<script src="https://example.com/analytics.js" />
|
|
27
|
-
<script src="/scripts/utils.js" />
|
|
28
|
-
</head>
|
|
29
|
-
<body>{/* content */}</body>
|
|
30
|
-
</html>
|
|
31
|
-
)
|
|
32
|
-
}
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
**Correct (non-blocking):**
|
|
36
|
-
|
|
37
|
-
```tsx
|
|
38
|
-
export default function Document() {
|
|
39
|
-
return (
|
|
40
|
-
<html>
|
|
41
|
-
<head>
|
|
42
|
-
{/* Independent script - use async */}
|
|
43
|
-
<script src="https://example.com/analytics.js" async />
|
|
44
|
-
{/* DOM-dependent script - use defer */}
|
|
45
|
-
<script src="/scripts/utils.js" defer />
|
|
46
|
-
</head>
|
|
47
|
-
<body>{/* content */}</body>
|
|
48
|
-
</html>
|
|
49
|
-
)
|
|
50
|
-
}
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
**Note:** In Next.js, prefer the `next/script` component with `strategy` prop instead of raw script tags:
|
|
54
|
-
|
|
55
|
-
```tsx
|
|
56
|
-
import Script from 'next/script'
|
|
57
|
-
|
|
58
|
-
export default function Page() {
|
|
59
|
-
return (
|
|
60
|
-
<>
|
|
61
|
-
<Script src="https://example.com/analytics.js" strategy="afterInteractive" />
|
|
62
|
-
<Script src="/scripts/utils.js" strategy="beforeInteractive" />
|
|
63
|
-
</>
|
|
64
|
-
)
|
|
65
|
-
}
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
Reference: [MDN - Script element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script#defer)
|
|
@@ -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
|
-
```
|
package/.agents/skills/vercel-react-best-practices/rules/rerender-derived-state-no-effect.md
DELETED
|
@@ -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.
|