docrev 0.10.1 → 0.11.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 (167) hide show
  1. package/.gitattributes +1 -1
  2. package/CHANGELOG.md +184 -173
  3. package/PLAN-tables-and-postprocess.md +850 -850
  4. package/README.md +431 -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/anchor-match.d.ts +4 -2
  11. package/dist/lib/anchor-match.d.ts.map +1 -1
  12. package/dist/lib/anchor-match.js +52 -24
  13. package/dist/lib/anchor-match.js.map +1 -1
  14. package/dist/lib/annotations.d.ts +0 -6
  15. package/dist/lib/annotations.d.ts.map +1 -1
  16. package/dist/lib/annotations.js +26 -8
  17. package/dist/lib/annotations.js.map +1 -1
  18. package/dist/lib/build.d.ts.map +1 -1
  19. package/dist/lib/build.js +13 -10
  20. package/dist/lib/build.js.map +1 -1
  21. package/dist/lib/commands/build.d.ts.map +1 -1
  22. package/dist/lib/commands/build.js +5 -0
  23. package/dist/lib/commands/build.js.map +1 -1
  24. package/dist/lib/commands/doi.d.ts.map +1 -1
  25. package/dist/lib/commands/doi.js +14 -2
  26. package/dist/lib/commands/doi.js.map +1 -1
  27. package/dist/lib/commands/sync.d.ts.map +1 -1
  28. package/dist/lib/commands/sync.js +98 -107
  29. package/dist/lib/commands/sync.js.map +1 -1
  30. package/dist/lib/commands/utilities.js +164 -164
  31. package/dist/lib/commands/word-tools.js +8 -8
  32. package/dist/lib/comment-realign.d.ts +12 -21
  33. package/dist/lib/comment-realign.d.ts.map +1 -1
  34. package/dist/lib/comment-realign.js +40 -348
  35. package/dist/lib/comment-realign.js.map +1 -1
  36. package/dist/lib/dependencies.d.ts +10 -0
  37. package/dist/lib/dependencies.d.ts.map +1 -1
  38. package/dist/lib/dependencies.js +41 -9
  39. package/dist/lib/dependencies.js.map +1 -1
  40. package/dist/lib/doi.d.ts.map +1 -1
  41. package/dist/lib/doi.js +68 -80
  42. package/dist/lib/doi.js.map +1 -1
  43. package/dist/lib/errors.d.ts.map +1 -1
  44. package/dist/lib/errors.js +3 -1
  45. package/dist/lib/errors.js.map +1 -1
  46. package/dist/lib/grammar.js +3 -3
  47. package/dist/lib/import.d.ts +7 -4
  48. package/dist/lib/import.d.ts.map +1 -1
  49. package/dist/lib/import.js +58 -62
  50. package/dist/lib/import.js.map +1 -1
  51. package/dist/lib/macro-filter.lua +201 -201
  52. package/dist/lib/ooxml.d.ts +207 -0
  53. package/dist/lib/ooxml.d.ts.map +1 -0
  54. package/dist/lib/ooxml.js +634 -0
  55. package/dist/lib/ooxml.js.map +1 -0
  56. package/dist/lib/pdf-comments.js +44 -44
  57. package/dist/lib/plugins.js +57 -57
  58. package/dist/lib/pptx-color-filter.lua +37 -37
  59. package/dist/lib/pptx-themes.js +115 -115
  60. package/dist/lib/rate-limiter.d.ts +8 -0
  61. package/dist/lib/rate-limiter.d.ts.map +1 -1
  62. package/dist/lib/rate-limiter.js +41 -4
  63. package/dist/lib/rate-limiter.js.map +1 -1
  64. package/dist/lib/sections.d.ts.map +1 -1
  65. package/dist/lib/sections.js +5 -2
  66. package/dist/lib/sections.js.map +1 -1
  67. package/dist/lib/spelling.js +2 -2
  68. package/dist/lib/templates.js +387 -387
  69. package/dist/lib/themes.js +51 -51
  70. package/dist/lib/types.d.ts +9 -1
  71. package/dist/lib/types.d.ts.map +1 -1
  72. package/dist/lib/word-extraction.d.ts.map +1 -1
  73. package/dist/lib/word-extraction.js +48 -307
  74. package/dist/lib/word-extraction.js.map +1 -1
  75. package/dist/lib/word.d.ts.map +1 -1
  76. package/dist/lib/word.js +80 -175
  77. package/dist/lib/word.js.map +1 -1
  78. package/dist/lib/wordcomments.d.ts.map +1 -1
  79. package/dist/lib/wordcomments.js +53 -92
  80. package/dist/lib/wordcomments.js.map +1 -1
  81. package/docs-src/build.py +113 -113
  82. package/docs-src/extra.css +208 -208
  83. package/docs-src/md-to-html.lua +6 -6
  84. package/docs-src/template.html +116 -116
  85. package/eslint.config.js +27 -27
  86. package/lib/anchor-match.ts +307 -276
  87. package/lib/annotations.ts +664 -644
  88. package/lib/build.ts +1770 -1766
  89. package/lib/citations.ts +160 -160
  90. package/lib/commands/build.ts +860 -855
  91. package/lib/commands/citations.ts +515 -515
  92. package/lib/commands/comments.ts +1050 -1050
  93. package/lib/commands/context.ts +176 -176
  94. package/lib/commands/core.ts +309 -309
  95. package/lib/commands/doi.ts +451 -435
  96. package/lib/commands/file-ops.ts +372 -372
  97. package/lib/commands/history.ts +320 -320
  98. package/lib/commands/index.ts +87 -87
  99. package/lib/commands/init.ts +259 -259
  100. package/lib/commands/merge-resolve.ts +378 -378
  101. package/lib/commands/preview.ts +178 -178
  102. package/lib/commands/project-info.ts +244 -244
  103. package/lib/commands/quality.ts +517 -517
  104. package/lib/commands/response.ts +454 -454
  105. package/lib/commands/section-boundaries.ts +82 -82
  106. package/lib/commands/sections.ts +451 -451
  107. package/lib/commands/sync.ts +689 -709
  108. package/lib/commands/text-ops.ts +449 -449
  109. package/lib/commands/utilities.ts +448 -448
  110. package/lib/commands/verify-anchors.ts +272 -272
  111. package/lib/commands/word-tools.ts +340 -340
  112. package/lib/comment-realign.ts +99 -517
  113. package/lib/config.ts +84 -84
  114. package/lib/crossref.ts +781 -781
  115. package/lib/csl.ts +191 -191
  116. package/lib/dependencies.ts +132 -98
  117. package/lib/diff-engine.ts +465 -465
  118. package/lib/doi-cache.ts +115 -115
  119. package/lib/doi.ts +879 -897
  120. package/lib/equations.ts +506 -506
  121. package/lib/errors.ts +350 -346
  122. package/lib/format.ts +541 -541
  123. package/lib/git.ts +326 -326
  124. package/lib/grammar.ts +303 -303
  125. package/lib/image-registry.ts +180 -180
  126. package/lib/import.ts +906 -911
  127. package/lib/journals.ts +543 -543
  128. package/lib/macro-filter.lua +201 -201
  129. package/lib/macros.ts +273 -273
  130. package/lib/merge.ts +633 -633
  131. package/lib/ooxml.ts +768 -0
  132. package/lib/orcid.ts +144 -144
  133. package/lib/pdf-comments.ts +263 -263
  134. package/lib/pdf-import.ts +524 -524
  135. package/lib/plugins.ts +362 -362
  136. package/lib/postprocess.ts +188 -188
  137. package/lib/pptx-color-filter.lua +37 -37
  138. package/lib/pptx-template.ts +469 -469
  139. package/lib/pptx-themes.ts +483 -483
  140. package/lib/protect-restore.ts +520 -520
  141. package/lib/rate-limiter.ts +127 -94
  142. package/lib/response.ts +197 -197
  143. package/lib/restore-references.ts +240 -240
  144. package/lib/review.ts +327 -327
  145. package/lib/schema.ts +488 -488
  146. package/lib/scientific-words.ts +73 -73
  147. package/lib/sections.ts +428 -425
  148. package/lib/slides.ts +756 -756
  149. package/lib/spelling.ts +334 -334
  150. package/lib/templates.ts +526 -526
  151. package/lib/themes.ts +742 -742
  152. package/lib/trackchanges.ts +247 -247
  153. package/lib/tui.ts +450 -450
  154. package/lib/types.ts +558 -550
  155. package/lib/undo.ts +250 -250
  156. package/lib/utils.ts +69 -69
  157. package/lib/variables.ts +179 -179
  158. package/lib/word-extraction.ts +525 -806
  159. package/lib/word.ts +526 -643
  160. package/lib/wordcomments.ts +789 -840
  161. package/mkdocs.yml +64 -64
  162. package/package.json +137 -137
  163. package/scripts/postbuild.js +47 -47
  164. package/skill/REFERENCE.md +539 -539
  165. package/skill/SKILL.md +295 -295
  166. package/tsconfig.json +26 -26
  167. package/types/index.d.ts +525 -525
@@ -1,94 +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
- }
11
-
12
- export class RateLimiter {
13
- private minDelay: number;
14
- private maxDelay: number;
15
- private maxRetries: number;
16
- private backoffFactor: number;
17
- private lastRequestTime: number;
18
- private currentDelay: number;
19
- private consecutiveErrors: number;
20
-
21
- constructor(options: RateLimiterOptions = {}) {
22
- this.minDelay = options.minDelay || 100; // Min delay between requests (ms)
23
- this.maxDelay = options.maxDelay || 30000; // Max delay after backoff (ms)
24
- this.maxRetries = options.maxRetries || 3; // Max retry attempts
25
- this.backoffFactor = options.backoffFactor || 2;
26
- this.lastRequestTime = 0;
27
- this.currentDelay = this.minDelay;
28
- this.consecutiveErrors = 0;
29
- }
30
-
31
- async wait(): Promise<void> {
32
- const now = Date.now();
33
- const elapsed = now - this.lastRequestTime;
34
- if (elapsed < this.currentDelay) {
35
- await new Promise(r => setTimeout(r, this.currentDelay - elapsed));
36
- }
37
- this.lastRequestTime = Date.now();
38
- }
39
-
40
- onSuccess(): void {
41
- // Gradually reduce delay on success
42
- this.consecutiveErrors = 0;
43
- this.currentDelay = Math.max(this.minDelay, this.currentDelay / this.backoffFactor);
44
- }
45
-
46
- onError(statusCode: number): boolean {
47
- this.consecutiveErrors++;
48
- // Exponential backoff
49
- if (statusCode === 429 || statusCode >= 500) {
50
- this.currentDelay = Math.min(this.maxDelay, this.currentDelay * this.backoffFactor);
51
- }
52
- return this.consecutiveErrors <= this.maxRetries;
53
- }
54
-
55
- async fetchWithRetry(url: string, options: RequestInit = {}): Promise<Response> {
56
- let lastError: Error | undefined;
57
-
58
- for (let attempt = 0; attempt <= this.maxRetries; attempt++) {
59
- await this.wait();
60
-
61
- try {
62
- const response = await fetch(url, options);
63
-
64
- if (response.status === 429) {
65
- // Rate limited - back off
66
- const retryAfter = response.headers.get('Retry-After');
67
- const delay = retryAfter ? parseInt(retryAfter, 10) * 1000 : this.currentDelay * 2;
68
- this.currentDelay = Math.min(this.maxDelay, delay);
69
- if (!this.onError(429)) break;
70
- continue;
71
- }
72
-
73
- if (response.status >= 500 && attempt < this.maxRetries) {
74
- // Server error - retry with backoff
75
- if (!this.onError(response.status)) break;
76
- continue;
77
- }
78
-
79
- this.onSuccess();
80
- return response;
81
- } catch (err) {
82
- lastError = err as Error;
83
- if (!this.onError(0)) break;
84
- }
85
- }
86
-
87
- throw lastError || new Error('Max retries exceeded');
88
- }
89
- }
90
-
91
- // Shared rate limiters for different APIs
92
- export const crossrefLimiter = new RateLimiter({ minDelay: 100, maxDelay: 10000 });
93
- export const dataciteLimiter = new RateLimiter({ minDelay: 100, maxDelay: 10000 });
94
- 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,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 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 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
+ }