docrev 0.11.1 → 0.11.3

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 (144) hide show
  1. package/.gitattributes +1 -1
  2. package/CHANGELOG.md +207 -197
  3. package/PLAN-tables-and-postprocess.md +850 -850
  4. package/README.md +433 -433
  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/annotations.d.ts.map +1 -1
  11. package/dist/lib/annotations.js +28 -0
  12. package/dist/lib/annotations.js.map +1 -1
  13. package/dist/lib/build.d.ts +28 -0
  14. package/dist/lib/build.d.ts.map +1 -1
  15. package/dist/lib/build.js +81 -4
  16. package/dist/lib/build.js.map +1 -1
  17. package/dist/lib/commands/comments.d.ts.map +1 -1
  18. package/dist/lib/commands/comments.js +58 -28
  19. package/dist/lib/commands/comments.js.map +1 -1
  20. package/dist/lib/commands/context.d.ts +1 -0
  21. package/dist/lib/commands/context.d.ts.map +1 -1
  22. package/dist/lib/commands/context.js +1 -0
  23. package/dist/lib/commands/context.js.map +1 -1
  24. package/dist/lib/commands/core.d.ts.map +1 -1
  25. package/dist/lib/commands/core.js +25 -8
  26. package/dist/lib/commands/core.js.map +1 -1
  27. package/dist/lib/commands/response.js +1 -1
  28. package/dist/lib/commands/response.js.map +1 -1
  29. package/dist/lib/commands/utilities.js +164 -164
  30. package/dist/lib/commands/word-tools.js +8 -8
  31. package/dist/lib/grammar.js +3 -3
  32. package/dist/lib/import.d.ts +14 -0
  33. package/dist/lib/import.d.ts.map +1 -1
  34. package/dist/lib/import.js +23 -0
  35. package/dist/lib/import.js.map +1 -1
  36. package/dist/lib/input.d.ts +67 -0
  37. package/dist/lib/input.d.ts.map +1 -0
  38. package/dist/lib/input.js +164 -0
  39. package/dist/lib/input.js.map +1 -0
  40. package/dist/lib/macro-filter.lua +201 -201
  41. package/dist/lib/pdf-comments.js +44 -44
  42. package/dist/lib/plugins.js +57 -57
  43. package/dist/lib/pptx-color-filter.lua +37 -37
  44. package/dist/lib/pptx-themes.js +115 -115
  45. package/dist/lib/response.d.ts +1 -1
  46. package/dist/lib/response.d.ts.map +1 -1
  47. package/dist/lib/response.js +5 -2
  48. package/dist/lib/response.js.map +1 -1
  49. package/dist/lib/schema.d.ts.map +1 -1
  50. package/dist/lib/schema.js +8 -2
  51. package/dist/lib/schema.js.map +1 -1
  52. package/dist/lib/spelling.js +2 -2
  53. package/dist/lib/templates.js +387 -387
  54. package/dist/lib/themes.js +51 -51
  55. package/eslint.config.js +27 -27
  56. package/lib/anchor-match.ts +307 -307
  57. package/lib/annotations.ts +695 -664
  58. package/lib/build.ts +2047 -1956
  59. package/lib/citations.ts +160 -160
  60. package/lib/commands/build.ts +885 -885
  61. package/lib/commands/citations.ts +515 -515
  62. package/lib/commands/comments.ts +1077 -1050
  63. package/lib/commands/context.ts +185 -176
  64. package/lib/commands/core.ts +328 -309
  65. package/lib/commands/doi.ts +451 -451
  66. package/lib/commands/file-ops.ts +372 -372
  67. package/lib/commands/history.ts +320 -320
  68. package/lib/commands/index.ts +87 -87
  69. package/lib/commands/init.ts +259 -259
  70. package/lib/commands/merge-resolve.ts +378 -378
  71. package/lib/commands/preview.ts +178 -178
  72. package/lib/commands/project-info.ts +244 -244
  73. package/lib/commands/quality.ts +517 -517
  74. package/lib/commands/response.ts +454 -454
  75. package/lib/commands/section-boundaries.ts +82 -82
  76. package/lib/commands/sections.ts +451 -451
  77. package/lib/commands/sync.ts +689 -689
  78. package/lib/commands/text-ops.ts +449 -449
  79. package/lib/commands/utilities.ts +448 -448
  80. package/lib/commands/verify-anchors.ts +272 -272
  81. package/lib/commands/word-tools.ts +340 -340
  82. package/lib/comment-realign.ts +99 -99
  83. package/lib/config.ts +84 -84
  84. package/lib/crossref.ts +781 -781
  85. package/lib/csl.ts +191 -191
  86. package/lib/dependencies.ts +132 -132
  87. package/lib/diff-engine.ts +465 -465
  88. package/lib/doi-cache.ts +115 -115
  89. package/lib/doi.ts +879 -879
  90. package/lib/equations.ts +506 -506
  91. package/lib/errors.ts +350 -350
  92. package/lib/format.ts +541 -541
  93. package/lib/git.ts +326 -326
  94. package/lib/grammar.ts +303 -303
  95. package/lib/image-registry.ts +180 -180
  96. package/lib/import.ts +932 -906
  97. package/lib/input.ts +174 -0
  98. package/lib/journals.ts +543 -543
  99. package/lib/macro-filter.lua +201 -201
  100. package/lib/macros.ts +273 -273
  101. package/lib/merge.ts +633 -633
  102. package/lib/ooxml.ts +768 -768
  103. package/lib/orcid.ts +144 -144
  104. package/lib/pdf-comments.ts +263 -263
  105. package/lib/pdf-import.ts +524 -524
  106. package/lib/plugins.ts +362 -362
  107. package/lib/postprocess.ts +188 -188
  108. package/lib/pptx-color-filter.lua +37 -37
  109. package/lib/pptx-template.ts +469 -469
  110. package/lib/pptx-themes.ts +483 -483
  111. package/lib/protect-restore.ts +520 -520
  112. package/lib/rate-limiter.ts +127 -127
  113. package/lib/response.ts +200 -197
  114. package/lib/restore-references.ts +240 -240
  115. package/lib/review.ts +327 -327
  116. package/lib/schema.ts +494 -488
  117. package/lib/scientific-words.ts +73 -73
  118. package/lib/sections.ts +428 -428
  119. package/lib/slides.ts +756 -756
  120. package/lib/spelling.ts +334 -334
  121. package/lib/templates.ts +526 -526
  122. package/lib/themes.ts +742 -742
  123. package/lib/trackchanges.ts +166 -166
  124. package/lib/tui.ts +450 -450
  125. package/lib/types.ts +546 -546
  126. package/lib/undo.ts +250 -250
  127. package/lib/utils.ts +69 -69
  128. package/lib/variables.ts +179 -179
  129. package/lib/word-extraction.ts +525 -525
  130. package/lib/word.ts +526 -526
  131. package/lib/wordcomments.ts +789 -789
  132. package/package.json +1 -1
  133. package/scripts/postbuild.js +47 -47
  134. package/skill/REFERENCE.md +550 -550
  135. package/skill/SKILL.md +302 -302
  136. package/tsconfig.json +26 -26
  137. package/types/index.d.ts +531 -531
  138. package/issues.md +0 -180
  139. package/site/assets/extra.css +0 -208
  140. package/site/commands.html +0 -926
  141. package/site/configuration.html +0 -469
  142. package/site/index.html +0 -288
  143. package/site/troubleshooting.html +0 -461
  144. package/site/workflow.html +0 -518
@@ -1,127 +1,127 @@
1
- /**
2
- * Rate Limiter - Prevents API abuse with exponential backoff
3
- */
4
-
5
- export interface RateLimiterOptions {
6
- minDelay?: number;
7
- maxDelay?: number;
8
- maxRetries?: number;
9
- backoffFactor?: number;
10
- /** Per-request timeout in ms; a stalled connection aborts instead of hanging. */
11
- requestTimeout?: number;
12
- }
13
-
14
- /**
15
- * Parse an HTTP `Retry-After` header, which may be a delay in seconds or an
16
- * HTTP-date. Returns the delay in milliseconds, or null when unparseable.
17
- */
18
- export function parseRetryAfter(value: string | null, now: number = Date.now()): number | null {
19
- if (!value) return null;
20
- const seconds = Number(value);
21
- if (Number.isFinite(seconds)) return Math.max(0, seconds * 1000);
22
- const date = Date.parse(value);
23
- if (!Number.isNaN(date)) return Math.max(0, date - now);
24
- return null;
25
- }
26
-
27
- export class RateLimiter {
28
- private minDelay: number;
29
- private maxDelay: number;
30
- private maxRetries: number;
31
- private backoffFactor: number;
32
- private requestTimeout: number;
33
- private lastRequestTime: number;
34
- private currentDelay: number;
35
- private consecutiveErrors: number;
36
-
37
- constructor(options: RateLimiterOptions = {}) {
38
- this.minDelay = options.minDelay || 100; // Min delay between requests (ms)
39
- this.maxDelay = options.maxDelay || 30000; // Max delay after backoff (ms)
40
- this.maxRetries = options.maxRetries || 3; // Max retry attempts
41
- this.backoffFactor = options.backoffFactor || 2;
42
- this.requestTimeout = options.requestTimeout || 15000; // Abort a stalled request
43
- this.lastRequestTime = 0;
44
- this.currentDelay = this.minDelay;
45
- this.consecutiveErrors = 0;
46
- }
47
-
48
- async wait(): Promise<void> {
49
- const now = Date.now();
50
- const elapsed = now - this.lastRequestTime;
51
- if (elapsed < this.currentDelay) {
52
- await new Promise(r => setTimeout(r, this.currentDelay - elapsed));
53
- }
54
- this.lastRequestTime = Date.now();
55
- }
56
-
57
- onSuccess(): void {
58
- // Gradually reduce delay on success
59
- this.consecutiveErrors = 0;
60
- this.currentDelay = Math.max(this.minDelay, this.currentDelay / this.backoffFactor);
61
- }
62
-
63
- onError(statusCode: number): boolean {
64
- this.consecutiveErrors++;
65
- // Exponential backoff
66
- if (statusCode === 429 || statusCode >= 500) {
67
- this.currentDelay = Math.min(this.maxDelay, this.currentDelay * this.backoffFactor);
68
- }
69
- return this.consecutiveErrors <= this.maxRetries;
70
- }
71
-
72
- async fetchWithRetry(url: string, options: RequestInit = {}): Promise<Response> {
73
- let lastError: Error | undefined;
74
- const callerSignal = options.signal ?? undefined;
75
-
76
- for (let attempt = 0; attempt <= this.maxRetries; attempt++) {
77
- await this.wait();
78
-
79
- // Bound each attempt so a half-open connection cannot hang the run
80
- // forever; merge the caller's signal so an external cancel still works.
81
- const controller = new AbortController();
82
- const timer = setTimeout(() => controller.abort(new Error('Request timed out')), this.requestTimeout);
83
- const onCallerAbort = () => controller.abort((callerSignal as AbortSignal).reason);
84
- if (callerSignal) {
85
- if (callerSignal.aborted) controller.abort(callerSignal.reason);
86
- else callerSignal.addEventListener('abort', onCallerAbort, { once: true });
87
- }
88
-
89
- try {
90
- const response = await fetch(url, { ...options, signal: controller.signal });
91
-
92
- if (response.status === 429) {
93
- // Rate limited - back off. Retry-After may be seconds or an HTTP-date.
94
- const delay = parseRetryAfter(response.headers.get('Retry-After')) ?? this.currentDelay * 2;
95
- this.currentDelay = Math.min(this.maxDelay, delay);
96
- if (!this.onError(429)) break;
97
- continue;
98
- }
99
-
100
- if (response.status >= 500 && attempt < this.maxRetries) {
101
- // Server error - retry with backoff
102
- if (!this.onError(response.status)) break;
103
- continue;
104
- }
105
-
106
- this.onSuccess();
107
- return response;
108
- } catch (err) {
109
- // A caller-initiated abort is intentional cancellation, not a failure
110
- // to retry around.
111
- if (callerSignal?.aborted) throw err;
112
- lastError = err as Error;
113
- if (!this.onError(0)) break;
114
- } finally {
115
- clearTimeout(timer);
116
- if (callerSignal) callerSignal.removeEventListener('abort', onCallerAbort);
117
- }
118
- }
119
-
120
- throw lastError || new Error('Max retries exceeded');
121
- }
122
- }
123
-
124
- // Shared rate limiters for different APIs
125
- export const crossrefLimiter = new RateLimiter({ minDelay: 100, maxDelay: 10000 });
126
- export const dataciteLimiter = new RateLimiter({ minDelay: 100, maxDelay: 10000 });
127
- export const doiOrgLimiter = new RateLimiter({ minDelay: 200, maxDelay: 15000 });
1
+ /**
2
+ * Rate Limiter - Prevents API abuse with exponential backoff
3
+ */
4
+
5
+ export interface RateLimiterOptions {
6
+ minDelay?: number;
7
+ maxDelay?: number;
8
+ maxRetries?: number;
9
+ backoffFactor?: number;
10
+ /** Per-request timeout in ms; a stalled connection aborts instead of hanging. */
11
+ requestTimeout?: number;
12
+ }
13
+
14
+ /**
15
+ * Parse an HTTP `Retry-After` header, which may be a delay in seconds or an
16
+ * HTTP-date. Returns the delay in milliseconds, or null when unparseable.
17
+ */
18
+ export function parseRetryAfter(value: string | null, now: number = Date.now()): number | null {
19
+ if (!value) return null;
20
+ const seconds = Number(value);
21
+ if (Number.isFinite(seconds)) return Math.max(0, seconds * 1000);
22
+ const date = Date.parse(value);
23
+ if (!Number.isNaN(date)) return Math.max(0, date - now);
24
+ return null;
25
+ }
26
+
27
+ export class RateLimiter {
28
+ private minDelay: number;
29
+ private maxDelay: number;
30
+ private maxRetries: number;
31
+ private backoffFactor: number;
32
+ private requestTimeout: number;
33
+ private lastRequestTime: number;
34
+ private currentDelay: number;
35
+ private consecutiveErrors: number;
36
+
37
+ constructor(options: RateLimiterOptions = {}) {
38
+ this.minDelay = options.minDelay || 100; // Min delay between requests (ms)
39
+ this.maxDelay = options.maxDelay || 30000; // Max delay after backoff (ms)
40
+ this.maxRetries = options.maxRetries || 3; // Max retry attempts
41
+ this.backoffFactor = options.backoffFactor || 2;
42
+ this.requestTimeout = options.requestTimeout || 15000; // Abort a stalled request
43
+ this.lastRequestTime = 0;
44
+ this.currentDelay = this.minDelay;
45
+ this.consecutiveErrors = 0;
46
+ }
47
+
48
+ async wait(): Promise<void> {
49
+ const now = Date.now();
50
+ const elapsed = now - this.lastRequestTime;
51
+ if (elapsed < this.currentDelay) {
52
+ await new Promise(r => setTimeout(r, this.currentDelay - elapsed));
53
+ }
54
+ this.lastRequestTime = Date.now();
55
+ }
56
+
57
+ onSuccess(): void {
58
+ // Gradually reduce delay on success
59
+ this.consecutiveErrors = 0;
60
+ this.currentDelay = Math.max(this.minDelay, this.currentDelay / this.backoffFactor);
61
+ }
62
+
63
+ onError(statusCode: number): boolean {
64
+ this.consecutiveErrors++;
65
+ // Exponential backoff
66
+ if (statusCode === 429 || statusCode >= 500) {
67
+ this.currentDelay = Math.min(this.maxDelay, this.currentDelay * this.backoffFactor);
68
+ }
69
+ return this.consecutiveErrors <= this.maxRetries;
70
+ }
71
+
72
+ async fetchWithRetry(url: string, options: RequestInit = {}): Promise<Response> {
73
+ let lastError: Error | undefined;
74
+ const callerSignal = options.signal ?? undefined;
75
+
76
+ for (let attempt = 0; attempt <= this.maxRetries; attempt++) {
77
+ await this.wait();
78
+
79
+ // Bound each attempt so a half-open connection cannot hang the run
80
+ // forever; merge the caller's signal so an external cancel still works.
81
+ const controller = new AbortController();
82
+ const timer = setTimeout(() => controller.abort(new Error('Request timed out')), this.requestTimeout);
83
+ const onCallerAbort = () => controller.abort((callerSignal as AbortSignal).reason);
84
+ if (callerSignal) {
85
+ if (callerSignal.aborted) controller.abort(callerSignal.reason);
86
+ else callerSignal.addEventListener('abort', onCallerAbort, { once: true });
87
+ }
88
+
89
+ try {
90
+ const response = await fetch(url, { ...options, signal: controller.signal });
91
+
92
+ if (response.status === 429) {
93
+ // Rate limited - back off. Retry-After may be seconds or an HTTP-date.
94
+ const delay = parseRetryAfter(response.headers.get('Retry-After')) ?? this.currentDelay * 2;
95
+ this.currentDelay = Math.min(this.maxDelay, delay);
96
+ if (!this.onError(429)) break;
97
+ continue;
98
+ }
99
+
100
+ if (response.status >= 500 && attempt < this.maxRetries) {
101
+ // Server error - retry with backoff
102
+ if (!this.onError(response.status)) break;
103
+ continue;
104
+ }
105
+
106
+ this.onSuccess();
107
+ return response;
108
+ } catch (err) {
109
+ // A caller-initiated abort is intentional cancellation, not a failure
110
+ // to retry around.
111
+ if (callerSignal?.aborted) throw err;
112
+ lastError = err as Error;
113
+ if (!this.onError(0)) break;
114
+ } finally {
115
+ clearTimeout(timer);
116
+ if (callerSignal) callerSignal.removeEventListener('abort', onCallerAbort);
117
+ }
118
+ }
119
+
120
+ throw lastError || new Error('Max retries exceeded');
121
+ }
122
+ }
123
+
124
+ // Shared rate limiters for different APIs
125
+ export const crossrefLimiter = new RateLimiter({ minDelay: 100, maxDelay: 10000 });
126
+ export const dataciteLimiter = new RateLimiter({ minDelay: 100, maxDelay: 10000 });
127
+ export const doiOrgLimiter = new RateLimiter({ minDelay: 200, maxDelay: 15000 });
package/lib/response.ts CHANGED
@@ -1,197 +1,200 @@
1
- /**
2
- * Response letter generator
3
- * Extract comments and replies from markdown files for journal resubmission
4
- */
5
-
6
- import * as fs from 'fs';
7
- import * as path from 'path';
8
-
9
- interface Reply {
10
- author: string;
11
- text: string;
12
- }
13
-
14
- interface CommentWithReplies {
15
- author: string;
16
- text: string;
17
- replies: Reply[];
18
- context: string;
19
- file: string;
20
- line: number;
21
- }
22
-
23
- interface ResponseOptions {
24
- title?: string;
25
- authorName?: string;
26
- includeContext?: boolean;
27
- includeLocation?: boolean;
28
- }
29
-
30
- /**
31
- * Parse a comment with potential replies
32
- * Format: {>>Author: comment<<} {>>Reply Author: reply<<}
33
- */
34
- export function parseCommentsWithReplies(text: string, file: string = ''): CommentWithReplies[] {
35
- const comments: CommentWithReplies[] = [];
36
- const lines = text.split('\n');
37
-
38
- // Pattern for comments: {>>Author: text<<}
39
- const commentPattern = /\{>>([^:]+):\s*([^<]+)<<\}/g;
40
-
41
- for (let lineNum = 0; lineNum < lines.length; lineNum++) {
42
- const line = lines[lineNum];
43
- if (!line) continue;
44
- const matches = [...line.matchAll(commentPattern)];
45
-
46
- if (matches.length === 0) continue;
47
-
48
- // Get context (surrounding text without comments)
49
- const contextLine = line.replace(/\{>>[\s\S]+?<<\}/g, '').trim();
50
- const context = contextLine.slice(0, 100) + (contextLine.length > 100 ? '...' : '');
51
-
52
- // First match is the original comment, rest are replies
53
- const [first, ...rest] = matches;
54
- if (!first || !first[1] || !first[2]) continue;
55
-
56
- comments.push({
57
- author: first[1].trim(),
58
- text: first[2].trim(),
59
- replies: rest.map(m => ({
60
- author: m[1]?.trim() || '',
61
- text: m[2]?.trim() || '',
62
- })),
63
- context,
64
- file,
65
- line: lineNum + 1,
66
- });
67
- }
68
-
69
- return comments;
70
- }
71
-
72
- /**
73
- * Group comments by reviewer
74
- */
75
- export function groupByReviewer(comments: CommentWithReplies[]): Map<string, CommentWithReplies[]> {
76
- const grouped = new Map<string, CommentWithReplies[]>();
77
-
78
- for (const comment of comments) {
79
- const reviewer = comment.author;
80
- if (!grouped.has(reviewer)) {
81
- grouped.set(reviewer, []);
82
- }
83
- grouped.get(reviewer)!.push(comment);
84
- }
85
-
86
- return grouped;
87
- }
88
-
89
- /**
90
- * Generate response letter in Markdown format
91
- */
92
- export function generateResponseLetter(comments: CommentWithReplies[], options: ResponseOptions = {}): string {
93
- const {
94
- title = 'Response to Reviewers',
95
- authorName = 'Author',
96
- includeContext = true,
97
- includeLocation = true,
98
- } = options;
99
-
100
- const lines: string[] = [];
101
- lines.push(`# ${title}`);
102
- lines.push('');
103
- lines.push(`We thank the reviewers for their constructive feedback. Below we address each comment.`);
104
- lines.push('');
105
-
106
- // Group by reviewer
107
- const grouped = groupByReviewer(comments);
108
-
109
- // Sort reviewers (put known reviewer names first, then others)
110
- const reviewers = [...grouped.keys()].sort((a, b) => {
111
- // "Reviewer" names first, then alphabetical
112
- const aIsReviewer = a.toLowerCase().includes('reviewer');
113
- const bIsReviewer = b.toLowerCase().includes('reviewer');
114
- if (aIsReviewer && !bIsReviewer) return -1;
115
- if (!aIsReviewer && bIsReviewer) return 1;
116
- return a.localeCompare(b);
117
- });
118
-
119
- for (const reviewer of reviewers) {
120
- // Skip if this is the author's own comments (replies)
121
- if (reviewer.toLowerCase() === authorName.toLowerCase()) continue;
122
- if (reviewer.toLowerCase() === 'claude') continue;
123
-
124
- const reviewerComments = grouped.get(reviewer)!;
125
- lines.push(`## ${reviewer}`);
126
- lines.push('');
127
-
128
- for (let i = 0; i < reviewerComments.length; i++) {
129
- const c = reviewerComments[i];
130
- if (!c) continue;
131
-
132
- lines.push(`### Comment ${i + 1}`);
133
- if (includeLocation) {
134
- lines.push(`*${c.file}:${c.line}*`);
135
- }
136
- lines.push('');
137
-
138
- // Original comment
139
- lines.push(`> **${c.author}:** ${c.text}`);
140
- lines.push('');
141
-
142
- // Context if available
143
- if (includeContext && c.context) {
144
- lines.push(`*Context:* "${c.context}"`);
145
- lines.push('');
146
- }
147
-
148
- // Replies
149
- if (c.replies.length > 0) {
150
- lines.push('**Response:**');
151
- lines.push('');
152
- for (const reply of c.replies) {
153
- lines.push(`${reply.text}`);
154
- }
155
- } else {
156
- lines.push('**Response:**');
157
- lines.push('');
158
- lines.push('*[TODO: Add response]*');
159
- }
160
- lines.push('');
161
- lines.push('---');
162
- lines.push('');
163
- }
164
- }
165
-
166
- // Summary stats
167
- const totalComments = comments.filter(c =>
168
- !c.author.toLowerCase().includes('claude') &&
169
- c.author.toLowerCase() !== authorName.toLowerCase()
170
- ).length;
171
- const answered = comments.filter(c => c.replies.length > 0).length;
172
-
173
- lines.push('## Summary');
174
- lines.push('');
175
- lines.push(`- Total comments: ${totalComments}`);
176
- lines.push(`- Addressed: ${answered}`);
177
- lines.push(`- Pending: ${totalComments - answered}`);
178
-
179
- return lines.join('\n');
180
- }
181
-
182
- /**
183
- * Collect comments from multiple files
184
- */
185
- export function collectComments(files: string[]): CommentWithReplies[] {
186
- const allComments: CommentWithReplies[] = [];
187
-
188
- for (const file of files) {
189
- if (!fs.existsSync(file)) continue;
190
-
191
- const text = fs.readFileSync(file, 'utf-8');
192
- const comments = parseCommentsWithReplies(text, path.basename(file));
193
- allComments.push(...comments);
194
- }
195
-
196
- return allComments;
197
- }
1
+ /**
2
+ * Response letter generator
3
+ * Extract comments and replies from markdown files for journal resubmission
4
+ */
5
+
6
+ import * as fs from 'fs';
7
+ import * as path from 'path';
8
+
9
+ interface Reply {
10
+ author: string;
11
+ text: string;
12
+ }
13
+
14
+ interface CommentWithReplies {
15
+ author: string;
16
+ text: string;
17
+ replies: Reply[];
18
+ context: string;
19
+ file: string;
20
+ line: number;
21
+ }
22
+
23
+ interface ResponseOptions {
24
+ title?: string;
25
+ authorName?: string;
26
+ includeContext?: boolean;
27
+ includeLocation?: boolean;
28
+ }
29
+
30
+ /**
31
+ * Parse a comment with potential replies
32
+ * Format: {>>Author: comment<<} {>>Reply Author: reply<<}
33
+ */
34
+ export function parseCommentsWithReplies(text: string, file: string = ''): CommentWithReplies[] {
35
+ const comments: CommentWithReplies[] = [];
36
+ const lines = text.split('\n');
37
+
38
+ // Pattern for comments: {>>Author: text<<}
39
+ const commentPattern = /\{>>([^:]+):\s*([^<]+)<<\}/g;
40
+
41
+ for (let lineNum = 0; lineNum < lines.length; lineNum++) {
42
+ const line = lines[lineNum];
43
+ if (!line) continue;
44
+ const matches = [...line.matchAll(commentPattern)];
45
+
46
+ if (matches.length === 0) continue;
47
+
48
+ // Get context (surrounding text without comments)
49
+ const contextLine = line.replace(/\{>>[\s\S]+?<<\}/g, '').trim();
50
+ const context = contextLine.slice(0, 100) + (contextLine.length > 100 ? '...' : '');
51
+
52
+ // First match is the original comment, rest are replies
53
+ const [first, ...rest] = matches;
54
+ if (!first || !first[1] || !first[2]) continue;
55
+
56
+ comments.push({
57
+ author: first[1].trim(),
58
+ text: first[2].trim(),
59
+ replies: rest.map(m => ({
60
+ author: m[1]?.trim() || '',
61
+ text: m[2]?.trim() || '',
62
+ })),
63
+ context,
64
+ file,
65
+ line: lineNum + 1,
66
+ });
67
+ }
68
+
69
+ return comments;
70
+ }
71
+
72
+ /**
73
+ * Group comments by reviewer
74
+ */
75
+ export function groupByReviewer(comments: CommentWithReplies[]): Map<string, CommentWithReplies[]> {
76
+ const grouped = new Map<string, CommentWithReplies[]>();
77
+
78
+ for (const comment of comments) {
79
+ const reviewer = comment.author;
80
+ if (!grouped.has(reviewer)) {
81
+ grouped.set(reviewer, []);
82
+ }
83
+ grouped.get(reviewer)!.push(comment);
84
+ }
85
+
86
+ return grouped;
87
+ }
88
+
89
+ /**
90
+ * Generate response letter in Markdown format
91
+ */
92
+ export function generateResponseLetter(comments: CommentWithReplies[], options: ResponseOptions = {}): string {
93
+ const {
94
+ title = 'Response to Reviewers',
95
+ authorName = 'Author',
96
+ includeContext = true,
97
+ includeLocation = true,
98
+ } = options;
99
+
100
+ const lines: string[] = [];
101
+ lines.push(`# ${title}`);
102
+ lines.push('');
103
+ lines.push(`We thank the reviewers for their constructive feedback. Below we address each comment.`);
104
+ lines.push('');
105
+
106
+ // Group by reviewer
107
+ const grouped = groupByReviewer(comments);
108
+
109
+ // Sort reviewers (put known reviewer names first, then others)
110
+ const reviewers = [...grouped.keys()].sort((a, b) => {
111
+ // "Reviewer" names first, then alphabetical
112
+ const aIsReviewer = a.toLowerCase().includes('reviewer');
113
+ const bIsReviewer = b.toLowerCase().includes('reviewer');
114
+ if (aIsReviewer && !bIsReviewer) return -1;
115
+ if (!aIsReviewer && bIsReviewer) return 1;
116
+ return a.localeCompare(b);
117
+ });
118
+
119
+ for (const reviewer of reviewers) {
120
+ // Skip if this is the author's own comments (replies)
121
+ if (reviewer.toLowerCase() === authorName.toLowerCase()) continue;
122
+ if (reviewer.toLowerCase() === 'claude') continue;
123
+
124
+ const reviewerComments = grouped.get(reviewer)!;
125
+ lines.push(`## ${reviewer}`);
126
+ lines.push('');
127
+
128
+ for (let i = 0; i < reviewerComments.length; i++) {
129
+ const c = reviewerComments[i];
130
+ if (!c) continue;
131
+
132
+ lines.push(`### Comment ${i + 1}`);
133
+ if (includeLocation) {
134
+ lines.push(`*${c.file}:${c.line}*`);
135
+ }
136
+ lines.push('');
137
+
138
+ // Original comment
139
+ lines.push(`> **${c.author}:** ${c.text}`);
140
+ lines.push('');
141
+
142
+ // Context if available
143
+ if (includeContext && c.context) {
144
+ lines.push(`*Context:* "${c.context}"`);
145
+ lines.push('');
146
+ }
147
+
148
+ // Replies
149
+ if (c.replies.length > 0) {
150
+ lines.push('**Response:**');
151
+ lines.push('');
152
+ for (const reply of c.replies) {
153
+ lines.push(`${reply.text}`);
154
+ }
155
+ } else {
156
+ lines.push('**Response:**');
157
+ lines.push('');
158
+ lines.push('*[TODO: Add response]*');
159
+ }
160
+ lines.push('');
161
+ lines.push('---');
162
+ lines.push('');
163
+ }
164
+ }
165
+
166
+ // Summary stats
167
+ const totalComments = comments.filter(c =>
168
+ !c.author.toLowerCase().includes('claude') &&
169
+ c.author.toLowerCase() !== authorName.toLowerCase()
170
+ ).length;
171
+ const answered = comments.filter(c => c.replies.length > 0).length;
172
+
173
+ lines.push('## Summary');
174
+ lines.push('');
175
+ lines.push(`- Total comments: ${totalComments}`);
176
+ lines.push(`- Addressed: ${answered}`);
177
+ lines.push(`- Pending: ${totalComments - answered}`);
178
+
179
+ return lines.join('\n');
180
+ }
181
+
182
+ /**
183
+ * Collect comments from multiple files
184
+ */
185
+ export async function collectComments(files: string[]): Promise<CommentWithReplies[]> {
186
+ const { readAnnotatedInput } = await import('./input.js');
187
+ const allComments: CommentWithReplies[] = [];
188
+
189
+ for (const file of files) {
190
+ if (!fs.existsSync(file)) continue;
191
+
192
+ // Route each file through the shared reader so a returned `.docx` is
193
+ // converted to CriticMarkup first, rather than regexing the binary ZIP.
194
+ const text = await readAnnotatedInput(file);
195
+ const comments = parseCommentsWithReplies(text, path.basename(file));
196
+ allComments.push(...comments);
197
+ }
198
+
199
+ return allComments;
200
+ }