docrev 0.9.13 → 0.9.14

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 (126) hide show
  1. package/.claude/settings.local.json +9 -9
  2. package/.gitattributes +1 -1
  3. package/CHANGELOG.md +149 -149
  4. package/PLAN-tables-and-postprocess.md +850 -850
  5. package/README.md +391 -391
  6. package/bin/rev.js +11 -11
  7. package/bin/rev.ts +145 -145
  8. package/completions/rev.bash +127 -127
  9. package/completions/rev.ps1 +210 -210
  10. package/completions/rev.zsh +207 -207
  11. package/dev_notes/stress2/build_adversarial.ts +186 -186
  12. package/dev_notes/stress2/drift_matcher.ts +62 -62
  13. package/dev_notes/stress2/probe_anchors.ts +35 -35
  14. package/dev_notes/stress2/project/discussion.before.md +3 -3
  15. package/dev_notes/stress2/project/discussion.md +3 -3
  16. package/dev_notes/stress2/project/methods.before.md +20 -20
  17. package/dev_notes/stress2/project/methods.md +20 -20
  18. package/dev_notes/stress2/project/rev.yaml +5 -5
  19. package/dev_notes/stress2/project/sections.yaml +4 -4
  20. package/dev_notes/stress2/sections.yaml +5 -5
  21. package/dev_notes/stress2/trace_placement.ts +50 -50
  22. package/dev_notes/stresstest_boundaries.ts +27 -27
  23. package/dev_notes/stresstest_drift_apply.ts +43 -43
  24. package/dev_notes/stresstest_drift_compare.ts +43 -43
  25. package/dev_notes/stresstest_drift_v2.ts +54 -54
  26. package/dev_notes/stresstest_inspect.ts +54 -54
  27. package/dev_notes/stresstest_pstyle.ts +55 -55
  28. package/dev_notes/stresstest_section_debug.ts +23 -23
  29. package/dev_notes/stresstest_split.ts +70 -70
  30. package/dev_notes/stresstest_trace.ts +19 -19
  31. package/dev_notes/stresstest_verify_no_overwrite.ts +40 -40
  32. package/dist/lib/build.d.ts +38 -1
  33. package/dist/lib/build.d.ts.map +1 -1
  34. package/dist/lib/build.js +68 -30
  35. package/dist/lib/build.js.map +1 -1
  36. package/dist/lib/commands/build.d.ts.map +1 -1
  37. package/dist/lib/commands/build.js +38 -5
  38. package/dist/lib/commands/build.js.map +1 -1
  39. package/dist/lib/commands/utilities.js +164 -164
  40. package/dist/lib/commands/word-tools.js +8 -8
  41. package/dist/lib/grammar.js +3 -3
  42. package/dist/lib/pdf-comments.js +44 -44
  43. package/dist/lib/plugins.js +57 -57
  44. package/dist/lib/pptx-themes.js +115 -115
  45. package/dist/lib/spelling.js +2 -2
  46. package/dist/lib/templates.js +387 -387
  47. package/dist/lib/themes.js +51 -51
  48. package/eslint.config.js +27 -27
  49. package/lib/anchor-match.ts +276 -276
  50. package/lib/annotations.ts +644 -644
  51. package/lib/build.ts +1300 -1251
  52. package/lib/citations.ts +160 -160
  53. package/lib/commands/build.ts +833 -801
  54. package/lib/commands/citations.ts +515 -515
  55. package/lib/commands/comments.ts +1050 -1050
  56. package/lib/commands/context.ts +174 -174
  57. package/lib/commands/core.ts +309 -309
  58. package/lib/commands/doi.ts +435 -435
  59. package/lib/commands/file-ops.ts +372 -372
  60. package/lib/commands/history.ts +320 -320
  61. package/lib/commands/index.ts +87 -87
  62. package/lib/commands/init.ts +259 -259
  63. package/lib/commands/merge-resolve.ts +378 -378
  64. package/lib/commands/preview.ts +178 -178
  65. package/lib/commands/project-info.ts +244 -244
  66. package/lib/commands/quality.ts +517 -517
  67. package/lib/commands/response.ts +454 -454
  68. package/lib/commands/section-boundaries.ts +82 -82
  69. package/lib/commands/sections.ts +451 -451
  70. package/lib/commands/sync.ts +706 -706
  71. package/lib/commands/text-ops.ts +449 -449
  72. package/lib/commands/utilities.ts +448 -448
  73. package/lib/commands/verify-anchors.ts +272 -272
  74. package/lib/commands/word-tools.ts +340 -340
  75. package/lib/comment-realign.ts +517 -517
  76. package/lib/config.ts +84 -84
  77. package/lib/crossref.ts +781 -781
  78. package/lib/csl.ts +191 -191
  79. package/lib/dependencies.ts +98 -98
  80. package/lib/diff-engine.ts +465 -465
  81. package/lib/doi-cache.ts +115 -115
  82. package/lib/doi.ts +897 -897
  83. package/lib/equations.ts +506 -506
  84. package/lib/errors.ts +346 -346
  85. package/lib/format.ts +541 -541
  86. package/lib/git.ts +326 -326
  87. package/lib/grammar.ts +303 -303
  88. package/lib/image-registry.ts +180 -180
  89. package/lib/import.ts +911 -911
  90. package/lib/journals.ts +543 -543
  91. package/lib/merge.ts +633 -633
  92. package/lib/orcid.ts +144 -144
  93. package/lib/pdf-comments.ts +263 -263
  94. package/lib/pdf-import.ts +524 -524
  95. package/lib/plugins.ts +362 -362
  96. package/lib/postprocess.ts +188 -188
  97. package/lib/pptx-color-filter.lua +37 -37
  98. package/lib/pptx-template.ts +469 -469
  99. package/lib/pptx-themes.ts +483 -483
  100. package/lib/protect-restore.ts +520 -520
  101. package/lib/rate-limiter.ts +94 -94
  102. package/lib/response.ts +197 -197
  103. package/lib/restore-references.ts +240 -240
  104. package/lib/review.ts +327 -327
  105. package/lib/schema.ts +417 -417
  106. package/lib/scientific-words.ts +73 -73
  107. package/lib/sections.ts +335 -335
  108. package/lib/slides.ts +756 -756
  109. package/lib/spelling.ts +334 -334
  110. package/lib/templates.ts +526 -526
  111. package/lib/themes.ts +742 -742
  112. package/lib/trackchanges.ts +247 -247
  113. package/lib/tui.ts +450 -450
  114. package/lib/types.ts +550 -550
  115. package/lib/undo.ts +250 -250
  116. package/lib/utils.ts +69 -69
  117. package/lib/variables.ts +179 -179
  118. package/lib/word-extraction.ts +806 -806
  119. package/lib/word.ts +643 -643
  120. package/lib/wordcomments.ts +817 -817
  121. package/package.json +137 -137
  122. package/scripts/postbuild.js +28 -28
  123. package/skill/REFERENCE.md +431 -431
  124. package/skill/SKILL.md +258 -258
  125. package/tsconfig.json +26 -26
  126. package/types/index.d.ts +525 -525
@@ -1,449 +1,449 @@
1
- /**
2
- * Text operation commands: spelling, batch
3
- *
4
- * Commands for spelling checks and batch operations on markdown files.
5
- */
6
-
7
- import type { Command } from 'commander';
8
- import {
9
- chalk,
10
- fs,
11
- path,
12
- fmt,
13
- findFiles,
14
- loadBuildConfig,
15
- countAnnotations,
16
- getComments,
17
- stripAnnotations,
18
- setCommentStatus,
19
- } from './context.js';
20
-
21
- // Use the actual BuildConfig from build.ts which allows string|Author[]
22
- type BuildConfig = ReturnType<typeof loadBuildConfig>;
23
-
24
- // Options interfaces
25
- interface SpellingOptions {
26
- learn?: string;
27
- learnProject?: string;
28
- forget?: string;
29
- forgetProject?: string;
30
- list?: boolean;
31
- listProject?: boolean;
32
- listAll?: boolean;
33
- british?: boolean;
34
- addNames?: boolean;
35
- }
36
-
37
- interface BatchOptions {
38
- parallel?: boolean;
39
- dryRun?: boolean;
40
- all?: boolean;
41
- }
42
-
43
- // Spelling issue interface
44
- interface SpellingIssue {
45
- word: string;
46
- line: number;
47
- suggestions: string[];
48
- }
49
-
50
- // Spelling result interface
51
- interface SpellingResult {
52
- misspelled: SpellingIssue[];
53
- possibleNames: SpellingIssue[];
54
- }
55
-
56
- // Batch result interface
57
- interface BatchResult {
58
- file: string;
59
- status: string;
60
- annotations?: number;
61
- comments?: number;
62
- pending?: number;
63
- total?: number;
64
- resolved?: number;
65
- stripped?: boolean;
66
- error?: string;
67
- }
68
-
69
- /**
70
- * Register text-ops commands with the program
71
- */
72
- export function register(program: Command): void {
73
- // ==========================================================================
74
- // SPELLING command - Spellcheck with global dictionary
75
- // ==========================================================================
76
-
77
- program
78
- .command('spelling')
79
- .description('Check spelling in markdown files')
80
- .argument('[files...]', 'Files to check (default: section files)')
81
- .option('--learn <word>', 'Add word to global dictionary')
82
- .option('--learn-project <word>', 'Add word to project dictionary')
83
- .option('--forget <word>', 'Remove word from global dictionary')
84
- .option('--forget-project <word>', 'Remove word from project dictionary')
85
- .option('--list', 'List global dictionary words')
86
- .option('--list-project', 'List project dictionary words')
87
- .option('--list-all', 'List all custom words (global + project)')
88
- .option('--british', 'Use British English dictionary')
89
- .option('--add-names', 'Add detected names to global dictionary')
90
- .action(async (files: string[] | undefined, options: SpellingOptions) => {
91
- const spelling = await import('../spelling.js');
92
-
93
- // Handle dictionary management
94
- if (options.learn) {
95
- const added = spelling.addWord(options.learn, true);
96
- if (added) {
97
- console.log(fmt.status('success', `Added "${options.learn}" to global dictionary`));
98
- } else {
99
- console.log(chalk.yellow(`"${options.learn}" already in dictionary`));
100
- }
101
- return;
102
- }
103
-
104
- if (options.learnProject) {
105
- const added = spelling.addWord(options.learnProject, false);
106
- if (added) {
107
- console.log(fmt.status('success', `Added "${options.learnProject}" to project dictionary`));
108
- } else {
109
- console.log(chalk.yellow(`"${options.learnProject}" already in dictionary`));
110
- }
111
- return;
112
- }
113
-
114
- if (options.forget) {
115
- const removed = spelling.removeWord(options.forget, true);
116
- if (removed) {
117
- console.log(fmt.status('success', `Removed "${options.forget}" from global dictionary`));
118
- } else {
119
- console.log(chalk.yellow(`"${options.forget}" not in dictionary`));
120
- }
121
- return;
122
- }
123
-
124
- if (options.forgetProject) {
125
- const removed = spelling.removeWord(options.forgetProject, false);
126
- if (removed) {
127
- console.log(fmt.status('success', `Removed "${options.forgetProject}" from project dictionary`));
128
- } else {
129
- console.log(chalk.yellow(`"${options.forgetProject}" not in dictionary`));
130
- }
131
- return;
132
- }
133
-
134
- if (options.list) {
135
- const words = spelling.listWords(true);
136
- console.log(fmt.header('Global Dictionary'));
137
- if (words.length === 0) {
138
- console.log(chalk.dim(' No custom words'));
139
- console.log(chalk.dim(' Use --learn <word> to add words'));
140
- } else {
141
- for (const word of words) {
142
- console.log(` ${word}`);
143
- }
144
- console.log(chalk.dim(`\n${words.length} word(s)`));
145
- }
146
- return;
147
- }
148
-
149
- if (options.listProject) {
150
- const words = spelling.listWords(false);
151
- console.log(fmt.header('Project Dictionary'));
152
- if (words.length === 0) {
153
- console.log(chalk.dim(' No custom words'));
154
- console.log(chalk.dim(' Use --learn-project <word> to add words'));
155
- } else {
156
- for (const word of words) {
157
- console.log(` ${word}`);
158
- }
159
- console.log(chalk.dim(`\n${words.length} word(s)`));
160
- }
161
- return;
162
- }
163
-
164
- if (options.listAll) {
165
- const globalWords = spelling.listWords(true);
166
- const projectWords = spelling.listWords(false);
167
-
168
- console.log(fmt.header('Global Dictionary'));
169
- if (globalWords.length === 0) {
170
- console.log(chalk.dim(' No custom words'));
171
- } else {
172
- for (const word of globalWords) {
173
- console.log(` ${word}`);
174
- }
175
- }
176
-
177
- console.log(fmt.header('Project Dictionary'));
178
- if (projectWords.length === 0) {
179
- console.log(chalk.dim(' No custom words'));
180
- } else {
181
- for (const word of projectWords) {
182
- console.log(` ${word}`);
183
- }
184
- }
185
-
186
- console.log(chalk.dim(`\nTotal: ${globalWords.length + projectWords.length} word(s)`));
187
- return;
188
- }
189
-
190
- // Check spelling in files
191
- let filesToCheck = files || [];
192
-
193
- if (filesToCheck.length === 0) {
194
- if (fs.existsSync('rev.yaml')) {
195
- try {
196
- const config = loadBuildConfig('.');
197
- filesToCheck = config?.sections || [];
198
- } catch {
199
- // Ignore errors
200
- }
201
- if (filesToCheck.length === 0) {
202
- filesToCheck = fs.readdirSync('.')
203
- .filter(f => f.endsWith('.md') && !f.startsWith('.'));
204
- }
205
- } else {
206
- filesToCheck = fs.readdirSync('.')
207
- .filter(f => f.endsWith('.md') && !f.startsWith('.'));
208
- }
209
- }
210
-
211
- if (filesToCheck.length === 0) {
212
- console.log(chalk.yellow('No markdown files found'));
213
- return;
214
- }
215
-
216
- const lang = options.british ? 'en-gb' : 'en';
217
- console.log(fmt.header(`Spelling Check (${options.british ? 'British' : 'US'} English)`));
218
- let totalMisspelled = 0;
219
- const allNames = new Set<string>();
220
-
221
- for (const file of filesToCheck) {
222
- if (!fs.existsSync(file)) {
223
- console.log(chalk.yellow(`File not found: ${file}`));
224
- continue;
225
- }
226
-
227
- const result = await spelling.checkFile(file, { projectDir: '.', lang }) as SpellingResult;
228
- const { misspelled, possibleNames } = result;
229
-
230
- // Collect names
231
- for (const n of possibleNames) {
232
- allNames.add(n.word);
233
- }
234
-
235
- if (misspelled.length > 0) {
236
- console.log(chalk.cyan(`\n${file}:`));
237
- for (const issue of misspelled) {
238
- const suggestions = issue.suggestions.length > 0
239
- ? chalk.dim(` → ${issue.suggestions.join(', ')}`)
240
- : '';
241
- console.log(` ${chalk.yellow(issue.word)} ${chalk.dim(`(line ${issue.line})`)}${suggestions}`);
242
- }
243
- totalMisspelled += misspelled.length;
244
- }
245
- }
246
-
247
- // Show possible names separately
248
- if (allNames.size > 0) {
249
- const nameList = [...allNames].sort();
250
-
251
- if (options.addNames) {
252
- console.log(fmt.header('Adding Names to Dictionary'));
253
- for (const name of nameList) {
254
- spelling.addWord(name, true);
255
- console.log(chalk.green(` ✓ ${name}`));
256
- }
257
- console.log(chalk.dim(`\nAdded ${nameList.length} name(s) to global dictionary`));
258
- } else {
259
- console.log(fmt.header('Possible Names'));
260
- console.log(chalk.dim(` ${nameList.join(', ')}`));
261
- console.log(chalk.dim(`\n Run with --add-names to add all to dictionary`));
262
- }
263
- }
264
-
265
- if (totalMisspelled === 0 && allNames.size === 0) {
266
- console.log(fmt.status('success', 'No spelling errors found'));
267
- } else {
268
- if (totalMisspelled > 0) {
269
- console.log(chalk.yellow(`\n${totalMisspelled} spelling error(s)`));
270
- }
271
- if (allNames.size > 0) {
272
- console.log(chalk.blue(`${allNames.size} possible name(s)`));
273
- }
274
- console.log(chalk.dim('Use --learn <word> to add words to dictionary'));
275
- }
276
- });
277
-
278
- // ==========================================================================
279
- // BATCH command - Run operations on multiple documents
280
- // ==========================================================================
281
-
282
- program
283
- .command('batch')
284
- .description('Run operations on multiple documents')
285
- .argument('<command>', 'Command to run (status, strip, resolve)')
286
- .argument('[pattern]', 'File pattern (default: *.md)')
287
- .option('--parallel', 'Run operations in parallel')
288
- .option('--dry-run', 'Preview files without running')
289
- .option('-a, --all', 'Include all .md files (not just sections)')
290
- .action(async (command: string, pattern: string | undefined, options: BatchOptions) => {
291
- const validCommands = ['status', 'strip', 'resolve', 'comments'];
292
-
293
- if (!validCommands.includes(command)) {
294
- console.error(fmt.status('error', `Unknown batch command: ${command}`));
295
- console.error(chalk.dim(`Available: ${validCommands.join(', ')}`));
296
- process.exit(1);
297
- }
298
-
299
- // Find files
300
- let files: string[] = [];
301
- if (pattern) {
302
- if (pattern.includes('*')) {
303
- files = fs.readdirSync('.').filter(f =>
304
- f.endsWith('.md') && !['README.md', 'CLAUDE.md', 'paper.md'].includes(f)
305
- );
306
- } else {
307
- files = [pattern];
308
- }
309
- } else {
310
- files = fs.readdirSync('.').filter(f =>
311
- f.endsWith('.md') &&
312
- (options.all || !['README.md', 'CLAUDE.md', 'paper.md'].includes(f))
313
- );
314
- }
315
-
316
- if (files.length === 0) {
317
- console.error(fmt.status('error', 'No files found'));
318
- process.exit(1);
319
- }
320
-
321
- console.log(fmt.header(`Batch ${command} on ${files.length} file(s)`));
322
- console.log();
323
-
324
- if (options.dryRun) {
325
- console.log(chalk.dim('Dry run - files that would be processed:'));
326
- for (const file of files) {
327
- console.log(chalk.dim(` ${file}`));
328
- }
329
- return;
330
- }
331
-
332
- // Process files
333
- const results: BatchResult[] = [];
334
- const progressBar = fmt.progressBar(files.length, 'Processing');
335
- progressBar.update(0);
336
-
337
- for (let i = 0; i < files.length; i++) {
338
- const file = files[i];
339
- progressBar.update(i + 1);
340
-
341
- if (!fs.existsSync(file)) {
342
- results.push({ file, status: 'not found' });
343
- continue;
344
- }
345
-
346
- try {
347
- const text = fs.readFileSync(file, 'utf-8');
348
- let result: BatchResult = { file, status: 'ok' };
349
-
350
- switch (command) {
351
- case 'status': {
352
- const counts = countAnnotations(text);
353
- const comments = getComments(text);
354
- result.annotations = counts.total;
355
- result.comments = comments.length;
356
- result.pending = comments.filter(c => !c.resolved).length;
357
- break;
358
- }
359
-
360
- case 'comments': {
361
- const comments = getComments(text);
362
- result.total = comments.length;
363
- result.pending = comments.filter(c => !c.resolved).length;
364
- result.resolved = comments.filter(c => c.resolved).length;
365
- break;
366
- }
367
-
368
- case 'resolve': {
369
- const comments = getComments(text);
370
- const pending = comments.filter(c => !c.resolved);
371
- if (pending.length > 0) {
372
- let newText = text;
373
- for (const c of pending) {
374
- newText = setCommentStatus(newText, c, true);
375
- }
376
- fs.writeFileSync(file, newText, 'utf-8');
377
- result.resolved = pending.length;
378
- } else {
379
- result.resolved = 0;
380
- }
381
- break;
382
- }
383
-
384
- case 'strip': {
385
- const clean = stripAnnotations(text, { keepComments: false });
386
- const hasChanges = clean !== text;
387
- if (hasChanges) {
388
- fs.writeFileSync(file, clean, 'utf-8');
389
- result.stripped = true;
390
- } else {
391
- result.stripped = false;
392
- }
393
- break;
394
- }
395
- }
396
-
397
- results.push(result);
398
- } catch (err) {
399
- results.push({ file, status: 'error', error: (err as Error).message });
400
- }
401
- }
402
-
403
- progressBar.done();
404
- console.log();
405
-
406
- // Show results
407
- console.log(fmt.header('Results'));
408
- console.log();
409
-
410
- for (const r of results) {
411
- const statusIcon = r.status === 'ok'
412
- ? chalk.green('✓')
413
- : r.status === 'error'
414
- ? chalk.red('✗')
415
- : chalk.yellow('?');
416
-
417
- let details = '';
418
- switch (command) {
419
- case 'status':
420
- details = chalk.dim(`${r.annotations || 0} annotations, ${r.pending || 0} pending comments`);
421
- break;
422
- case 'comments':
423
- details = chalk.dim(`${r.total || 0} total, ${r.pending || 0} pending`);
424
- break;
425
- case 'resolve':
426
- details = r.resolved && r.resolved > 0
427
- ? chalk.green(`${r.resolved} resolved`)
428
- : chalk.dim('no pending');
429
- break;
430
- case 'strip':
431
- details = r.stripped
432
- ? chalk.green('cleaned')
433
- : chalk.dim('no changes');
434
- break;
435
- }
436
-
437
- console.log(` ${statusIcon} ${r.file} ${details}`);
438
- if (r.error) {
439
- console.log(chalk.red(` ${r.error}`));
440
- }
441
- }
442
-
443
- // Summary
444
- console.log();
445
- const successful = results.filter(r => r.status === 'ok').length;
446
- const failed = results.filter(r => r.status === 'error').length;
447
- console.log(chalk.dim(`${successful} succeeded, ${failed} failed`));
448
- });
449
- }
1
+ /**
2
+ * Text operation commands: spelling, batch
3
+ *
4
+ * Commands for spelling checks and batch operations on markdown files.
5
+ */
6
+
7
+ import type { Command } from 'commander';
8
+ import {
9
+ chalk,
10
+ fs,
11
+ path,
12
+ fmt,
13
+ findFiles,
14
+ loadBuildConfig,
15
+ countAnnotations,
16
+ getComments,
17
+ stripAnnotations,
18
+ setCommentStatus,
19
+ } from './context.js';
20
+
21
+ // Use the actual BuildConfig from build.ts which allows string|Author[]
22
+ type BuildConfig = ReturnType<typeof loadBuildConfig>;
23
+
24
+ // Options interfaces
25
+ interface SpellingOptions {
26
+ learn?: string;
27
+ learnProject?: string;
28
+ forget?: string;
29
+ forgetProject?: string;
30
+ list?: boolean;
31
+ listProject?: boolean;
32
+ listAll?: boolean;
33
+ british?: boolean;
34
+ addNames?: boolean;
35
+ }
36
+
37
+ interface BatchOptions {
38
+ parallel?: boolean;
39
+ dryRun?: boolean;
40
+ all?: boolean;
41
+ }
42
+
43
+ // Spelling issue interface
44
+ interface SpellingIssue {
45
+ word: string;
46
+ line: number;
47
+ suggestions: string[];
48
+ }
49
+
50
+ // Spelling result interface
51
+ interface SpellingResult {
52
+ misspelled: SpellingIssue[];
53
+ possibleNames: SpellingIssue[];
54
+ }
55
+
56
+ // Batch result interface
57
+ interface BatchResult {
58
+ file: string;
59
+ status: string;
60
+ annotations?: number;
61
+ comments?: number;
62
+ pending?: number;
63
+ total?: number;
64
+ resolved?: number;
65
+ stripped?: boolean;
66
+ error?: string;
67
+ }
68
+
69
+ /**
70
+ * Register text-ops commands with the program
71
+ */
72
+ export function register(program: Command): void {
73
+ // ==========================================================================
74
+ // SPELLING command - Spellcheck with global dictionary
75
+ // ==========================================================================
76
+
77
+ program
78
+ .command('spelling')
79
+ .description('Check spelling in markdown files')
80
+ .argument('[files...]', 'Files to check (default: section files)')
81
+ .option('--learn <word>', 'Add word to global dictionary')
82
+ .option('--learn-project <word>', 'Add word to project dictionary')
83
+ .option('--forget <word>', 'Remove word from global dictionary')
84
+ .option('--forget-project <word>', 'Remove word from project dictionary')
85
+ .option('--list', 'List global dictionary words')
86
+ .option('--list-project', 'List project dictionary words')
87
+ .option('--list-all', 'List all custom words (global + project)')
88
+ .option('--british', 'Use British English dictionary')
89
+ .option('--add-names', 'Add detected names to global dictionary')
90
+ .action(async (files: string[] | undefined, options: SpellingOptions) => {
91
+ const spelling = await import('../spelling.js');
92
+
93
+ // Handle dictionary management
94
+ if (options.learn) {
95
+ const added = spelling.addWord(options.learn, true);
96
+ if (added) {
97
+ console.log(fmt.status('success', `Added "${options.learn}" to global dictionary`));
98
+ } else {
99
+ console.log(chalk.yellow(`"${options.learn}" already in dictionary`));
100
+ }
101
+ return;
102
+ }
103
+
104
+ if (options.learnProject) {
105
+ const added = spelling.addWord(options.learnProject, false);
106
+ if (added) {
107
+ console.log(fmt.status('success', `Added "${options.learnProject}" to project dictionary`));
108
+ } else {
109
+ console.log(chalk.yellow(`"${options.learnProject}" already in dictionary`));
110
+ }
111
+ return;
112
+ }
113
+
114
+ if (options.forget) {
115
+ const removed = spelling.removeWord(options.forget, true);
116
+ if (removed) {
117
+ console.log(fmt.status('success', `Removed "${options.forget}" from global dictionary`));
118
+ } else {
119
+ console.log(chalk.yellow(`"${options.forget}" not in dictionary`));
120
+ }
121
+ return;
122
+ }
123
+
124
+ if (options.forgetProject) {
125
+ const removed = spelling.removeWord(options.forgetProject, false);
126
+ if (removed) {
127
+ console.log(fmt.status('success', `Removed "${options.forgetProject}" from project dictionary`));
128
+ } else {
129
+ console.log(chalk.yellow(`"${options.forgetProject}" not in dictionary`));
130
+ }
131
+ return;
132
+ }
133
+
134
+ if (options.list) {
135
+ const words = spelling.listWords(true);
136
+ console.log(fmt.header('Global Dictionary'));
137
+ if (words.length === 0) {
138
+ console.log(chalk.dim(' No custom words'));
139
+ console.log(chalk.dim(' Use --learn <word> to add words'));
140
+ } else {
141
+ for (const word of words) {
142
+ console.log(` ${word}`);
143
+ }
144
+ console.log(chalk.dim(`\n${words.length} word(s)`));
145
+ }
146
+ return;
147
+ }
148
+
149
+ if (options.listProject) {
150
+ const words = spelling.listWords(false);
151
+ console.log(fmt.header('Project Dictionary'));
152
+ if (words.length === 0) {
153
+ console.log(chalk.dim(' No custom words'));
154
+ console.log(chalk.dim(' Use --learn-project <word> to add words'));
155
+ } else {
156
+ for (const word of words) {
157
+ console.log(` ${word}`);
158
+ }
159
+ console.log(chalk.dim(`\n${words.length} word(s)`));
160
+ }
161
+ return;
162
+ }
163
+
164
+ if (options.listAll) {
165
+ const globalWords = spelling.listWords(true);
166
+ const projectWords = spelling.listWords(false);
167
+
168
+ console.log(fmt.header('Global Dictionary'));
169
+ if (globalWords.length === 0) {
170
+ console.log(chalk.dim(' No custom words'));
171
+ } else {
172
+ for (const word of globalWords) {
173
+ console.log(` ${word}`);
174
+ }
175
+ }
176
+
177
+ console.log(fmt.header('Project Dictionary'));
178
+ if (projectWords.length === 0) {
179
+ console.log(chalk.dim(' No custom words'));
180
+ } else {
181
+ for (const word of projectWords) {
182
+ console.log(` ${word}`);
183
+ }
184
+ }
185
+
186
+ console.log(chalk.dim(`\nTotal: ${globalWords.length + projectWords.length} word(s)`));
187
+ return;
188
+ }
189
+
190
+ // Check spelling in files
191
+ let filesToCheck = files || [];
192
+
193
+ if (filesToCheck.length === 0) {
194
+ if (fs.existsSync('rev.yaml')) {
195
+ try {
196
+ const config = loadBuildConfig('.');
197
+ filesToCheck = config?.sections || [];
198
+ } catch {
199
+ // Ignore errors
200
+ }
201
+ if (filesToCheck.length === 0) {
202
+ filesToCheck = fs.readdirSync('.')
203
+ .filter(f => f.endsWith('.md') && !f.startsWith('.'));
204
+ }
205
+ } else {
206
+ filesToCheck = fs.readdirSync('.')
207
+ .filter(f => f.endsWith('.md') && !f.startsWith('.'));
208
+ }
209
+ }
210
+
211
+ if (filesToCheck.length === 0) {
212
+ console.log(chalk.yellow('No markdown files found'));
213
+ return;
214
+ }
215
+
216
+ const lang = options.british ? 'en-gb' : 'en';
217
+ console.log(fmt.header(`Spelling Check (${options.british ? 'British' : 'US'} English)`));
218
+ let totalMisspelled = 0;
219
+ const allNames = new Set<string>();
220
+
221
+ for (const file of filesToCheck) {
222
+ if (!fs.existsSync(file)) {
223
+ console.log(chalk.yellow(`File not found: ${file}`));
224
+ continue;
225
+ }
226
+
227
+ const result = await spelling.checkFile(file, { projectDir: '.', lang }) as SpellingResult;
228
+ const { misspelled, possibleNames } = result;
229
+
230
+ // Collect names
231
+ for (const n of possibleNames) {
232
+ allNames.add(n.word);
233
+ }
234
+
235
+ if (misspelled.length > 0) {
236
+ console.log(chalk.cyan(`\n${file}:`));
237
+ for (const issue of misspelled) {
238
+ const suggestions = issue.suggestions.length > 0
239
+ ? chalk.dim(` → ${issue.suggestions.join(', ')}`)
240
+ : '';
241
+ console.log(` ${chalk.yellow(issue.word)} ${chalk.dim(`(line ${issue.line})`)}${suggestions}`);
242
+ }
243
+ totalMisspelled += misspelled.length;
244
+ }
245
+ }
246
+
247
+ // Show possible names separately
248
+ if (allNames.size > 0) {
249
+ const nameList = [...allNames].sort();
250
+
251
+ if (options.addNames) {
252
+ console.log(fmt.header('Adding Names to Dictionary'));
253
+ for (const name of nameList) {
254
+ spelling.addWord(name, true);
255
+ console.log(chalk.green(` ✓ ${name}`));
256
+ }
257
+ console.log(chalk.dim(`\nAdded ${nameList.length} name(s) to global dictionary`));
258
+ } else {
259
+ console.log(fmt.header('Possible Names'));
260
+ console.log(chalk.dim(` ${nameList.join(', ')}`));
261
+ console.log(chalk.dim(`\n Run with --add-names to add all to dictionary`));
262
+ }
263
+ }
264
+
265
+ if (totalMisspelled === 0 && allNames.size === 0) {
266
+ console.log(fmt.status('success', 'No spelling errors found'));
267
+ } else {
268
+ if (totalMisspelled > 0) {
269
+ console.log(chalk.yellow(`\n${totalMisspelled} spelling error(s)`));
270
+ }
271
+ if (allNames.size > 0) {
272
+ console.log(chalk.blue(`${allNames.size} possible name(s)`));
273
+ }
274
+ console.log(chalk.dim('Use --learn <word> to add words to dictionary'));
275
+ }
276
+ });
277
+
278
+ // ==========================================================================
279
+ // BATCH command - Run operations on multiple documents
280
+ // ==========================================================================
281
+
282
+ program
283
+ .command('batch')
284
+ .description('Run operations on multiple documents')
285
+ .argument('<command>', 'Command to run (status, strip, resolve)')
286
+ .argument('[pattern]', 'File pattern (default: *.md)')
287
+ .option('--parallel', 'Run operations in parallel')
288
+ .option('--dry-run', 'Preview files without running')
289
+ .option('-a, --all', 'Include all .md files (not just sections)')
290
+ .action(async (command: string, pattern: string | undefined, options: BatchOptions) => {
291
+ const validCommands = ['status', 'strip', 'resolve', 'comments'];
292
+
293
+ if (!validCommands.includes(command)) {
294
+ console.error(fmt.status('error', `Unknown batch command: ${command}`));
295
+ console.error(chalk.dim(`Available: ${validCommands.join(', ')}`));
296
+ process.exit(1);
297
+ }
298
+
299
+ // Find files
300
+ let files: string[] = [];
301
+ if (pattern) {
302
+ if (pattern.includes('*')) {
303
+ files = fs.readdirSync('.').filter(f =>
304
+ f.endsWith('.md') && !['README.md', 'CLAUDE.md', 'paper.md'].includes(f)
305
+ );
306
+ } else {
307
+ files = [pattern];
308
+ }
309
+ } else {
310
+ files = fs.readdirSync('.').filter(f =>
311
+ f.endsWith('.md') &&
312
+ (options.all || !['README.md', 'CLAUDE.md', 'paper.md'].includes(f))
313
+ );
314
+ }
315
+
316
+ if (files.length === 0) {
317
+ console.error(fmt.status('error', 'No files found'));
318
+ process.exit(1);
319
+ }
320
+
321
+ console.log(fmt.header(`Batch ${command} on ${files.length} file(s)`));
322
+ console.log();
323
+
324
+ if (options.dryRun) {
325
+ console.log(chalk.dim('Dry run - files that would be processed:'));
326
+ for (const file of files) {
327
+ console.log(chalk.dim(` ${file}`));
328
+ }
329
+ return;
330
+ }
331
+
332
+ // Process files
333
+ const results: BatchResult[] = [];
334
+ const progressBar = fmt.progressBar(files.length, 'Processing');
335
+ progressBar.update(0);
336
+
337
+ for (let i = 0; i < files.length; i++) {
338
+ const file = files[i];
339
+ progressBar.update(i + 1);
340
+
341
+ if (!fs.existsSync(file)) {
342
+ results.push({ file, status: 'not found' });
343
+ continue;
344
+ }
345
+
346
+ try {
347
+ const text = fs.readFileSync(file, 'utf-8');
348
+ let result: BatchResult = { file, status: 'ok' };
349
+
350
+ switch (command) {
351
+ case 'status': {
352
+ const counts = countAnnotations(text);
353
+ const comments = getComments(text);
354
+ result.annotations = counts.total;
355
+ result.comments = comments.length;
356
+ result.pending = comments.filter(c => !c.resolved).length;
357
+ break;
358
+ }
359
+
360
+ case 'comments': {
361
+ const comments = getComments(text);
362
+ result.total = comments.length;
363
+ result.pending = comments.filter(c => !c.resolved).length;
364
+ result.resolved = comments.filter(c => c.resolved).length;
365
+ break;
366
+ }
367
+
368
+ case 'resolve': {
369
+ const comments = getComments(text);
370
+ const pending = comments.filter(c => !c.resolved);
371
+ if (pending.length > 0) {
372
+ let newText = text;
373
+ for (const c of pending) {
374
+ newText = setCommentStatus(newText, c, true);
375
+ }
376
+ fs.writeFileSync(file, newText, 'utf-8');
377
+ result.resolved = pending.length;
378
+ } else {
379
+ result.resolved = 0;
380
+ }
381
+ break;
382
+ }
383
+
384
+ case 'strip': {
385
+ const clean = stripAnnotations(text, { keepComments: false });
386
+ const hasChanges = clean !== text;
387
+ if (hasChanges) {
388
+ fs.writeFileSync(file, clean, 'utf-8');
389
+ result.stripped = true;
390
+ } else {
391
+ result.stripped = false;
392
+ }
393
+ break;
394
+ }
395
+ }
396
+
397
+ results.push(result);
398
+ } catch (err) {
399
+ results.push({ file, status: 'error', error: (err as Error).message });
400
+ }
401
+ }
402
+
403
+ progressBar.done();
404
+ console.log();
405
+
406
+ // Show results
407
+ console.log(fmt.header('Results'));
408
+ console.log();
409
+
410
+ for (const r of results) {
411
+ const statusIcon = r.status === 'ok'
412
+ ? chalk.green('✓')
413
+ : r.status === 'error'
414
+ ? chalk.red('✗')
415
+ : chalk.yellow('?');
416
+
417
+ let details = '';
418
+ switch (command) {
419
+ case 'status':
420
+ details = chalk.dim(`${r.annotations || 0} annotations, ${r.pending || 0} pending comments`);
421
+ break;
422
+ case 'comments':
423
+ details = chalk.dim(`${r.total || 0} total, ${r.pending || 0} pending`);
424
+ break;
425
+ case 'resolve':
426
+ details = r.resolved && r.resolved > 0
427
+ ? chalk.green(`${r.resolved} resolved`)
428
+ : chalk.dim('no pending');
429
+ break;
430
+ case 'strip':
431
+ details = r.stripped
432
+ ? chalk.green('cleaned')
433
+ : chalk.dim('no changes');
434
+ break;
435
+ }
436
+
437
+ console.log(` ${statusIcon} ${r.file} ${details}`);
438
+ if (r.error) {
439
+ console.log(chalk.red(` ${r.error}`));
440
+ }
441
+ }
442
+
443
+ // Summary
444
+ console.log();
445
+ const successful = results.filter(r => r.status === 'ok').length;
446
+ const failed = results.filter(r => r.status === 'error').length;
447
+ console.log(chalk.dim(`${successful} succeeded, ${failed} failed`));
448
+ });
449
+ }