docrev 0.11.0 → 0.11.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.
Files changed (123) hide show
  1. package/.gitattributes +1 -1
  2. package/CHANGELOG.md +202 -184
  3. package/PLAN-tables-and-postprocess.md +850 -850
  4. package/README.md +433 -431
  5. package/bin/rev.js +11 -11
  6. package/bin/rev.ts +145 -145
  7. package/completions/rev.bash +127 -127
  8. package/completions/rev.ps1 +210 -210
  9. package/completions/rev.zsh +207 -207
  10. package/dist/lib/build.d.ts +80 -0
  11. package/dist/lib/build.d.ts.map +1 -1
  12. package/dist/lib/build.js +207 -4
  13. package/dist/lib/build.js.map +1 -1
  14. package/dist/lib/commands/build.d.ts.map +1 -1
  15. package/dist/lib/commands/build.js +34 -12
  16. package/dist/lib/commands/build.js.map +1 -1
  17. package/dist/lib/commands/utilities.js +164 -164
  18. package/dist/lib/commands/word-tools.js +8 -8
  19. package/dist/lib/grammar.js +3 -3
  20. package/dist/lib/macro-filter.lua +201 -201
  21. package/dist/lib/pdf-comments.js +44 -44
  22. package/dist/lib/plugins.js +57 -57
  23. package/dist/lib/pptx-color-filter.lua +37 -37
  24. package/dist/lib/pptx-themes.js +115 -115
  25. package/dist/lib/schema.d.ts.map +1 -1
  26. package/dist/lib/schema.js +8 -2
  27. package/dist/lib/schema.js.map +1 -1
  28. package/dist/lib/spelling.js +2 -2
  29. package/dist/lib/templates.js +387 -387
  30. package/dist/lib/themes.js +51 -51
  31. package/dist/lib/trackchanges.d.ts +41 -25
  32. package/dist/lib/trackchanges.d.ts.map +1 -1
  33. package/dist/lib/trackchanges.js +90 -151
  34. package/dist/lib/trackchanges.js.map +1 -1
  35. package/dist/lib/types.d.ts +0 -7
  36. package/dist/lib/types.d.ts.map +1 -1
  37. package/docs-src/build.py +113 -113
  38. package/docs-src/extra.css +208 -208
  39. package/docs-src/md-to-html.lua +6 -6
  40. package/docs-src/template.html +116 -116
  41. package/eslint.config.js +27 -27
  42. package/lib/anchor-match.ts +307 -307
  43. package/lib/annotations.ts +664 -664
  44. package/lib/build.ts +2047 -1770
  45. package/lib/citations.ts +160 -160
  46. package/lib/commands/build.ts +885 -860
  47. package/lib/commands/citations.ts +515 -515
  48. package/lib/commands/comments.ts +1050 -1050
  49. package/lib/commands/context.ts +176 -176
  50. package/lib/commands/core.ts +309 -309
  51. package/lib/commands/doi.ts +451 -451
  52. package/lib/commands/file-ops.ts +372 -372
  53. package/lib/commands/history.ts +320 -320
  54. package/lib/commands/index.ts +87 -87
  55. package/lib/commands/init.ts +259 -259
  56. package/lib/commands/merge-resolve.ts +378 -378
  57. package/lib/commands/preview.ts +178 -178
  58. package/lib/commands/project-info.ts +244 -244
  59. package/lib/commands/quality.ts +517 -517
  60. package/lib/commands/response.ts +454 -454
  61. package/lib/commands/section-boundaries.ts +82 -82
  62. package/lib/commands/sections.ts +451 -451
  63. package/lib/commands/sync.ts +689 -689
  64. package/lib/commands/text-ops.ts +449 -449
  65. package/lib/commands/utilities.ts +448 -448
  66. package/lib/commands/verify-anchors.ts +272 -272
  67. package/lib/commands/word-tools.ts +340 -340
  68. package/lib/comment-realign.ts +99 -99
  69. package/lib/config.ts +84 -84
  70. package/lib/crossref.ts +781 -781
  71. package/lib/csl.ts +191 -191
  72. package/lib/dependencies.ts +132 -132
  73. package/lib/diff-engine.ts +465 -465
  74. package/lib/doi-cache.ts +115 -115
  75. package/lib/doi.ts +879 -879
  76. package/lib/equations.ts +506 -506
  77. package/lib/errors.ts +350 -350
  78. package/lib/format.ts +541 -541
  79. package/lib/git.ts +326 -326
  80. package/lib/grammar.ts +303 -303
  81. package/lib/image-registry.ts +180 -180
  82. package/lib/import.ts +906 -906
  83. package/lib/journals.ts +543 -543
  84. package/lib/macro-filter.lua +201 -201
  85. package/lib/macros.ts +273 -273
  86. package/lib/merge.ts +633 -633
  87. package/lib/ooxml.ts +768 -768
  88. package/lib/orcid.ts +144 -144
  89. package/lib/pdf-comments.ts +263 -263
  90. package/lib/pdf-import.ts +524 -524
  91. package/lib/plugins.ts +362 -362
  92. package/lib/postprocess.ts +188 -188
  93. package/lib/pptx-color-filter.lua +37 -37
  94. package/lib/pptx-template.ts +469 -469
  95. package/lib/pptx-themes.ts +483 -483
  96. package/lib/protect-restore.ts +520 -520
  97. package/lib/rate-limiter.ts +127 -127
  98. package/lib/response.ts +197 -197
  99. package/lib/restore-references.ts +240 -240
  100. package/lib/review.ts +327 -327
  101. package/lib/schema.ts +494 -488
  102. package/lib/scientific-words.ts +73 -73
  103. package/lib/sections.ts +428 -428
  104. package/lib/slides.ts +756 -756
  105. package/lib/spelling.ts +334 -334
  106. package/lib/templates.ts +526 -526
  107. package/lib/themes.ts +742 -742
  108. package/lib/trackchanges.ts +166 -247
  109. package/lib/tui.ts +450 -450
  110. package/lib/types.ts +546 -558
  111. package/lib/undo.ts +250 -250
  112. package/lib/utils.ts +69 -69
  113. package/lib/variables.ts +179 -179
  114. package/lib/word-extraction.ts +525 -525
  115. package/lib/word.ts +526 -526
  116. package/lib/wordcomments.ts +789 -789
  117. package/mkdocs.yml +64 -64
  118. package/package.json +137 -137
  119. package/scripts/postbuild.js +47 -47
  120. package/skill/REFERENCE.md +550 -539
  121. package/skill/SKILL.md +302 -295
  122. package/tsconfig.json +26 -26
  123. package/types/index.d.ts +531 -525
package/lib/undo.ts CHANGED
@@ -1,250 +1,250 @@
1
- /**
2
- * In-session undo stack for comment/annotation operations
3
- *
4
- * Provides undo/redo functionality during interactive sessions
5
- */
6
-
7
- interface StackEntry {
8
- state: string | object;
9
- description: string;
10
- timestamp: number;
11
- }
12
-
13
- interface HistoryEntry {
14
- description: string;
15
- current: boolean;
16
- index: number;
17
- }
18
-
19
- export interface StackInfo {
20
- position: number;
21
- size: number;
22
- undoSteps: number;
23
- redoSteps: number;
24
- }
25
-
26
- interface UndoStack {
27
- push(state: string | object, description?: string): void;
28
- undo(): StackEntry | null;
29
- redo(): StackEntry | null;
30
- current(): StackEntry | null;
31
- canUndo(): boolean;
32
- canRedo(): boolean;
33
- info(): StackInfo;
34
- history(limit?: number): HistoryEntry[];
35
- getStack(): StackEntry[];
36
- }
37
-
38
- export interface DocumentChange {
39
- text: string;
40
- description: string;
41
- }
42
-
43
- export interface DocumentSession {
44
- getText(): string;
45
- applyChange(newText: string, description: string): void;
46
- undo(): DocumentChange | null;
47
- redo(): DocumentChange | null;
48
- canUndo(): boolean;
49
- canRedo(): boolean;
50
- info(): StackInfo;
51
- history(limit?: number): HistoryEntry[];
52
- }
53
-
54
- /**
55
- * Create an undo stack
56
- */
57
- export function createUndoStack(maxSize: number = 50): UndoStack {
58
- const stack: StackEntry[] = [];
59
- let position = -1;
60
-
61
- return {
62
- /**
63
- * Push a new state onto the stack
64
- */
65
- push(state: string | object, description: string = ''): void {
66
- // Remove any states after current position (for redo)
67
- if (position < stack.length - 1) {
68
- stack.splice(position + 1);
69
- }
70
-
71
- // Add new state
72
- stack.push({
73
- state: typeof state === 'string' ? state : JSON.parse(JSON.stringify(state)),
74
- description,
75
- timestamp: Date.now(),
76
- });
77
-
78
- // Enforce max size
79
- while (stack.length > maxSize) {
80
- stack.shift();
81
- }
82
-
83
- position = stack.length - 1;
84
- },
85
-
86
- /**
87
- * Undo to previous state
88
- */
89
- undo(): StackEntry | null {
90
- if (position <= 0) {
91
- return null;
92
- }
93
-
94
- position--;
95
- return stack[position] || null;
96
- },
97
-
98
- /**
99
- * Redo to next state
100
- */
101
- redo(): StackEntry | null {
102
- if (position >= stack.length - 1) {
103
- return null;
104
- }
105
-
106
- position++;
107
- return stack[position] || null;
108
- },
109
-
110
- /**
111
- * Get current state
112
- */
113
- current(): StackEntry | null {
114
- if (position < 0 || position >= stack.length) {
115
- return null;
116
- }
117
- return stack[position] || null;
118
- },
119
-
120
- /**
121
- * Check if undo is available
122
- */
123
- canUndo(): boolean {
124
- return position > 0;
125
- },
126
-
127
- /**
128
- * Check if redo is available
129
- */
130
- canRedo(): boolean {
131
- return position < stack.length - 1;
132
- },
133
-
134
- /**
135
- * Get stack info
136
- */
137
- info(): StackInfo {
138
- return {
139
- position,
140
- size: stack.length,
141
- undoSteps: position,
142
- redoSteps: stack.length - position - 1,
143
- };
144
- },
145
-
146
- /**
147
- * Get history of changes
148
- */
149
- history(limit: number = 10): HistoryEntry[] {
150
- const start = Math.max(0, position - Math.floor(limit / 2));
151
- const end = Math.min(stack.length, start + limit);
152
-
153
- return stack.slice(start, end).map((item, i) => ({
154
- description: item.description,
155
- current: start + i === position,
156
- index: start + i,
157
- }));
158
- },
159
-
160
- /**
161
- * Get the full stack (for debugging)
162
- */
163
- getStack(): StackEntry[] {
164
- return [...stack];
165
- },
166
- };
167
- }
168
-
169
- /**
170
- * Create a document session with undo support
171
- */
172
- export function createDocumentSession(initialText: string): DocumentSession {
173
- const undoStack = createUndoStack();
174
-
175
- // Save initial state
176
- undoStack.push(initialText, 'Initial state');
177
-
178
- return {
179
- /**
180
- * Get current text
181
- */
182
- getText(): string {
183
- const current = undoStack.current();
184
- return current ? current.state as string : initialText;
185
- },
186
-
187
- /**
188
- * Apply a change
189
- */
190
- applyChange(newText: string, description: string): void {
191
- undoStack.push(newText, description);
192
- },
193
-
194
- /**
195
- * Undo last change
196
- */
197
- undo(): DocumentChange | null {
198
- const result = undoStack.undo();
199
- if (result) {
200
- return {
201
- text: result.state as string,
202
- description: result.description,
203
- };
204
- }
205
- return null;
206
- },
207
-
208
- /**
209
- * Redo last undone change
210
- */
211
- redo(): DocumentChange | null {
212
- const result = undoStack.redo();
213
- if (result) {
214
- return {
215
- text: result.state as string,
216
- description: result.description,
217
- };
218
- }
219
- return null;
220
- },
221
-
222
- /**
223
- * Check if undo is available
224
- */
225
- canUndo(): boolean {
226
- return undoStack.canUndo();
227
- },
228
-
229
- /**
230
- * Check if redo is available
231
- */
232
- canRedo(): boolean {
233
- return undoStack.canRedo();
234
- },
235
-
236
- /**
237
- * Get stack info
238
- */
239
- info(): StackInfo {
240
- return undoStack.info();
241
- },
242
-
243
- /**
244
- * Get change history
245
- */
246
- history(limit: number = 10): HistoryEntry[] {
247
- return undoStack.history(limit);
248
- },
249
- };
250
- }
1
+ /**
2
+ * In-session undo stack for comment/annotation operations
3
+ *
4
+ * Provides undo/redo functionality during interactive sessions
5
+ */
6
+
7
+ interface StackEntry {
8
+ state: string | object;
9
+ description: string;
10
+ timestamp: number;
11
+ }
12
+
13
+ interface HistoryEntry {
14
+ description: string;
15
+ current: boolean;
16
+ index: number;
17
+ }
18
+
19
+ export interface StackInfo {
20
+ position: number;
21
+ size: number;
22
+ undoSteps: number;
23
+ redoSteps: number;
24
+ }
25
+
26
+ interface UndoStack {
27
+ push(state: string | object, description?: string): void;
28
+ undo(): StackEntry | null;
29
+ redo(): StackEntry | null;
30
+ current(): StackEntry | null;
31
+ canUndo(): boolean;
32
+ canRedo(): boolean;
33
+ info(): StackInfo;
34
+ history(limit?: number): HistoryEntry[];
35
+ getStack(): StackEntry[];
36
+ }
37
+
38
+ export interface DocumentChange {
39
+ text: string;
40
+ description: string;
41
+ }
42
+
43
+ export interface DocumentSession {
44
+ getText(): string;
45
+ applyChange(newText: string, description: string): void;
46
+ undo(): DocumentChange | null;
47
+ redo(): DocumentChange | null;
48
+ canUndo(): boolean;
49
+ canRedo(): boolean;
50
+ info(): StackInfo;
51
+ history(limit?: number): HistoryEntry[];
52
+ }
53
+
54
+ /**
55
+ * Create an undo stack
56
+ */
57
+ export function createUndoStack(maxSize: number = 50): UndoStack {
58
+ const stack: StackEntry[] = [];
59
+ let position = -1;
60
+
61
+ return {
62
+ /**
63
+ * Push a new state onto the stack
64
+ */
65
+ push(state: string | object, description: string = ''): void {
66
+ // Remove any states after current position (for redo)
67
+ if (position < stack.length - 1) {
68
+ stack.splice(position + 1);
69
+ }
70
+
71
+ // Add new state
72
+ stack.push({
73
+ state: typeof state === 'string' ? state : JSON.parse(JSON.stringify(state)),
74
+ description,
75
+ timestamp: Date.now(),
76
+ });
77
+
78
+ // Enforce max size
79
+ while (stack.length > maxSize) {
80
+ stack.shift();
81
+ }
82
+
83
+ position = stack.length - 1;
84
+ },
85
+
86
+ /**
87
+ * Undo to previous state
88
+ */
89
+ undo(): StackEntry | null {
90
+ if (position <= 0) {
91
+ return null;
92
+ }
93
+
94
+ position--;
95
+ return stack[position] || null;
96
+ },
97
+
98
+ /**
99
+ * Redo to next state
100
+ */
101
+ redo(): StackEntry | null {
102
+ if (position >= stack.length - 1) {
103
+ return null;
104
+ }
105
+
106
+ position++;
107
+ return stack[position] || null;
108
+ },
109
+
110
+ /**
111
+ * Get current state
112
+ */
113
+ current(): StackEntry | null {
114
+ if (position < 0 || position >= stack.length) {
115
+ return null;
116
+ }
117
+ return stack[position] || null;
118
+ },
119
+
120
+ /**
121
+ * Check if undo is available
122
+ */
123
+ canUndo(): boolean {
124
+ return position > 0;
125
+ },
126
+
127
+ /**
128
+ * Check if redo is available
129
+ */
130
+ canRedo(): boolean {
131
+ return position < stack.length - 1;
132
+ },
133
+
134
+ /**
135
+ * Get stack info
136
+ */
137
+ info(): StackInfo {
138
+ return {
139
+ position,
140
+ size: stack.length,
141
+ undoSteps: position,
142
+ redoSteps: stack.length - position - 1,
143
+ };
144
+ },
145
+
146
+ /**
147
+ * Get history of changes
148
+ */
149
+ history(limit: number = 10): HistoryEntry[] {
150
+ const start = Math.max(0, position - Math.floor(limit / 2));
151
+ const end = Math.min(stack.length, start + limit);
152
+
153
+ return stack.slice(start, end).map((item, i) => ({
154
+ description: item.description,
155
+ current: start + i === position,
156
+ index: start + i,
157
+ }));
158
+ },
159
+
160
+ /**
161
+ * Get the full stack (for debugging)
162
+ */
163
+ getStack(): StackEntry[] {
164
+ return [...stack];
165
+ },
166
+ };
167
+ }
168
+
169
+ /**
170
+ * Create a document session with undo support
171
+ */
172
+ export function createDocumentSession(initialText: string): DocumentSession {
173
+ const undoStack = createUndoStack();
174
+
175
+ // Save initial state
176
+ undoStack.push(initialText, 'Initial state');
177
+
178
+ return {
179
+ /**
180
+ * Get current text
181
+ */
182
+ getText(): string {
183
+ const current = undoStack.current();
184
+ return current ? current.state as string : initialText;
185
+ },
186
+
187
+ /**
188
+ * Apply a change
189
+ */
190
+ applyChange(newText: string, description: string): void {
191
+ undoStack.push(newText, description);
192
+ },
193
+
194
+ /**
195
+ * Undo last change
196
+ */
197
+ undo(): DocumentChange | null {
198
+ const result = undoStack.undo();
199
+ if (result) {
200
+ return {
201
+ text: result.state as string,
202
+ description: result.description,
203
+ };
204
+ }
205
+ return null;
206
+ },
207
+
208
+ /**
209
+ * Redo last undone change
210
+ */
211
+ redo(): DocumentChange | null {
212
+ const result = undoStack.redo();
213
+ if (result) {
214
+ return {
215
+ text: result.state as string,
216
+ description: result.description,
217
+ };
218
+ }
219
+ return null;
220
+ },
221
+
222
+ /**
223
+ * Check if undo is available
224
+ */
225
+ canUndo(): boolean {
226
+ return undoStack.canUndo();
227
+ },
228
+
229
+ /**
230
+ * Check if redo is available
231
+ */
232
+ canRedo(): boolean {
233
+ return undoStack.canRedo();
234
+ },
235
+
236
+ /**
237
+ * Get stack info
238
+ */
239
+ info(): StackInfo {
240
+ return undoStack.info();
241
+ },
242
+
243
+ /**
244
+ * Get change history
245
+ */
246
+ history(limit: number = 10): HistoryEntry[] {
247
+ return undoStack.history(limit);
248
+ },
249
+ };
250
+ }
package/lib/utils.ts CHANGED
@@ -1,69 +1,69 @@
1
- /**
2
- * Shared utility functions
3
- */
4
-
5
- /**
6
- * Count words in text (excluding markdown syntax)
7
- * @param text - Markdown text
8
- * @returns Word count
9
- */
10
- export function countWords(text: string): number {
11
- return text
12
- .replace(/^---[\s\S]*?---/m, '') // Remove YAML frontmatter
13
- .replace(/!\[.*?\]\(.*?\)/g, '') // Remove images
14
- .replace(/\[([^\]]+)\]\([^)]+\)/g, '$1') // Keep link text
15
- .replace(/#+\s*/g, '') // Remove headers
16
- .replace(/\*\*|__|[*_`]/g, '') // Remove formatting
17
- .replace(/```[\s\S]*?```/g, '') // Remove code blocks
18
- .replace(/\{[^}]+\}/g, '') // Remove CriticMarkup and attributes
19
- .replace(/@\w+:\w+/g, '') // Remove cross-references
20
- .replace(/@\w+/g, '') // Remove citations
21
- .replace(/\|[^|]+\|/g, ' ') // Remove table cells
22
- .replace(/[-=]{3,}/g, '') // Remove horizontal rules
23
- .replace(/\n+/g, ' ') // Newlines to spaces
24
- .replace(/\s+/g, ' ') // Collapse multiple spaces
25
- .trim()
26
- .split(/\s+/)
27
- .filter(w => w.length > 0).length;
28
- }
29
-
30
- /**
31
- * Normalize whitespace in text
32
- * @param text - Input text
33
- * @returns Normalized text
34
- */
35
- export function normalizeWhitespace(text: string): string {
36
- return text
37
- .replace(/\r\n/g, '\n')
38
- .replace(/\t/g, ' ')
39
- .replace(/ +/g, ' ')
40
- .trim();
41
- }
42
-
43
- /**
44
- * Escape XML special characters
45
- * @param str - Input string
46
- * @returns XML-safe string
47
- */
48
- export function escapeXml(str: string): string {
49
- return str
50
- .replace(/&/g, '&amp;')
51
- .replace(/</g, '&lt;')
52
- .replace(/>/g, '&gt;')
53
- .replace(/"/g, '&quot;')
54
- .replace(/'/g, '&apos;');
55
- }
56
-
57
- /**
58
- * Escape LaTeX special characters
59
- * @param text - Text to escape
60
- * @returns Escaped text
61
- */
62
- export function escapeLatex(text: string): string {
63
- return text
64
- .replace(/\\/g, '\\textbackslash{}')
65
- .replace(/([#$%&_{}])/g, '\\$1')
66
- .replace(/\^/g, '\\textasciicircum{}')
67
- .replace(/~/g, '\\textasciitilde{}')
68
- .replace(/\n/g, ' ');
69
- }
1
+ /**
2
+ * Shared utility functions
3
+ */
4
+
5
+ /**
6
+ * Count words in text (excluding markdown syntax)
7
+ * @param text - Markdown text
8
+ * @returns Word count
9
+ */
10
+ export function countWords(text: string): number {
11
+ return text
12
+ .replace(/^---[\s\S]*?---/m, '') // Remove YAML frontmatter
13
+ .replace(/!\[.*?\]\(.*?\)/g, '') // Remove images
14
+ .replace(/\[([^\]]+)\]\([^)]+\)/g, '$1') // Keep link text
15
+ .replace(/#+\s*/g, '') // Remove headers
16
+ .replace(/\*\*|__|[*_`]/g, '') // Remove formatting
17
+ .replace(/```[\s\S]*?```/g, '') // Remove code blocks
18
+ .replace(/\{[^}]+\}/g, '') // Remove CriticMarkup and attributes
19
+ .replace(/@\w+:\w+/g, '') // Remove cross-references
20
+ .replace(/@\w+/g, '') // Remove citations
21
+ .replace(/\|[^|]+\|/g, ' ') // Remove table cells
22
+ .replace(/[-=]{3,}/g, '') // Remove horizontal rules
23
+ .replace(/\n+/g, ' ') // Newlines to spaces
24
+ .replace(/\s+/g, ' ') // Collapse multiple spaces
25
+ .trim()
26
+ .split(/\s+/)
27
+ .filter(w => w.length > 0).length;
28
+ }
29
+
30
+ /**
31
+ * Normalize whitespace in text
32
+ * @param text - Input text
33
+ * @returns Normalized text
34
+ */
35
+ export function normalizeWhitespace(text: string): string {
36
+ return text
37
+ .replace(/\r\n/g, '\n')
38
+ .replace(/\t/g, ' ')
39
+ .replace(/ +/g, ' ')
40
+ .trim();
41
+ }
42
+
43
+ /**
44
+ * Escape XML special characters
45
+ * @param str - Input string
46
+ * @returns XML-safe string
47
+ */
48
+ export function escapeXml(str: string): string {
49
+ return str
50
+ .replace(/&/g, '&amp;')
51
+ .replace(/</g, '&lt;')
52
+ .replace(/>/g, '&gt;')
53
+ .replace(/"/g, '&quot;')
54
+ .replace(/'/g, '&apos;');
55
+ }
56
+
57
+ /**
58
+ * Escape LaTeX special characters
59
+ * @param text - Text to escape
60
+ * @returns Escaped text
61
+ */
62
+ export function escapeLatex(text: string): string {
63
+ return text
64
+ .replace(/\\/g, '\\textbackslash{}')
65
+ .replace(/([#$%&_{}])/g, '\\$1')
66
+ .replace(/\^/g, '\\textasciicircum{}')
67
+ .replace(/~/g, '\\textasciitilde{}')
68
+ .replace(/\n/g, ' ');
69
+ }