docrev 0.11.3 → 0.12.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 (193) hide show
  1. package/CHANGELOG.md +22 -0
  2. package/LICENSE +21 -0
  3. package/dist/bin/rev.js +29 -21
  4. package/dist/bin/rev.js.map +1 -1
  5. package/dist/lib/build.d.ts +43 -0
  6. package/dist/lib/build.d.ts.map +1 -1
  7. package/dist/lib/build.js +175 -5
  8. package/dist/lib/build.js.map +1 -1
  9. package/dist/lib/commands/build.d.ts.map +1 -1
  10. package/dist/lib/commands/build.js +39 -125
  11. package/dist/lib/commands/build.js.map +1 -1
  12. package/dist/lib/commands/comments.js +3 -3
  13. package/dist/lib/commands/comments.js.map +1 -1
  14. package/dist/lib/commands/context.d.ts +12 -1
  15. package/dist/lib/commands/context.d.ts.map +1 -1
  16. package/dist/lib/commands/context.js +34 -1
  17. package/dist/lib/commands/context.js.map +1 -1
  18. package/dist/lib/commands/merge-resolve.js +1 -1
  19. package/dist/lib/commands/merge-resolve.js.map +1 -1
  20. package/dist/lib/commands/quality.js +2 -2
  21. package/dist/lib/commands/quality.js.map +1 -1
  22. package/dist/lib/commands/sections.js +1 -1
  23. package/dist/lib/commands/sections.js.map +1 -1
  24. package/dist/lib/commands/text-ops.js +1 -1
  25. package/dist/lib/commands/text-ops.js.map +1 -1
  26. package/dist/lib/commands/utilities.d.ts.map +1 -1
  27. package/dist/lib/commands/utilities.js +5 -2
  28. package/dist/lib/commands/utilities.js.map +1 -1
  29. package/dist/lib/commands/word-tools.js +2 -2
  30. package/dist/lib/commands/word-tools.js.map +1 -1
  31. package/dist/lib/crossref.d.ts.map +1 -1
  32. package/dist/lib/crossref.js +12 -41
  33. package/dist/lib/crossref.js.map +1 -1
  34. package/dist/lib/csl.d.ts.map +1 -1
  35. package/dist/lib/csl.js +14 -22
  36. package/dist/lib/csl.js.map +1 -1
  37. package/dist/lib/diff-engine.js +1 -1
  38. package/dist/lib/diff-engine.js.map +1 -1
  39. package/dist/lib/equations.d.ts.map +1 -1
  40. package/dist/lib/equations.js +12 -3
  41. package/dist/lib/equations.js.map +1 -1
  42. package/dist/lib/errors.d.ts.map +1 -1
  43. package/dist/lib/errors.js +1 -30
  44. package/dist/lib/errors.js.map +1 -1
  45. package/dist/lib/image-registry.d.ts.map +1 -1
  46. package/dist/lib/image-registry.js +4 -0
  47. package/dist/lib/image-registry.js.map +1 -1
  48. package/dist/lib/import.d.ts +1 -1
  49. package/dist/lib/import.d.ts.map +1 -1
  50. package/dist/lib/import.js +1 -1
  51. package/dist/lib/import.js.map +1 -1
  52. package/dist/lib/input.d.ts +0 -11
  53. package/dist/lib/input.d.ts.map +1 -1
  54. package/dist/lib/input.js +0 -35
  55. package/dist/lib/input.js.map +1 -1
  56. package/dist/lib/merge.d.ts.map +1 -1
  57. package/dist/lib/merge.js +9 -1
  58. package/dist/lib/merge.js.map +1 -1
  59. package/dist/lib/ooxml.d.ts +22 -0
  60. package/dist/lib/ooxml.d.ts.map +1 -1
  61. package/dist/lib/ooxml.js +130 -0
  62. package/dist/lib/ooxml.js.map +1 -1
  63. package/dist/lib/orcid.d.ts.map +1 -1
  64. package/dist/lib/orcid.js +16 -7
  65. package/dist/lib/orcid.js.map +1 -1
  66. package/dist/lib/plugins.d.ts.map +1 -1
  67. package/dist/lib/plugins.js +8 -4
  68. package/dist/lib/plugins.js.map +1 -1
  69. package/dist/lib/protect-restore.d.ts.map +1 -1
  70. package/dist/lib/protect-restore.js +7 -5
  71. package/dist/lib/protect-restore.js.map +1 -1
  72. package/dist/lib/restore-references.d.ts.map +1 -1
  73. package/dist/lib/restore-references.js +25 -3
  74. package/dist/lib/restore-references.js.map +1 -1
  75. package/dist/lib/schema.d.ts.map +1 -1
  76. package/dist/lib/schema.js +1 -19
  77. package/dist/lib/schema.js.map +1 -1
  78. package/dist/lib/slides.js +1 -1
  79. package/dist/lib/slides.js.map +1 -1
  80. package/dist/lib/spelling.js +1 -1
  81. package/dist/lib/spelling.js.map +1 -1
  82. package/dist/lib/tui.js +0 -1
  83. package/dist/lib/tui.js.map +1 -1
  84. package/dist/lib/utils.d.ts +14 -0
  85. package/dist/lib/utils.d.ts.map +1 -1
  86. package/dist/lib/utils.js +41 -0
  87. package/dist/lib/utils.js.map +1 -1
  88. package/dist/lib/word-extraction.d.ts +5 -5
  89. package/dist/lib/word-extraction.d.ts.map +1 -1
  90. package/dist/lib/word-extraction.js +25 -106
  91. package/dist/lib/word-extraction.js.map +1 -1
  92. package/dist/lib/word.d.ts +14 -38
  93. package/dist/lib/word.d.ts.map +1 -1
  94. package/dist/lib/word.js +24 -179
  95. package/dist/lib/word.js.map +1 -1
  96. package/dist/lib/wordcomments.d.ts.map +1 -1
  97. package/dist/lib/wordcomments.js +9 -7
  98. package/dist/lib/wordcomments.js.map +1 -1
  99. package/package.json +17 -6
  100. package/.gitattributes +0 -1
  101. package/PLAN-tables-and-postprocess.md +0 -850
  102. package/bin/rev.ts +0 -145
  103. package/docs-src/build.py +0 -113
  104. package/docs-src/extra.css +0 -208
  105. package/docs-src/md-to-html.lua +0 -6
  106. package/docs-src/template.html +0 -116
  107. package/eslint.config.js +0 -27
  108. package/lib/anchor-match.ts +0 -307
  109. package/lib/annotations.ts +0 -695
  110. package/lib/build.ts +0 -2047
  111. package/lib/citations.ts +0 -160
  112. package/lib/commands/build.ts +0 -885
  113. package/lib/commands/citations.ts +0 -515
  114. package/lib/commands/comments.ts +0 -1077
  115. package/lib/commands/context.ts +0 -185
  116. package/lib/commands/core.ts +0 -328
  117. package/lib/commands/doi.ts +0 -451
  118. package/lib/commands/file-ops.ts +0 -372
  119. package/lib/commands/history.ts +0 -320
  120. package/lib/commands/index.ts +0 -87
  121. package/lib/commands/init.ts +0 -259
  122. package/lib/commands/merge-resolve.ts +0 -378
  123. package/lib/commands/preview.ts +0 -178
  124. package/lib/commands/project-info.ts +0 -244
  125. package/lib/commands/quality.ts +0 -517
  126. package/lib/commands/response.ts +0 -454
  127. package/lib/commands/section-boundaries.ts +0 -82
  128. package/lib/commands/sections.ts +0 -451
  129. package/lib/commands/sync.ts +0 -689
  130. package/lib/commands/text-ops.ts +0 -449
  131. package/lib/commands/utilities.ts +0 -448
  132. package/lib/commands/verify-anchors.ts +0 -272
  133. package/lib/commands/word-tools.ts +0 -340
  134. package/lib/comment-realign.ts +0 -99
  135. package/lib/config.ts +0 -84
  136. package/lib/crossref.ts +0 -781
  137. package/lib/csl.ts +0 -191
  138. package/lib/dependencies.ts +0 -132
  139. package/lib/diff-engine.ts +0 -465
  140. package/lib/doi-cache.ts +0 -115
  141. package/lib/doi.ts +0 -879
  142. package/lib/equations.ts +0 -506
  143. package/lib/errors.ts +0 -350
  144. package/lib/format.ts +0 -541
  145. package/lib/git.ts +0 -326
  146. package/lib/grammar.ts +0 -303
  147. package/lib/image-registry.ts +0 -180
  148. package/lib/import.ts +0 -932
  149. package/lib/input.ts +0 -174
  150. package/lib/journals.ts +0 -543
  151. package/lib/macro-filter.lua +0 -201
  152. package/lib/macros.ts +0 -273
  153. package/lib/merge.ts +0 -633
  154. package/lib/ooxml.ts +0 -768
  155. package/lib/orcid.ts +0 -144
  156. package/lib/pdf-comments.ts +0 -263
  157. package/lib/pdf-import.ts +0 -524
  158. package/lib/plugins.ts +0 -362
  159. package/lib/postprocess.ts +0 -188
  160. package/lib/pptx-color-filter.lua +0 -37
  161. package/lib/pptx-template.ts +0 -469
  162. package/lib/pptx-themes/academic.pptx +0 -0
  163. package/lib/pptx-themes/corporate.pptx +0 -0
  164. package/lib/pptx-themes/dark.pptx +0 -0
  165. package/lib/pptx-themes/default.pptx +0 -0
  166. package/lib/pptx-themes/minimal.pptx +0 -0
  167. package/lib/pptx-themes/plant.pptx +0 -0
  168. package/lib/pptx-themes.ts +0 -483
  169. package/lib/protect-restore.ts +0 -520
  170. package/lib/rate-limiter.ts +0 -127
  171. package/lib/response.ts +0 -200
  172. package/lib/restore-references.ts +0 -240
  173. package/lib/review.ts +0 -327
  174. package/lib/schema.ts +0 -494
  175. package/lib/scientific-words.ts +0 -73
  176. package/lib/sections.ts +0 -428
  177. package/lib/slides.ts +0 -756
  178. package/lib/spelling.ts +0 -334
  179. package/lib/templates.ts +0 -526
  180. package/lib/themes.ts +0 -742
  181. package/lib/trackchanges.ts +0 -166
  182. package/lib/tui.ts +0 -450
  183. package/lib/types.ts +0 -546
  184. package/lib/undo.ts +0 -250
  185. package/lib/utils.ts +0 -69
  186. package/lib/variables.ts +0 -179
  187. package/lib/word-extraction.ts +0 -525
  188. package/lib/word.ts +0 -526
  189. package/lib/wordcomments.ts +0 -789
  190. package/mkdocs.yml +0 -64
  191. package/scripts/postbuild.js +0 -47
  192. package/tsconfig.json +0 -26
  193. package/types/index.d.ts +0 -531
package/lib/review.ts DELETED
@@ -1,327 +0,0 @@
1
- /**
2
- * Interactive review TUI for track changes
3
- */
4
-
5
- import * as readline from 'readline';
6
- import chalk from 'chalk';
7
- import type { Annotation, Comment } from './types.js';
8
- import { getTrackChanges, getComments, applyDecision } from './annotations.js';
9
-
10
- interface ReviewResult {
11
- text: string;
12
- accepted: number;
13
- rejected: number;
14
- skipped: number;
15
- }
16
-
17
- interface CommentReviewOptions {
18
- author?: string;
19
- addReply?: (text: string, comment: Comment, author: string, replyText: string) => string;
20
- setCommentStatus?: (text: string, comment: Comment, resolved: boolean) => string;
21
- }
22
-
23
- interface CommentReviewResult {
24
- text: string;
25
- resolved: number;
26
- replied: number;
27
- skipped: number;
28
- }
29
-
30
- /**
31
- * Format an annotation for display
32
- */
33
- function formatAnnotation(annotation: Annotation, index: number, total: number): string {
34
- const header = chalk.dim(`─── Change ${index + 1}/${total} (line ${annotation.line}) ───`);
35
-
36
- let action: string;
37
- let display: string;
38
-
39
- switch (annotation.type) {
40
- case 'insert':
41
- action = chalk.green(`+ Insert: "${annotation.content}"`);
42
- display =
43
- chalk.dim(annotation.before || '') +
44
- chalk.green.bold(`[${annotation.content}]`) +
45
- chalk.dim(annotation.after || '');
46
- break;
47
- case 'delete':
48
- action = chalk.red(`- Delete: "${annotation.content}"`);
49
- display =
50
- chalk.dim(annotation.before || '') +
51
- chalk.red.strikethrough(`[${annotation.content}]`) +
52
- chalk.dim(annotation.after || '');
53
- break;
54
- case 'substitute':
55
- action = chalk.yellow(`~ Change: "${annotation.content}" → "${annotation.replacement}"`);
56
- display =
57
- chalk.dim(annotation.before || '') +
58
- chalk.red.strikethrough(`[${annotation.content}]`) +
59
- chalk.dim(' → ') +
60
- chalk.green.bold(`[${annotation.replacement}]`) +
61
- chalk.dim(annotation.after || '');
62
- break;
63
- default:
64
- action = chalk.gray(`? Unknown: "${annotation.content}"`);
65
- display = chalk.dim(annotation.before || '') + chalk.gray(`[${annotation.content}]`) + chalk.dim(annotation.after || '');
66
- }
67
-
68
- return `\n${header}\n\n ${action}\n\n ${display}\n`;
69
- }
70
-
71
- /**
72
- * Prompt for a single keypress
73
- */
74
- function promptKey(prompt: string, validKeys: string[]): Promise<string> {
75
- return new Promise((resolve) => {
76
- const rl = readline.createInterface({
77
- input: process.stdin,
78
- output: process.stdout,
79
- });
80
-
81
- // Enable raw mode for single keypress
82
- if (process.stdin.isTTY) {
83
- process.stdin.setRawMode(true);
84
- }
85
- process.stdin.resume();
86
-
87
- process.stdout.write(prompt);
88
-
89
- process.stdin.once('data', (key: Buffer) => {
90
- const char = key.toString().toLowerCase();
91
-
92
- if (process.stdin.isTTY) {
93
- process.stdin.setRawMode(false);
94
- }
95
- rl.close();
96
-
97
- if (char === '\u0003') {
98
- // Ctrl+C
99
- process.exit(0);
100
- }
101
-
102
- if (validKeys.includes(char)) {
103
- console.log(char);
104
- resolve(char);
105
- } else {
106
- console.log();
107
- resolve(promptKey(prompt, validKeys));
108
- }
109
- });
110
- });
111
- }
112
-
113
- /**
114
- * Run interactive review session
115
- */
116
- export async function interactiveReview(text: string): Promise<ReviewResult> {
117
- const changes = getTrackChanges(text);
118
- const comments = getComments(text);
119
-
120
- if (changes.length === 0) {
121
- console.log(chalk.green('No track changes found.'));
122
- if (comments.length > 0) {
123
- console.log(chalk.yellow(`${comments.length} comment(s) remain in the document.`));
124
- }
125
- return { text, accepted: 0, rejected: 0, skipped: 0 };
126
- }
127
-
128
- console.log(chalk.cyan(`\nFound ${changes.length} track change(s)\n`));
129
-
130
- let accepted = 0;
131
- let rejected = 0;
132
- let skipped = 0;
133
- let currentText = text;
134
-
135
- for (let i = 0; i < changes.length; i++) {
136
- const change = changes[i];
137
- if (!change) continue;
138
- console.log(formatAnnotation(change, i, changes.length));
139
-
140
- const prompt = chalk.dim('[a]ccept [r]eject [s]kip | accept [A]ll reject a[L]l [q]uit: ');
141
- const choice = await promptKey(prompt, ['a', 'r', 's', 'A', 'L', 'q']);
142
-
143
- switch (choice) {
144
- case 'q':
145
- console.log(chalk.yellow('\nAborted. No changes saved.'));
146
- return { text, accepted: 0, rejected: 0, skipped: changes.length };
147
-
148
- case 'A':
149
- // Accept all remaining
150
- for (let j = i; j < changes.length; j++) {
151
- const ch = changes[j];
152
- if (ch) currentText = applyDecision(currentText, ch, true);
153
- }
154
- accepted += changes.length - i;
155
- console.log(chalk.green(`\nAccepted all ${changes.length - i} remaining changes.`));
156
- i = changes.length; // Exit loop
157
- break;
158
-
159
- case 'L':
160
- // Reject all remaining
161
- for (let j = i; j < changes.length; j++) {
162
- const ch = changes[j];
163
- if (ch) currentText = applyDecision(currentText, ch, false);
164
- }
165
- rejected += changes.length - i;
166
- console.log(chalk.red(`\nRejected all ${changes.length - i} remaining changes.`));
167
- i = changes.length; // Exit loop
168
- break;
169
-
170
- case 'a':
171
- currentText = applyDecision(currentText, change, true);
172
- accepted++;
173
- break;
174
-
175
- case 'r':
176
- currentText = applyDecision(currentText, change, false);
177
- rejected++;
178
- break;
179
-
180
- case 's':
181
- skipped++;
182
- break;
183
- }
184
- }
185
-
186
- console.log(chalk.cyan('\n─── Summary ───'));
187
- console.log(chalk.green(`Accepted: ${accepted}`));
188
- console.log(chalk.red(`Rejected: ${rejected}`));
189
- console.log(chalk.yellow(`Skipped: ${skipped}`));
190
-
191
- if (comments.length > 0) {
192
- console.log(chalk.blue(`\n${comments.length} comment(s) preserved.`));
193
- }
194
-
195
- return { text: currentText, accepted, rejected, skipped };
196
- }
197
-
198
- /**
199
- * List all comments
200
- */
201
- export function listComments(text: string): void {
202
- const comments = getComments(text);
203
-
204
- if (comments.length === 0) {
205
- console.log(chalk.green('No comments found.'));
206
- return;
207
- }
208
-
209
- console.log(chalk.cyan(`\nFound ${comments.length} comment(s):\n`));
210
-
211
- for (let i = 0; i < comments.length; i++) {
212
- const c = comments[i];
213
- if (!c) continue;
214
- const author = c.author || 'Anonymous';
215
- const header = chalk.blue(`[${i + 1}] ${author}`) + chalk.dim(` (line ${c.line})`);
216
-
217
- console.log(header);
218
- console.log(` ${c.content}`);
219
- console.log(
220
- chalk.dim(` Context: ...${(c.before || '').slice(-25)}`) +
221
- chalk.yellow('*') +
222
- chalk.dim(`${(c.after || '').slice(0, 25)}...`)
223
- );
224
- console.log();
225
- }
226
- }
227
-
228
- /**
229
- * Format a comment for interactive display
230
- */
231
- function formatComment(comment: Comment, index: number, total: number): string {
232
- const statusIcon = comment.resolved ? chalk.green('✓') : chalk.yellow('○');
233
- const author = comment.author || 'Anonymous';
234
- const header = chalk.dim(`─── Comment ${index + 1}/${total} (line ${comment.line}) ───`);
235
-
236
- const authorLine = chalk.blue(`${author}`) + ` ${statusIcon}`;
237
- const context = chalk.dim(`Context: "...${(comment.before || '').slice(-40)}"`);
238
-
239
- return `\n${header}\n\n ${authorLine}\n ${comment.content}\n\n ${context}\n`;
240
- }
241
-
242
- /**
243
- * Run interactive comment review session
244
- */
245
- export async function interactiveCommentReview(text: string, options: CommentReviewOptions = {}): Promise<CommentReviewResult> {
246
- const { author = 'Author', addReply, setCommentStatus } = options;
247
- const comments = getComments(text, { pendingOnly: true }) as Comment[];
248
-
249
- if (comments.length === 0) {
250
- console.log(chalk.green('No pending comments found.'));
251
- return { text, resolved: 0, replied: 0, skipped: 0 };
252
- }
253
-
254
- console.log(chalk.cyan(`\nReviewing ${comments.length} pending comment(s) as ${chalk.bold(author)}\n`));
255
-
256
- let resolved = 0;
257
- let replied = 0;
258
- let skipped = 0;
259
- let currentText = text;
260
-
261
- for (let i = 0; i < comments.length; i++) {
262
- const comment = comments[i];
263
- if (!comment) continue;
264
- console.log(formatComment(comment, i, comments.length));
265
-
266
- const prompt = chalk.dim('[r]eply [m]ark resolved [s]kip | resolve [A]ll [q]uit: ');
267
- const choice = await promptKey(prompt, ['r', 'm', 's', 'A', 'q']);
268
-
269
- switch (choice) {
270
- case 'q':
271
- console.log(chalk.yellow('\nAborted.'));
272
- return { text: currentText, resolved, replied, skipped: comments.length - i };
273
-
274
- case 'A':
275
- // Resolve all remaining
276
- for (let j = i; j < comments.length; j++) {
277
- const c = comments[j];
278
- if (setCommentStatus && c) {
279
- currentText = setCommentStatus(currentText, c, true);
280
- }
281
- }
282
- resolved += comments.length - i;
283
- console.log(chalk.green(`\nResolved all ${comments.length - i} remaining comments.`));
284
- i = comments.length;
285
- break;
286
-
287
- case 'm':
288
- if (setCommentStatus) {
289
- currentText = setCommentStatus(currentText, comment, true);
290
- }
291
- resolved++;
292
- console.log(chalk.green(' Marked as resolved'));
293
- break;
294
-
295
- case 'r':
296
- // Get reply text
297
- const rl = readline.createInterface({
298
- input: process.stdin,
299
- output: process.stdout,
300
- });
301
- const replyText = await new Promise<string>((resolve) => {
302
- rl.question(chalk.cyan(' Reply: '), resolve);
303
- });
304
- rl.close();
305
-
306
- if (replyText.trim() && addReply) {
307
- currentText = addReply(currentText, comment, author, replyText.trim());
308
- replied++;
309
- console.log(chalk.green(' Reply added'));
310
- } else {
311
- console.log(chalk.dim(' No reply added'));
312
- }
313
- break;
314
-
315
- case 's':
316
- skipped++;
317
- break;
318
- }
319
- }
320
-
321
- console.log(chalk.cyan('\n─── Summary ───'));
322
- console.log(chalk.green(`Resolved: ${resolved}`));
323
- console.log(chalk.blue(`Replied: ${replied}`));
324
- console.log(chalk.yellow(`Skipped: ${skipped}`));
325
-
326
- return { text: currentText, resolved, replied, skipped };
327
- }