@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,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.
|
package/.agents/skills/vercel-react-best-practices/rules/rerender-memo-with-default-value.md
DELETED
|
@@ -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,82 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Don't Define Components Inside Components
|
|
3
|
-
impact: HIGH
|
|
4
|
-
impactDescription: prevents remount on every render
|
|
5
|
-
tags: rerender, components, remount, performance
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
## Don't Define Components Inside Components
|
|
9
|
-
|
|
10
|
-
**Impact: HIGH (prevents remount on every render)**
|
|
11
|
-
|
|
12
|
-
Defining a component inside another component creates a new component type on every render. React sees a different component each time and fully remounts it, destroying all state and DOM.
|
|
13
|
-
|
|
14
|
-
A common reason developers do this is to access parent variables without passing props. Always pass props instead.
|
|
15
|
-
|
|
16
|
-
**Incorrect (remounts on every render):**
|
|
17
|
-
|
|
18
|
-
```tsx
|
|
19
|
-
function UserProfile({ user, theme }) {
|
|
20
|
-
// Defined inside to access `theme` - BAD
|
|
21
|
-
const Avatar = () => (
|
|
22
|
-
<img
|
|
23
|
-
src={user.avatarUrl}
|
|
24
|
-
className={theme === 'dark' ? 'avatar-dark' : 'avatar-light'}
|
|
25
|
-
/>
|
|
26
|
-
)
|
|
27
|
-
|
|
28
|
-
// Defined inside to access `user` - BAD
|
|
29
|
-
const Stats = () => (
|
|
30
|
-
<div>
|
|
31
|
-
<span>{user.followers} followers</span>
|
|
32
|
-
<span>{user.posts} posts</span>
|
|
33
|
-
</div>
|
|
34
|
-
)
|
|
35
|
-
|
|
36
|
-
return (
|
|
37
|
-
<div>
|
|
38
|
-
<Avatar />
|
|
39
|
-
<Stats />
|
|
40
|
-
</div>
|
|
41
|
-
)
|
|
42
|
-
}
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
Every time `UserProfile` renders, `Avatar` and `Stats` are new component types. React unmounts the old instances and mounts new ones, losing any internal state, running effects again, and recreating DOM nodes.
|
|
46
|
-
|
|
47
|
-
**Correct (pass props instead):**
|
|
48
|
-
|
|
49
|
-
```tsx
|
|
50
|
-
function Avatar({ src, theme }: { src: string; theme: string }) {
|
|
51
|
-
return (
|
|
52
|
-
<img
|
|
53
|
-
src={src}
|
|
54
|
-
className={theme === 'dark' ? 'avatar-dark' : 'avatar-light'}
|
|
55
|
-
/>
|
|
56
|
-
)
|
|
57
|
-
}
|
|
58
|
-
|
|
59
|
-
function Stats({ followers, posts }: { followers: number; posts: number }) {
|
|
60
|
-
return (
|
|
61
|
-
<div>
|
|
62
|
-
<span>{followers} followers</span>
|
|
63
|
-
<span>{posts} posts</span>
|
|
64
|
-
</div>
|
|
65
|
-
)
|
|
66
|
-
}
|
|
67
|
-
|
|
68
|
-
function UserProfile({ user, theme }) {
|
|
69
|
-
return (
|
|
70
|
-
<div>
|
|
71
|
-
<Avatar src={user.avatarUrl} theme={theme} />
|
|
72
|
-
<Stats followers={user.followers} posts={user.posts} />
|
|
73
|
-
</div>
|
|
74
|
-
)
|
|
75
|
-
}
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
**Symptoms of this bug:**
|
|
79
|
-
- Input fields lose focus on every keystroke
|
|
80
|
-
- Animations restart unexpectedly
|
|
81
|
-
- `useEffect` cleanup/setup runs on every parent render
|
|
82
|
-
- Scroll position resets inside the component
|
package/.agents/skills/vercel-react-best-practices/rules/rerender-simple-expression-in-memo.md
DELETED
|
@@ -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
|
-
```
|
package/.agents/skills/vercel-react-best-practices/rules/rerender-use-ref-transient-values.md
DELETED
|
@@ -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
|
-
```
|
|
@@ -1,73 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Use after() for Non-Blocking Operations
|
|
3
|
-
impact: MEDIUM
|
|
4
|
-
impactDescription: faster response times
|
|
5
|
-
tags: server, async, logging, analytics, side-effects
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
## Use after() for Non-Blocking Operations
|
|
9
|
-
|
|
10
|
-
Use Next.js's `after()` to schedule work that should execute after a response is sent. This prevents logging, analytics, and other side effects from blocking the response.
|
|
11
|
-
|
|
12
|
-
**Incorrect (blocks response):**
|
|
13
|
-
|
|
14
|
-
```tsx
|
|
15
|
-
import { logUserAction } from '@/app/utils'
|
|
16
|
-
|
|
17
|
-
export async function POST(request: Request) {
|
|
18
|
-
// Perform mutation
|
|
19
|
-
await updateDatabase(request)
|
|
20
|
-
|
|
21
|
-
// Logging blocks the response
|
|
22
|
-
const userAgent = request.headers.get('user-agent') || 'unknown'
|
|
23
|
-
await logUserAction({ userAgent })
|
|
24
|
-
|
|
25
|
-
return new Response(JSON.stringify({ status: 'success' }), {
|
|
26
|
-
status: 200,
|
|
27
|
-
headers: { 'Content-Type': 'application/json' }
|
|
28
|
-
})
|
|
29
|
-
}
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
**Correct (non-blocking):**
|
|
33
|
-
|
|
34
|
-
```tsx
|
|
35
|
-
import { after } from 'next/server'
|
|
36
|
-
import { headers, cookies } from 'next/headers'
|
|
37
|
-
import { logUserAction } from '@/app/utils'
|
|
38
|
-
|
|
39
|
-
export async function POST(request: Request) {
|
|
40
|
-
// Perform mutation
|
|
41
|
-
await updateDatabase(request)
|
|
42
|
-
|
|
43
|
-
// Log after response is sent
|
|
44
|
-
after(async () => {
|
|
45
|
-
const userAgent = (await headers()).get('user-agent') || 'unknown'
|
|
46
|
-
const sessionCookie = (await cookies()).get('session-id')?.value || 'anonymous'
|
|
47
|
-
|
|
48
|
-
logUserAction({ sessionCookie, userAgent })
|
|
49
|
-
})
|
|
50
|
-
|
|
51
|
-
return new Response(JSON.stringify({ status: 'success' }), {
|
|
52
|
-
status: 200,
|
|
53
|
-
headers: { 'Content-Type': 'application/json' }
|
|
54
|
-
})
|
|
55
|
-
}
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
The response is sent immediately while logging happens in the background.
|
|
59
|
-
|
|
60
|
-
**Common use cases:**
|
|
61
|
-
|
|
62
|
-
- Analytics tracking
|
|
63
|
-
- Audit logging
|
|
64
|
-
- Sending notifications
|
|
65
|
-
- Cache invalidation
|
|
66
|
-
- Cleanup tasks
|
|
67
|
-
|
|
68
|
-
**Important notes:**
|
|
69
|
-
|
|
70
|
-
- `after()` runs even if the response fails or redirects
|
|
71
|
-
- Works in Server Actions, Route Handlers, and Server Components
|
|
72
|
-
|
|
73
|
-
Reference: [https://nextjs.org/docs/app/api-reference/functions/after](https://nextjs.org/docs/app/api-reference/functions/after)
|
|
@@ -1,96 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Authenticate Server Actions Like API Routes
|
|
3
|
-
impact: CRITICAL
|
|
4
|
-
impactDescription: prevents unauthorized access to server mutations
|
|
5
|
-
tags: server, server-actions, authentication, security, authorization
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
## Authenticate Server Actions Like API Routes
|
|
9
|
-
|
|
10
|
-
**Impact: CRITICAL (prevents unauthorized access to server mutations)**
|
|
11
|
-
|
|
12
|
-
Server Actions (functions with `"use server"`) are exposed as public endpoints, just like API routes. Always verify authentication and authorization **inside** each Server Action—do not rely solely on middleware, layout guards, or page-level checks, as Server Actions can be invoked directly.
|
|
13
|
-
|
|
14
|
-
Next.js documentation explicitly states: "Treat Server Actions with the same security considerations as public-facing API endpoints, and verify if the user is allowed to perform a mutation."
|
|
15
|
-
|
|
16
|
-
**Incorrect (no authentication check):**
|
|
17
|
-
|
|
18
|
-
```typescript
|
|
19
|
-
'use server'
|
|
20
|
-
|
|
21
|
-
export async function deleteUser(userId: string) {
|
|
22
|
-
// Anyone can call this! No auth check
|
|
23
|
-
await db.user.delete({ where: { id: userId } })
|
|
24
|
-
return { success: true }
|
|
25
|
-
}
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
**Correct (authentication inside the action):**
|
|
29
|
-
|
|
30
|
-
```typescript
|
|
31
|
-
'use server'
|
|
32
|
-
|
|
33
|
-
import { verifySession } from '@/lib/auth'
|
|
34
|
-
import { unauthorized } from '@/lib/errors'
|
|
35
|
-
|
|
36
|
-
export async function deleteUser(userId: string) {
|
|
37
|
-
// Always check auth inside the action
|
|
38
|
-
const session = await verifySession()
|
|
39
|
-
|
|
40
|
-
if (!session) {
|
|
41
|
-
throw unauthorized('Must be logged in')
|
|
42
|
-
}
|
|
43
|
-
|
|
44
|
-
// Check authorization too
|
|
45
|
-
if (session.user.role !== 'admin' && session.user.id !== userId) {
|
|
46
|
-
throw unauthorized('Cannot delete other users')
|
|
47
|
-
}
|
|
48
|
-
|
|
49
|
-
await db.user.delete({ where: { id: userId } })
|
|
50
|
-
return { success: true }
|
|
51
|
-
}
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
**With input validation:**
|
|
55
|
-
|
|
56
|
-
```typescript
|
|
57
|
-
'use server'
|
|
58
|
-
|
|
59
|
-
import { verifySession } from '@/lib/auth'
|
|
60
|
-
import { z } from 'zod'
|
|
61
|
-
|
|
62
|
-
const updateProfileSchema = z.object({
|
|
63
|
-
userId: z.string().uuid(),
|
|
64
|
-
name: z.string().min(1).max(100),
|
|
65
|
-
email: z.string().email()
|
|
66
|
-
})
|
|
67
|
-
|
|
68
|
-
export async function updateProfile(data: unknown) {
|
|
69
|
-
// Validate input first
|
|
70
|
-
const validated = updateProfileSchema.parse(data)
|
|
71
|
-
|
|
72
|
-
// Then authenticate
|
|
73
|
-
const session = await verifySession()
|
|
74
|
-
if (!session) {
|
|
75
|
-
throw new Error('Unauthorized')
|
|
76
|
-
}
|
|
77
|
-
|
|
78
|
-
// Then authorize
|
|
79
|
-
if (session.user.id !== validated.userId) {
|
|
80
|
-
throw new Error('Can only update own profile')
|
|
81
|
-
}
|
|
82
|
-
|
|
83
|
-
// Finally perform the mutation
|
|
84
|
-
await db.user.update({
|
|
85
|
-
where: { id: validated.userId },
|
|
86
|
-
data: {
|
|
87
|
-
name: validated.name,
|
|
88
|
-
email: validated.email
|
|
89
|
-
}
|
|
90
|
-
})
|
|
91
|
-
|
|
92
|
-
return { success: true }
|
|
93
|
-
}
|
|
94
|
-
```
|
|
95
|
-
|
|
96
|
-
Reference: [https://nextjs.org/docs/app/guides/authentication](https://nextjs.org/docs/app/guides/authentication)
|
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Cross-Request LRU Caching
|
|
3
|
-
impact: HIGH
|
|
4
|
-
impactDescription: caches across requests
|
|
5
|
-
tags: server, cache, lru, cross-request
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
## Cross-Request LRU Caching
|
|
9
|
-
|
|
10
|
-
`React.cache()` only works within one request. For data shared across sequential requests (user clicks button A then button B), use an LRU cache.
|
|
11
|
-
|
|
12
|
-
**Implementation:**
|
|
13
|
-
|
|
14
|
-
```typescript
|
|
15
|
-
import { LRUCache } from 'lru-cache'
|
|
16
|
-
|
|
17
|
-
const cache = new LRUCache<string, any>({
|
|
18
|
-
max: 1000,
|
|
19
|
-
ttl: 5 * 60 * 1000 // 5 minutes
|
|
20
|
-
})
|
|
21
|
-
|
|
22
|
-
export async function getUser(id: string) {
|
|
23
|
-
const cached = cache.get(id)
|
|
24
|
-
if (cached) return cached
|
|
25
|
-
|
|
26
|
-
const user = await db.user.findUnique({ where: { id } })
|
|
27
|
-
cache.set(id, user)
|
|
28
|
-
return user
|
|
29
|
-
}
|
|
30
|
-
|
|
31
|
-
// Request 1: DB query, result cached
|
|
32
|
-
// Request 2: cache hit, no DB query
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
Use when sequential user actions hit multiple endpoints needing the same data within seconds.
|
|
36
|
-
|
|
37
|
-
**With Vercel's [Fluid Compute](https://vercel.com/docs/fluid-compute):** LRU caching is especially effective because multiple concurrent requests can share the same function instance and cache. This means the cache persists across requests without needing external storage like Redis.
|
|
38
|
-
|
|
39
|
-
**In traditional serverless:** Each invocation runs in isolation, so consider Redis for cross-process caching.
|
|
40
|
-
|
|
41
|
-
Reference: [https://github.com/isaacs/node-lru-cache](https://github.com/isaacs/node-lru-cache)
|