@peaske7/readit 0.1.7 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (118) hide show
  1. package/README.md +0 -3
  2. package/biome.json +1 -1
  3. package/bun.lock +43 -185
  4. package/docs/perf-baseline.md +75 -0
  5. package/docs/superpowers/plans/2026-03-26-surgical-pruning.md +1176 -0
  6. package/e2e/perf/add-comment.spec.ts +118 -0
  7. package/e2e/perf/fixtures/generate.ts +331 -0
  8. package/e2e/perf/initial-load.spec.ts +49 -0
  9. package/e2e/perf/perf.setup.ts +23 -0
  10. package/e2e/perf/perf.teardown.ts +9 -0
  11. package/e2e/perf/scroll.spec.ts +39 -0
  12. package/e2e/perf/tab-switch.spec.ts +69 -0
  13. package/e2e/perf/text-selection.spec.ts +119 -0
  14. package/e2e/perf/utils/metrics.ts +286 -0
  15. package/e2e/perf/utils/perf-cli.ts +86 -0
  16. package/package.json +9 -18
  17. package/playwright.config.ts +12 -0
  18. package/src/App.tsx +133 -178
  19. package/src/{cli/index.ts → cli.ts} +211 -107
  20. package/src/components/ActionsMenu.tsx +6 -27
  21. package/src/components/DocumentViewer/DocumentViewer.tsx +78 -105
  22. package/src/components/DocumentViewer/MermaidDiagram.tsx +6 -7
  23. package/src/components/Header.tsx +9 -20
  24. package/src/components/InlineEditor.tsx +5 -5
  25. package/src/components/MarginNote.tsx +71 -93
  26. package/src/components/MarginNotes.tsx +7 -34
  27. package/src/components/RawModal.tsx +9 -8
  28. package/src/components/ReanchorConfirm.tsx +2 -2
  29. package/src/components/SettingsModal.tsx +11 -89
  30. package/src/components/TabBar.tsx +4 -4
  31. package/src/components/TableOfContents.tsx +5 -5
  32. package/src/components/comments/CommentInput.tsx +7 -35
  33. package/src/components/comments/CommentListItem.tsx +9 -11
  34. package/src/components/comments/CommentManager.tsx +53 -37
  35. package/src/components/comments/CommentNav.tsx +14 -14
  36. package/src/components/ui/ActionLink.tsx +14 -18
  37. package/src/components/ui/Button.tsx +42 -43
  38. package/src/components/ui/Dialog.tsx +73 -113
  39. package/src/components/ui/DropdownMenu.tsx +113 -69
  40. package/src/components/ui/Text.tsx +30 -37
  41. package/src/contexts/CommentContext.tsx +75 -106
  42. package/src/contexts/LocaleContext.tsx +45 -4
  43. package/src/contexts/PositionsContext.tsx +16 -0
  44. package/src/contexts/SettingsContext.tsx +133 -0
  45. package/src/hooks/useClickOutside.ts +0 -4
  46. package/src/hooks/useCommentNavigation.ts +6 -29
  47. package/src/hooks/useComments.ts +6 -18
  48. package/src/hooks/useDocument.ts +35 -34
  49. package/src/hooks/useHeadings.test.ts +8 -50
  50. package/src/hooks/useHeadings.ts +5 -88
  51. package/src/hooks/useScrollSpy.ts +10 -14
  52. package/src/hooks/useTextSelection.ts +1 -38
  53. package/src/lib/__fixtures__/bench-data.ts +1 -41
  54. package/src/lib/anchor.bench.ts +57 -67
  55. package/src/lib/anchor.test.ts +5 -1
  56. package/src/lib/anchor.ts +13 -93
  57. package/src/lib/comment-storage.test.ts +4 -4
  58. package/src/lib/comment-storage.ts +2 -46
  59. package/src/lib/export.ts +7 -13
  60. package/src/lib/highlight/core.test.ts +1 -1
  61. package/src/lib/highlight/dom.ts +5 -68
  62. package/src/lib/highlight/highlighter.ts +102 -262
  63. package/src/lib/highlight/resolver.ts +112 -0
  64. package/src/lib/highlight/types.ts +0 -35
  65. package/src/lib/highlight/worker.ts +45 -0
  66. package/src/lib/i18n/en.ts +1 -50
  67. package/src/lib/i18n/ja.ts +1 -50
  68. package/src/lib/i18n/types.ts +1 -49
  69. package/src/lib/margin-layout.ts +5 -27
  70. package/src/lib/positions.ts +150 -0
  71. package/src/lib/utils.ts +2 -19
  72. package/src/schema.ts +81 -0
  73. package/src/{server/index.ts → server.ts} +111 -81
  74. package/src/{store/index.ts → store.ts} +14 -46
  75. package/vite.config.ts +8 -0
  76. package/src/components/DocumentViewer/IframeContainer.tsx +0 -251
  77. package/src/components/DocumentViewer/InlineCode.tsx +0 -60
  78. package/src/components/DocumentViewer/index.ts +0 -1
  79. package/src/components/FloatingTOC.tsx +0 -61
  80. package/src/components/ShortcutCapture.tsx +0 -48
  81. package/src/components/ShortcutList.tsx +0 -198
  82. package/src/components/comments/CommentMinimap.tsx +0 -62
  83. package/src/components/ui/ActionBar.tsx +0 -16
  84. package/src/components/ui/SeparatorDot.tsx +0 -9
  85. package/src/contexts/LayoutContext.tsx +0 -88
  86. package/src/hooks/useClipboard.ts +0 -82
  87. package/src/hooks/useEditorScheme.ts +0 -51
  88. package/src/hooks/useFontPreference.ts +0 -59
  89. package/src/hooks/useKeybindings.ts +0 -108
  90. package/src/hooks/useKeyboardShortcuts.ts +0 -63
  91. package/src/hooks/useLayoutMode.ts +0 -44
  92. package/src/hooks/useLocalePreference.ts +0 -42
  93. package/src/hooks/useReanchorMode.ts +0 -33
  94. package/src/hooks/useScrollMetrics.ts +0 -56
  95. package/src/hooks/useThemePreference.ts +0 -66
  96. package/src/lib/comment-storage.bench.ts +0 -63
  97. package/src/lib/context.bench.ts +0 -41
  98. package/src/lib/context.test.ts +0 -224
  99. package/src/lib/context.ts +0 -193
  100. package/src/lib/editor-links.ts +0 -59
  101. package/src/lib/export.bench.ts +0 -35
  102. package/src/lib/highlight/colors.ts +0 -37
  103. package/src/lib/highlight/core.ts +0 -54
  104. package/src/lib/highlight/index.ts +0 -23
  105. package/src/lib/highlight/script-builder.ts +0 -485
  106. package/src/lib/html-processor.test.tsx +0 -170
  107. package/src/lib/html-processor.tsx +0 -95
  108. package/src/lib/i18n/completeness.test.ts +0 -51
  109. package/src/lib/i18n/translations.test.ts +0 -39
  110. package/src/lib/layout-constants.ts +0 -12
  111. package/src/lib/margin-layout.bench.ts +0 -28
  112. package/src/lib/scroll.test.ts +0 -118
  113. package/src/lib/scroll.ts +0 -47
  114. package/src/lib/shortcut-registry.test.ts +0 -173
  115. package/src/lib/shortcut-registry.ts +0 -209
  116. package/src/lib/utils.test.ts +0 -110
  117. package/src/store/index.test.ts +0 -242
  118. package/src/types/index.ts +0 -127
@@ -1,242 +0,0 @@
1
- import { beforeEach, describe, expect, it } from "vitest";
2
- import type { Comment, Document } from "../types";
3
- import { createAppStore } from "./index";
4
-
5
- const mockDoc: Document = {
6
- content: "# Hello",
7
- type: "markdown",
8
- filePath: "/test/file.md",
9
- fileName: "file.md",
10
- clean: false,
11
- };
12
-
13
- const mockDoc2: Document = {
14
- content: "<h1>Hello</h1>",
15
- type: "html",
16
- filePath: "/test/file.html",
17
- fileName: "file.html",
18
- clean: false,
19
- };
20
-
21
- const mockComment = {
22
- id: "c1",
23
- selectedText: "hello",
24
- comment: "note",
25
- startOffset: 0,
26
- endOffset: 5,
27
- createdAt: "2026-03-13T00:00:00Z",
28
- } as Comment;
29
-
30
- describe("AppStore", () => {
31
- let store: ReturnType<typeof createAppStore>;
32
-
33
- beforeEach(() => {
34
- store = createAppStore();
35
- });
36
-
37
- describe("openDocument", () => {
38
- it("adds document to store and sets as active", () => {
39
- store.getState().openDocument(mockDoc);
40
- const state = store.getState();
41
- expect(state.documents.has("/test/file.md")).toBe(true);
42
- expect(state.activeDocumentPath).toBe("/test/file.md");
43
- expect(state.documentOrder).toEqual(["/test/file.md"]);
44
- });
45
-
46
- it("does not overwrite existing document state", () => {
47
- store.getState().openDocument(mockDoc);
48
- store.getState().setComments([mockComment]);
49
- store.getState().openDocument(mockDoc);
50
- expect(
51
- store.getState().documents.get("/test/file.md")!.comments,
52
- ).toHaveLength(1);
53
- });
54
-
55
- it("activates existing document without overwriting", () => {
56
- store.getState().openDocument(mockDoc);
57
- store.getState().openDocument(mockDoc2);
58
- expect(store.getState().activeDocumentPath).toBe("/test/file.html");
59
- store.getState().openDocument(mockDoc);
60
- expect(store.getState().activeDocumentPath).toBe("/test/file.md");
61
- // Order unchanged
62
- expect(store.getState().documentOrder).toEqual([
63
- "/test/file.md",
64
- "/test/file.html",
65
- ]);
66
- });
67
-
68
- it("adds document without activating when active is false", () => {
69
- store.getState().openDocument(mockDoc);
70
- store.getState().openDocument(mockDoc2, { active: false });
71
- expect(store.getState().activeDocumentPath).toBe("/test/file.md");
72
- expect(store.getState().documentOrder).toEqual([
73
- "/test/file.md",
74
- "/test/file.html",
75
- ]);
76
- });
77
-
78
- it("updates existing document without stealing focus when active is false", () => {
79
- store.getState().openDocument(mockDoc);
80
- store.getState().openDocument(mockDoc2);
81
- store
82
- .getState()
83
- .openDocument({ ...mockDoc, content: "# Updated" }, { active: false });
84
- expect(store.getState().activeDocumentPath).toBe("/test/file.html");
85
- expect(
86
- store.getState().documents.get("/test/file.md")!.document.content,
87
- ).toBe("# Updated");
88
- });
89
- });
90
-
91
- describe("closeDocument", () => {
92
- it("removes document and activates right neighbor", () => {
93
- store.getState().openDocument(mockDoc);
94
- store.getState().openDocument(mockDoc2);
95
- store.getState().setActiveDocument("/test/file.md");
96
- store.getState().closeDocument("/test/file.md");
97
- expect(store.getState().documents.has("/test/file.md")).toBe(false);
98
- expect(store.getState().activeDocumentPath).toBe("/test/file.html");
99
- });
100
-
101
- it("activates left neighbor when closing last in order", () => {
102
- store.getState().openDocument(mockDoc);
103
- store.getState().openDocument(mockDoc2);
104
- // mockDoc2 is active (last opened)
105
- store.getState().closeDocument("/test/file.html");
106
- expect(store.getState().activeDocumentPath).toBe("/test/file.md");
107
- });
108
-
109
- it("sets null when closing last document", () => {
110
- store.getState().openDocument(mockDoc);
111
- store.getState().closeDocument("/test/file.md");
112
- expect(store.getState().activeDocumentPath).toBeNull();
113
- expect(store.getState().documentOrder).toEqual([]);
114
- });
115
-
116
- it("does not change active if closing non-active tab", () => {
117
- store.getState().openDocument(mockDoc);
118
- store.getState().openDocument(mockDoc2);
119
- // mockDoc2 is active
120
- store.getState().closeDocument("/test/file.md");
121
- expect(store.getState().activeDocumentPath).toBe("/test/file.html");
122
- });
123
-
124
- it("activates right neighbor when closing middle tab", () => {
125
- const mockDoc3: Document = {
126
- content: "# Third",
127
- type: "markdown",
128
- filePath: "/test/third.md",
129
- fileName: "third.md",
130
- clean: false,
131
- };
132
- store.getState().openDocument(mockDoc);
133
- store.getState().openDocument(mockDoc2);
134
- store.getState().openDocument(mockDoc3);
135
- store.getState().setActiveDocument("/test/file.html");
136
- store.getState().closeDocument("/test/file.html");
137
- expect(store.getState().activeDocumentPath).toBe("/test/third.md");
138
- expect(store.getState().documentOrder).toEqual([
139
- "/test/file.md",
140
- "/test/third.md",
141
- ]);
142
- });
143
- });
144
-
145
- describe("setActiveDocument", () => {
146
- it("sets active document", () => {
147
- store.getState().openDocument(mockDoc);
148
- store.getState().openDocument(mockDoc2);
149
- store.getState().setActiveDocument("/test/file.md");
150
- expect(store.getState().activeDocumentPath).toBe("/test/file.md");
151
- });
152
-
153
- it("ignores unknown file paths", () => {
154
- store.getState().openDocument(mockDoc);
155
- store.getState().setActiveDocument("/nonexistent.md");
156
- expect(store.getState().activeDocumentPath).toBe("/test/file.md");
157
- });
158
- });
159
-
160
- describe("per-document setters default to active doc", () => {
161
- it("setComments operates on active document", () => {
162
- store.getState().openDocument(mockDoc);
163
- store.getState().setComments([mockComment]);
164
- const docState = store.getState().documents.get("/test/file.md")!;
165
- expect(docState.comments).toEqual([mockComment]);
166
- expect(docState.sortedComments).toEqual([mockComment]);
167
- });
168
-
169
- it("setComments with explicit filePath targets that document", () => {
170
- store.getState().openDocument(mockDoc);
171
- store.getState().openDocument(mockDoc2);
172
- store.getState().setComments([mockComment], "/test/file.html");
173
- expect(
174
- store.getState().documents.get("/test/file.html")!.comments,
175
- ).toEqual([mockComment]);
176
- expect(store.getState().documents.get("/test/file.md")!.comments).toEqual(
177
- [],
178
- );
179
- });
180
-
181
- it("sortedComments sorts by startOffset", () => {
182
- store.getState().openDocument(mockDoc);
183
- const c1 = { ...mockComment, id: "c1", startOffset: 10 };
184
- const c2 = { ...mockComment, id: "c2", startOffset: 2 };
185
- const c3 = { ...mockComment, id: "c3", startOffset: 5 };
186
- store.getState().setComments([c1, c2, c3]);
187
- const docState = store.getState().documents.get("/test/file.md")!;
188
- expect(docState.sortedComments.map((c) => c.id)).toEqual([
189
- "c2",
190
- "c3",
191
- "c1",
192
- ]);
193
- });
194
-
195
- it("setSelection operates on active document", () => {
196
- store.getState().openDocument(mockDoc);
197
- const sel = { text: "hello", startOffset: 0, endOffset: 5 };
198
- store.getState().setSelection(sel);
199
- expect(
200
- store.getState().documents.get("/test/file.md")!.selection,
201
- ).toEqual(sel);
202
- });
203
-
204
- it("setScrollY operates on active document", () => {
205
- store.getState().openDocument(mockDoc);
206
- store.getState().setScrollY(150);
207
- expect(store.getState().documents.get("/test/file.md")!.scrollY).toBe(
208
- 150,
209
- );
210
- });
211
-
212
- it("setters no-op when no active document", () => {
213
- // No document opened
214
- store.getState().setComments([mockComment]);
215
- // Should not throw, just no-op
216
- expect(store.getState().documents.size).toBe(0);
217
- });
218
- });
219
-
220
- describe("getActiveDocumentState", () => {
221
- it("returns undefined when no active document", () => {
222
- expect(store.getState().getActiveDocumentState()).toBeUndefined();
223
- });
224
-
225
- it("returns active document state", () => {
226
- store.getState().openDocument(mockDoc);
227
- const state = store.getState().getActiveDocumentState();
228
- expect(state).toBeDefined();
229
- expect(state!.document.filePath).toBe("/test/file.md");
230
- });
231
- });
232
-
233
- describe("updateDocumentContent", () => {
234
- it("updates document content in place", () => {
235
- store.getState().openDocument(mockDoc);
236
- store.getState().updateDocumentContent("# Updated");
237
- expect(
238
- store.getState().documents.get("/test/file.md")!.document.content,
239
- ).toBe("# Updated");
240
- });
241
- });
242
- });
@@ -1,127 +0,0 @@
1
- // Anchor confidence levels - const object pattern per style guide 6.3
2
- export const AnchorConfidences = {
3
- EXACT: "exact",
4
- NORMALIZED: "normalized",
5
- FUZZY: "fuzzy",
6
- UNRESOLVED: "unresolved",
7
- } as const;
8
-
9
- export type AnchorConfidence =
10
- (typeof AnchorConfidences)[keyof typeof AnchorConfidences];
11
-
12
- // Subset excluding "unresolved" for resolved anchors
13
- export type ResolvedAnchorConfidence = Exclude<
14
- AnchorConfidence,
15
- typeof AnchorConfidences.UNRESOLVED
16
- >;
17
-
18
- export interface Comment {
19
- id: string;
20
- selectedText: string;
21
- comment: string;
22
- createdAt: string;
23
- // Position info for highlighting
24
- startOffset: number;
25
- endOffset: number;
26
- // Line hint for text-based anchoring (e.g., "L42" or "L42-45")
27
- lineHint?: string;
28
- // Confidence level of anchor resolution
29
- anchorConfidence?: AnchorConfidence;
30
- // First N chars of original text for anchor matching when selectedText is truncated
31
- anchorPrefix?: string;
32
- }
33
-
34
- // Parsed comment file structure
35
- export interface CommentFile {
36
- source: string; // Absolute path to source file
37
- hash: string; // SHA-256 prefix (16 chars) of source content
38
- version: number; // Format version
39
- comments: Comment[];
40
- }
41
-
42
- // Anchor match result
43
- export interface Anchor {
44
- start: number;
45
- end: number;
46
- line: number;
47
- confidence: ResolvedAnchorConfidence;
48
- distance?: number; // Levenshtein distance for fuzzy matches
49
- }
50
-
51
- export interface SelectionRange {
52
- startOffset: number;
53
- endOffset: number;
54
- }
55
-
56
- export interface Selection extends SelectionRange {
57
- text: string;
58
- }
59
-
60
- export type DocumentType = "markdown" | "html";
61
-
62
- export interface Document {
63
- content: string;
64
- type: DocumentType;
65
- filePath: string;
66
- fileName: string;
67
- clean: boolean;
68
- }
69
-
70
- // Editor scheme options - const object pattern per style guide 6.3
71
- export const EditorSchemes = {
72
- NONE: "none",
73
- VSCODE: "vscode",
74
- VSCODE_INSIDERS: "vscode-insiders",
75
- CURSOR: "cursor",
76
- } as const;
77
-
78
- export type EditorScheme = (typeof EditorSchemes)[keyof typeof EditorSchemes];
79
-
80
- // Font family options - const object pattern per style guide 6.3
81
- export const FontFamilies = {
82
- SERIF: "serif",
83
- SANS_SERIF: "sans-serif",
84
- } as const;
85
-
86
- export type FontFamily = (typeof FontFamilies)[keyof typeof FontFamilies];
87
-
88
- // Theme mode options - const object pattern per style guide 6.3
89
- export const ThemeModes = {
90
- LIGHT: "light",
91
- DARK: "dark",
92
- SYSTEM: "system",
93
- } as const;
94
-
95
- export type ThemeMode = (typeof ThemeModes)[keyof typeof ThemeModes];
96
-
97
- // Layout mode options - const object pattern per style guide 6.3
98
- export const LayoutModes = {
99
- CENTERED: "centered",
100
- FULLSCREEN: "fullscreen",
101
- } as const;
102
-
103
- export type LayoutMode = (typeof LayoutModes)[keyof typeof LayoutModes];
104
-
105
- // Keyboard shortcut binding
106
- export interface ShortcutBinding {
107
- key: string; // KeyboardEvent.key value, e.g. "c", "ArrowUp"
108
- alt?: boolean;
109
- meta?: boolean; // ⌘ on Mac, Ctrl on Windows/Linux
110
- shift?: boolean;
111
- }
112
-
113
- // User override for a shortcut
114
- export interface KeybindingOverride {
115
- id: string;
116
- binding?: ShortcutBinding; // undefined = use default
117
- enabled: boolean;
118
- }
119
-
120
- // Document settings stored per-file
121
- export interface DocumentSettings {
122
- version: number;
123
- fontFamily: FontFamily;
124
- editorScheme?: EditorScheme;
125
- keybindings?: KeybindingOverride[];
126
- onboarded?: boolean;
127
- }