docrev 0.10.0 → 0.10.1

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/.gitattributes +1 -1
  2. package/CHANGELOG.md +173 -164
  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 +1 -1
  11. package/dist/lib/anchor-match.d.ts.map +1 -1
  12. package/dist/lib/anchor-match.js +17 -47
  13. package/dist/lib/anchor-match.js.map +1 -1
  14. package/dist/lib/build.js +4 -4
  15. package/dist/lib/commands/context.d.ts +1 -1
  16. package/dist/lib/commands/context.d.ts.map +1 -1
  17. package/dist/lib/commands/context.js +1 -1
  18. package/dist/lib/commands/context.js.map +1 -1
  19. package/dist/lib/commands/sections.js +7 -7
  20. package/dist/lib/commands/sections.js.map +1 -1
  21. package/dist/lib/commands/sync.d.ts.map +1 -1
  22. package/dist/lib/commands/sync.js +15 -14
  23. package/dist/lib/commands/sync.js.map +1 -1
  24. package/dist/lib/commands/utilities.js +164 -164
  25. package/dist/lib/commands/verify-anchors.js +6 -6
  26. package/dist/lib/commands/verify-anchors.js.map +1 -1
  27. package/dist/lib/commands/word-tools.js +8 -8
  28. package/dist/lib/grammar.js +3 -3
  29. package/dist/lib/macro-filter.lua +201 -201
  30. package/dist/lib/pdf-comments.js +44 -44
  31. package/dist/lib/plugins.js +57 -57
  32. package/dist/lib/pptx-color-filter.lua +37 -37
  33. package/dist/lib/pptx-themes.js +115 -115
  34. package/dist/lib/sections.d.ts +35 -0
  35. package/dist/lib/sections.d.ts.map +1 -1
  36. package/dist/lib/sections.js +81 -0
  37. package/dist/lib/sections.js.map +1 -1
  38. package/dist/lib/spelling.js +2 -2
  39. package/dist/lib/templates.js +387 -387
  40. package/dist/lib/themes.js +51 -51
  41. package/docs-src/build.py +113 -113
  42. package/docs-src/extra.css +208 -208
  43. package/docs-src/md-to-html.lua +6 -6
  44. package/docs-src/template.html +116 -116
  45. package/eslint.config.js +27 -27
  46. package/lib/anchor-match.ts +276 -308
  47. package/lib/annotations.ts +644 -644
  48. package/lib/build.ts +1766 -1766
  49. package/lib/citations.ts +160 -160
  50. package/lib/commands/build.ts +855 -855
  51. package/lib/commands/citations.ts +515 -515
  52. package/lib/commands/comments.ts +1050 -1050
  53. package/lib/commands/context.ts +176 -174
  54. package/lib/commands/core.ts +309 -309
  55. package/lib/commands/doi.ts +435 -435
  56. package/lib/commands/file-ops.ts +372 -372
  57. package/lib/commands/history.ts +320 -320
  58. package/lib/commands/index.ts +87 -87
  59. package/lib/commands/init.ts +259 -259
  60. package/lib/commands/merge-resolve.ts +378 -378
  61. package/lib/commands/preview.ts +178 -178
  62. package/lib/commands/project-info.ts +244 -244
  63. package/lib/commands/quality.ts +517 -517
  64. package/lib/commands/response.ts +454 -454
  65. package/lib/commands/section-boundaries.ts +82 -82
  66. package/lib/commands/sections.ts +451 -451
  67. package/lib/commands/sync.ts +709 -706
  68. package/lib/commands/text-ops.ts +449 -449
  69. package/lib/commands/utilities.ts +448 -448
  70. package/lib/commands/verify-anchors.ts +272 -272
  71. package/lib/commands/word-tools.ts +340 -340
  72. package/lib/comment-realign.ts +517 -517
  73. package/lib/config.ts +84 -84
  74. package/lib/crossref.ts +781 -781
  75. package/lib/csl.ts +191 -191
  76. package/lib/dependencies.ts +98 -98
  77. package/lib/diff-engine.ts +465 -465
  78. package/lib/doi-cache.ts +115 -115
  79. package/lib/doi.ts +897 -897
  80. package/lib/equations.ts +506 -506
  81. package/lib/errors.ts +346 -346
  82. package/lib/format.ts +541 -541
  83. package/lib/git.ts +326 -326
  84. package/lib/grammar.ts +303 -303
  85. package/lib/image-registry.ts +180 -180
  86. package/lib/import.ts +911 -911
  87. package/lib/journals.ts +543 -543
  88. package/lib/macro-filter.lua +201 -201
  89. package/lib/macros.ts +273 -273
  90. package/lib/merge.ts +633 -633
  91. package/lib/orcid.ts +144 -144
  92. package/lib/pdf-comments.ts +263 -263
  93. package/lib/pdf-import.ts +524 -524
  94. package/lib/plugins.ts +362 -362
  95. package/lib/postprocess.ts +188 -188
  96. package/lib/pptx-color-filter.lua +37 -37
  97. package/lib/pptx-template.ts +469 -469
  98. package/lib/pptx-themes.ts +483 -483
  99. package/lib/protect-restore.ts +520 -520
  100. package/lib/rate-limiter.ts +94 -94
  101. package/lib/response.ts +197 -197
  102. package/lib/restore-references.ts +240 -240
  103. package/lib/review.ts +327 -327
  104. package/lib/schema.ts +488 -488
  105. package/lib/scientific-words.ts +73 -73
  106. package/lib/sections.ts +425 -335
  107. package/lib/slides.ts +756 -756
  108. package/lib/spelling.ts +334 -334
  109. package/lib/templates.ts +526 -526
  110. package/lib/themes.ts +742 -742
  111. package/lib/trackchanges.ts +247 -247
  112. package/lib/tui.ts +450 -450
  113. package/lib/types.ts +550 -550
  114. package/lib/undo.ts +250 -250
  115. package/lib/utils.ts +69 -69
  116. package/lib/variables.ts +179 -179
  117. package/lib/word-extraction.ts +806 -806
  118. package/lib/word.ts +643 -643
  119. package/lib/wordcomments.ts +840 -840
  120. package/mkdocs.yml +64 -64
  121. package/package.json +137 -137
  122. package/scripts/postbuild.js +47 -47
  123. package/skill/REFERENCE.md +539 -539
  124. package/skill/SKILL.md +295 -295
  125. package/tsconfig.json +26 -26
  126. package/types/index.d.ts +525 -525
@@ -1,435 +1,435 @@
1
- /**
2
- * DOI commands: doi, orcid
3
- *
4
- * Commands for DOI validation, fetching, and ORCID profile lookup.
5
- */
6
-
7
- import {
8
- chalk,
9
- fs,
10
- path,
11
- fmt,
12
- } from './context.js';
13
- import type { Command } from 'commander';
14
-
15
- interface DoiOptions {
16
- bib: string;
17
- strict?: boolean;
18
- resolve?: boolean;
19
- confidence: string;
20
- }
21
-
22
- interface OrcidOptions {
23
- yaml?: boolean;
24
- badge?: boolean;
25
- }
26
-
27
- /**
28
- * Register DOI commands with the program
29
- */
30
- export function register(program: Command): void {
31
- // ==========================================================================
32
- // DOI command - Validate and fetch DOIs
33
- // ==========================================================================
34
-
35
- program
36
- .command('doi')
37
- .description('Validate DOIs in bibliography or fetch citations from DOI')
38
- .argument('<action>', 'Action: check, fetch, add, lookup')
39
- .argument('[input]', 'DOI (for fetch/add) or .bib file (for check)')
40
- .option('-b, --bib <file>', 'Bibliography file', 'references.bib')
41
- .option('--strict', 'Fail on missing DOIs for articles')
42
- .option('--no-resolve', 'Only check format, skip resolution check')
43
- .option('--confidence <level>', 'Minimum confidence: high, medium, low (default: medium)', 'medium')
44
- .action(async (action: string, input: string | undefined, options: DoiOptions) => {
45
- const { parseBibEntries, checkBibDois, fetchBibtex, addToBib, isValidDoiFormat, lookupDoi, lookupMissingDois } = await import('../doi.js');
46
-
47
- if (action === 'check') {
48
- const bibPath = input || options.bib;
49
-
50
- if (!fs.existsSync(bibPath)) {
51
- console.error(fmt.status('error', `File not found: ${bibPath}`));
52
- process.exit(1);
53
- }
54
-
55
- console.log(fmt.header(`DOI Check: ${path.basename(bibPath)}`));
56
- console.log();
57
-
58
- const spin = fmt.spinner('Validating DOIs...').start();
59
-
60
- try {
61
- const results = await checkBibDois(bibPath, {
62
- checkMissing: options.strict,
63
- });
64
-
65
- spin.stop();
66
-
67
- // Group results by status
68
- const valid = results.entries.filter(e => e.status === 'valid');
69
- const invalid = results.entries.filter(e => e.status === 'invalid');
70
- const missing = results.entries.filter(e => e.status === 'missing');
71
- const skipped = results.entries.filter(e => e.status === 'skipped');
72
-
73
- // Summary table
74
- const summaryRows: string[][] = [
75
- [chalk.green('Valid'), chalk.green(valid.length.toString())],
76
- [invalid.length > 0 ? chalk.red('Invalid') : 'Invalid', invalid.length > 0 ? chalk.red(invalid.length.toString()) : '0'],
77
- [missing.length > 0 ? chalk.yellow('Missing (articles)') : 'Missing', missing.length > 0 ? chalk.yellow(missing.length.toString()) : '0'],
78
- [chalk.dim('Skipped'), chalk.dim(skipped.length.toString())],
79
- ];
80
- console.log(fmt.table(['Status', 'Count'], summaryRows));
81
- console.log();
82
-
83
- // Show invalid DOIs
84
- if (invalid.length > 0) {
85
- console.log(chalk.red('Invalid DOIs:'));
86
- for (const e of invalid) {
87
- console.log(` ${chalk.bold(e.key)}: ${e.doi || 'N/A'}`);
88
- console.log(chalk.dim(` ${e.message}`));
89
- }
90
- console.log();
91
- }
92
-
93
- // Show missing (articles without DOI)
94
- if (missing.length > 0) {
95
- console.log(chalk.yellow('Missing DOIs (should have DOI):'));
96
- for (const e of missing) {
97
- console.log(` ${chalk.bold(e.key)} [${e.type}]`);
98
- if (e.title) console.log(chalk.dim(` "${e.title}"`));
99
- }
100
- console.log();
101
- }
102
-
103
- // Show skipped breakdown
104
- if (skipped.length > 0) {
105
- // Count by reason
106
- const manualSkip = skipped.filter(e => e.message === 'Marked as no-doi');
107
- const bookTypes = skipped.filter(e => e.message?.includes('typically has no DOI'));
108
- const noField = skipped.filter(e => e.message === 'No DOI field');
109
-
110
- console.log(chalk.dim('Skipped entries:'));
111
- if (manualSkip.length > 0) {
112
- console.log(chalk.dim(` ${manualSkip.length} marked with nodoi={true}`));
113
- }
114
- if (bookTypes.length > 0) {
115
- const types = [...new Set(bookTypes.map(e => e.type))].join(', ');
116
- console.log(chalk.dim(` ${bookTypes.length} by type (${types})`));
117
- }
118
- if (noField.length > 0) {
119
- console.log(chalk.dim(` ${noField.length} with no DOI field`));
120
- }
121
- console.log();
122
- }
123
-
124
- // Final status
125
- if (invalid.length === 0 && missing.length === 0) {
126
- console.log(fmt.status('success', 'All DOIs valid'));
127
- } else if (invalid.length > 0) {
128
- console.log(fmt.status('error', `${invalid.length} invalid DOI(s) found`));
129
- if (options.strict) process.exit(1);
130
- } else {
131
- console.log(fmt.status('warning', `${missing.length} article(s) missing DOI`));
132
- }
133
-
134
- // Hint about skipping
135
- console.log();
136
- console.log(chalk.dim('To skip DOI check for an entry, add: nodoi = {true}'));
137
- console.log(chalk.dim('Or add comment before entry: % no-doi'));
138
-
139
- } catch (err) {
140
- spin.stop();
141
- const error = err as Error;
142
- console.error(fmt.status('error', error.message));
143
- process.exit(1);
144
- }
145
-
146
- } else if (action === 'fetch') {
147
- if (!input) {
148
- console.error(fmt.status('error', 'DOI required'));
149
- console.log(chalk.dim('Usage: rev doi fetch 10.1234/example'));
150
- process.exit(1);
151
- }
152
-
153
- const spin = fmt.spinner(`Fetching BibTeX for ${input}...`).start();
154
-
155
- try {
156
- const result = await fetchBibtex(input);
157
-
158
- if (result.success) {
159
- spin.success('BibTeX retrieved');
160
- console.log();
161
- console.log(result.bibtex);
162
- } else {
163
- spin.error(result.error!);
164
- process.exit(1);
165
- }
166
- } catch (err) {
167
- const error = err as Error;
168
- spin.error(error.message);
169
- process.exit(1);
170
- }
171
-
172
- } else if (action === 'add') {
173
- if (!input) {
174
- console.error(fmt.status('error', 'DOI required'));
175
- console.log(chalk.dim('Usage: rev doi add 10.1234/example'));
176
- process.exit(1);
177
- }
178
-
179
- const bibPath = options.bib;
180
- const spin = fmt.spinner(`Fetching and adding ${input}...`).start();
181
-
182
- try {
183
- const fetchResult = await fetchBibtex(input);
184
-
185
- if (!fetchResult.success) {
186
- spin.error(fetchResult.error!);
187
- process.exit(1);
188
- }
189
-
190
- const addResult = addToBib(bibPath, fetchResult.bibtex!);
191
-
192
- if (addResult.success) {
193
- spin.success(`Added @${addResult.key} to ${bibPath}`);
194
- } else {
195
- spin.error(addResult.error!);
196
- process.exit(1);
197
- }
198
- } catch (err) {
199
- const error = err as Error;
200
- spin.error(error.message);
201
- process.exit(1);
202
- }
203
-
204
- } else if (action === 'lookup') {
205
- const bibPath = input || options.bib;
206
-
207
- if (!fs.existsSync(bibPath)) {
208
- console.error(fmt.status('error', `File not found: ${bibPath}`));
209
- process.exit(1);
210
- }
211
-
212
- console.log(fmt.header(`DOI Lookup: ${path.basename(bibPath)}`));
213
- console.log();
214
-
215
- const entries = parseBibEntries(bibPath);
216
- const missing = entries.filter(e => !e.doi && !e.skip && e.expectDoi);
217
-
218
- if (missing.length === 0) {
219
- console.log(fmt.status('success', 'No entries need DOI lookup'));
220
- return;
221
- }
222
-
223
- console.log(chalk.dim(`Found ${missing.length} entries without DOIs to search...\n`));
224
-
225
- let found = 0;
226
- let notFound = 0;
227
- let lowConfidence = 0;
228
- const results: Array<{ entry: any; result: any; status: string }> = [];
229
-
230
- for (let i = 0; i < missing.length; i++) {
231
- const entry = missing[i];
232
-
233
- // Extract first author last name
234
- let author = '';
235
- if (entry.authorRaw) {
236
- const firstAuthor = entry.authorRaw.split(' and ')[0];
237
- // Handle "Last, First" or "First Last" formats
238
- if (firstAuthor.includes(',')) {
239
- author = firstAuthor.split(',')[0].trim();
240
- } else {
241
- const parts = firstAuthor.trim().split(/\s+/);
242
- author = parts[parts.length - 1]; // Last word is usually surname
243
- }
244
- }
245
-
246
- process.stdout.write(`\r${chalk.dim(`[${i + 1}/${missing.length}]`)} ${entry.key}...`);
247
-
248
- const result = await lookupDoi(entry.title, author, entry.year, entry.journal);
249
-
250
- if (result.found) {
251
- if (result.confidence === 'high') {
252
- found++;
253
- results.push({ entry, result, status: 'found' });
254
- } else if (result.confidence === 'medium') {
255
- found++;
256
- results.push({ entry, result, status: 'found' });
257
- } else {
258
- lowConfidence++;
259
- results.push({ entry, result, status: 'low' });
260
- }
261
- } else {
262
- notFound++;
263
- results.push({ entry, result, status: 'not-found' });
264
- }
265
-
266
- // Rate limiting
267
- await new Promise(r => setTimeout(r, 200));
268
- }
269
-
270
- // Clear progress line
271
- process.stdout.write('\r\x1B[K');
272
-
273
- // Show results
274
- console.log(fmt.table(
275
- ['Status', 'Count'],
276
- [
277
- [chalk.green('Found (high/medium confidence)'), chalk.green(found.toString())],
278
- [chalk.yellow('Found (low confidence)'), chalk.yellow(lowConfidence.toString())],
279
- [chalk.dim('Not found'), chalk.dim(notFound.toString())],
280
- ]
281
- ));
282
- console.log();
283
-
284
- // Filter by confidence level
285
- const confLevel = options.confidence || 'medium';
286
- const confLevels: Record<string, number> = { high: 3, medium: 2, low: 1 };
287
- const minConf = confLevels[confLevel] || 2;
288
-
289
- const filteredResults = results.filter(r => {
290
- if (r.status === 'not-found') return false;
291
- const resultConf = confLevels[r.result.confidence] || 1;
292
- return resultConf >= minConf;
293
- });
294
-
295
- const hiddenCount = results.filter(r => {
296
- if (r.status === 'not-found') return false;
297
- const resultConf = confLevels[r.result.confidence] || 1;
298
- return resultConf < minConf;
299
- }).length;
300
-
301
- if (filteredResults.length > 0) {
302
- console.log(chalk.cyan(`Found DOIs (${confLevel}+ confidence):`));
303
- console.log();
304
-
305
- for (const { entry, result } of filteredResults) {
306
- const conf = result.confidence === 'high' ? chalk.green('●') :
307
- result.confidence === 'medium' ? chalk.yellow('●') :
308
- chalk.red('○');
309
-
310
- // Check year match
311
- const entryYear = entry.year;
312
- const foundYear = result.metadata?.year;
313
- const yearExact = entryYear && foundYear && entryYear === foundYear;
314
- const yearClose = entryYear && foundYear && Math.abs(entryYear - foundYear) === 1;
315
- const yearMismatch = entryYear && foundYear && Math.abs(entryYear - foundYear) > 1;
316
-
317
- console.log(` ${conf} ${chalk.bold(entry.key)} (${entryYear || '?'})`);
318
- console.log(chalk.dim(` Title: ${entry.title}`));
319
- console.log(chalk.cyan(` DOI: ${result.doi}`));
320
-
321
- if (result.metadata?.journal) {
322
- let yearDisplay: string;
323
- if (yearExact) {
324
- yearDisplay = chalk.green(`(${foundYear})`);
325
- } else if (yearClose) {
326
- yearDisplay = chalk.yellow(`(${foundYear}) ≈`);
327
- } else if (yearMismatch) {
328
- yearDisplay = chalk.red.bold(`(${foundYear}) ⚠ YEAR MISMATCH`);
329
- } else {
330
- yearDisplay = chalk.dim(`(${foundYear || '?'})`);
331
- }
332
- console.log(` ${chalk.dim('Found:')} ${result.metadata.journal} ${yearDisplay}`);
333
- }
334
-
335
- // Extra warning for year mismatch
336
- if (yearMismatch) {
337
- console.log(chalk.red(` ⚠ Expected ${entryYear}, found ${foundYear} - verify this is correct!`));
338
- }
339
-
340
- console.log();
341
- }
342
-
343
- // Offer to add DOIs
344
- console.log(chalk.dim('To add a DOI to your .bib file:'));
345
- console.log(chalk.dim(' 1. Open references.bib'));
346
- console.log(chalk.dim(' 2. Add: doi = {10.xxxx/xxxxx}'));
347
- console.log();
348
- console.log(chalk.dim('Or use: rev doi add <doi> to fetch full BibTeX'));
349
- }
350
-
351
- // Show hidden count
352
- if (hiddenCount > 0) {
353
- console.log(chalk.yellow(`\n${hiddenCount} lower-confidence matches hidden.`));
354
- if (confLevel === 'high') {
355
- console.log(chalk.dim('Use --confidence medium or --confidence low to show more.'));
356
- } else if (confLevel === 'medium') {
357
- console.log(chalk.dim('Use --confidence low to show all matches.'));
358
- }
359
- }
360
-
361
- // Show not found
362
- if (notFound > 0) {
363
- console.log(chalk.dim(`${notFound} entries could not be matched. These may be:`));
364
- console.log(chalk.dim(' - Books, theses, or reports (often no DOI)'));
365
- console.log(chalk.dim(' - Very old papers (pre-DOI era)'));
366
- console.log(chalk.dim(' - Title mismatch (special characters, abbreviations)'));
367
- }
368
-
369
- } else {
370
- console.error(fmt.status('error', `Unknown action: ${action}`));
371
- console.log(chalk.dim('Actions: check, fetch, add, lookup'));
372
- process.exit(1);
373
- }
374
- });
375
-
376
- // ==========================================================================
377
- // ORCID command - Fetch author info from ORCID
378
- // ==========================================================================
379
-
380
- program
381
- .command('orcid')
382
- .description('Fetch author information from ORCID')
383
- .argument('<orcid>', 'ORCID iD (e.g., 0000-0002-1825-0097)')
384
- .option('--yaml', 'Output as YAML for rev.yaml authors section')
385
- .option('--badge', 'Output markdown badge')
386
- .action(async (orcidInput: string, options: OrcidOptions) => {
387
- const { fetchOrcidProfile, fetchOrcidWorkCount, formatAuthorYaml, getOrcidBadge, cleanOrcid, isValidOrcid } = await import('../orcid.js');
388
-
389
- const orcid = cleanOrcid(orcidInput);
390
-
391
- if (!isValidOrcid(orcid)) {
392
- console.error(fmt.status('error', `Invalid ORCID format: ${orcidInput}`));
393
- console.log(chalk.dim('Expected format: 0000-0000-0000-0000'));
394
- console.log(chalk.dim('Or: https://orcid.org/0000-0000-0000-0000'));
395
- process.exit(1);
396
- }
397
-
398
- console.log(chalk.cyan(`Fetching ORCID profile...`));
399
-
400
- try {
401
- const profile = await fetchOrcidProfile(orcid);
402
- const workCount = await fetchOrcidWorkCount(orcid);
403
-
404
- if (options.yaml) {
405
- console.log();
406
- console.log(formatAuthorYaml(profile));
407
- return;
408
- }
409
-
410
- if (options.badge) {
411
- console.log();
412
- console.log(getOrcidBadge(orcid));
413
- return;
414
- }
415
-
416
- console.log();
417
- console.log(fmt.header('ORCID Profile'));
418
- console.log();
419
- console.log(` ${chalk.bold('Name:')} ${profile.name || chalk.dim('(not public)')}`);
420
- console.log(` ${chalk.bold('ORCID:')} ${chalk.green(profile.orcid)}`);
421
- console.log(` ${chalk.bold('Affiliation:')} ${profile.affiliation || chalk.dim('(not public)')}`);
422
- console.log(` ${chalk.bold('Email:')} ${profile.email || chalk.dim('(not public)')}`);
423
- console.log(` ${chalk.bold('Works:')} ${workCount} publication(s)`);
424
- console.log();
425
- console.log(chalk.dim(` Profile: https://orcid.org/${profile.orcid}`));
426
- console.log();
427
- console.log(chalk.dim(' Use --yaml to output for rev.yaml authors section'));
428
- console.log(chalk.dim(' Use --badge to get markdown badge'));
429
- } catch (err) {
430
- const error = err as Error;
431
- console.error(fmt.status('error', error.message));
432
- process.exit(1);
433
- }
434
- });
435
- }
1
+ /**
2
+ * DOI commands: doi, orcid
3
+ *
4
+ * Commands for DOI validation, fetching, and ORCID profile lookup.
5
+ */
6
+
7
+ import {
8
+ chalk,
9
+ fs,
10
+ path,
11
+ fmt,
12
+ } from './context.js';
13
+ import type { Command } from 'commander';
14
+
15
+ interface DoiOptions {
16
+ bib: string;
17
+ strict?: boolean;
18
+ resolve?: boolean;
19
+ confidence: string;
20
+ }
21
+
22
+ interface OrcidOptions {
23
+ yaml?: boolean;
24
+ badge?: boolean;
25
+ }
26
+
27
+ /**
28
+ * Register DOI commands with the program
29
+ */
30
+ export function register(program: Command): void {
31
+ // ==========================================================================
32
+ // DOI command - Validate and fetch DOIs
33
+ // ==========================================================================
34
+
35
+ program
36
+ .command('doi')
37
+ .description('Validate DOIs in bibliography or fetch citations from DOI')
38
+ .argument('<action>', 'Action: check, fetch, add, lookup')
39
+ .argument('[input]', 'DOI (for fetch/add) or .bib file (for check)')
40
+ .option('-b, --bib <file>', 'Bibliography file', 'references.bib')
41
+ .option('--strict', 'Fail on missing DOIs for articles')
42
+ .option('--no-resolve', 'Only check format, skip resolution check')
43
+ .option('--confidence <level>', 'Minimum confidence: high, medium, low (default: medium)', 'medium')
44
+ .action(async (action: string, input: string | undefined, options: DoiOptions) => {
45
+ const { parseBibEntries, checkBibDois, fetchBibtex, addToBib, isValidDoiFormat, lookupDoi, lookupMissingDois } = await import('../doi.js');
46
+
47
+ if (action === 'check') {
48
+ const bibPath = input || options.bib;
49
+
50
+ if (!fs.existsSync(bibPath)) {
51
+ console.error(fmt.status('error', `File not found: ${bibPath}`));
52
+ process.exit(1);
53
+ }
54
+
55
+ console.log(fmt.header(`DOI Check: ${path.basename(bibPath)}`));
56
+ console.log();
57
+
58
+ const spin = fmt.spinner('Validating DOIs...').start();
59
+
60
+ try {
61
+ const results = await checkBibDois(bibPath, {
62
+ checkMissing: options.strict,
63
+ });
64
+
65
+ spin.stop();
66
+
67
+ // Group results by status
68
+ const valid = results.entries.filter(e => e.status === 'valid');
69
+ const invalid = results.entries.filter(e => e.status === 'invalid');
70
+ const missing = results.entries.filter(e => e.status === 'missing');
71
+ const skipped = results.entries.filter(e => e.status === 'skipped');
72
+
73
+ // Summary table
74
+ const summaryRows: string[][] = [
75
+ [chalk.green('Valid'), chalk.green(valid.length.toString())],
76
+ [invalid.length > 0 ? chalk.red('Invalid') : 'Invalid', invalid.length > 0 ? chalk.red(invalid.length.toString()) : '0'],
77
+ [missing.length > 0 ? chalk.yellow('Missing (articles)') : 'Missing', missing.length > 0 ? chalk.yellow(missing.length.toString()) : '0'],
78
+ [chalk.dim('Skipped'), chalk.dim(skipped.length.toString())],
79
+ ];
80
+ console.log(fmt.table(['Status', 'Count'], summaryRows));
81
+ console.log();
82
+
83
+ // Show invalid DOIs
84
+ if (invalid.length > 0) {
85
+ console.log(chalk.red('Invalid DOIs:'));
86
+ for (const e of invalid) {
87
+ console.log(` ${chalk.bold(e.key)}: ${e.doi || 'N/A'}`);
88
+ console.log(chalk.dim(` ${e.message}`));
89
+ }
90
+ console.log();
91
+ }
92
+
93
+ // Show missing (articles without DOI)
94
+ if (missing.length > 0) {
95
+ console.log(chalk.yellow('Missing DOIs (should have DOI):'));
96
+ for (const e of missing) {
97
+ console.log(` ${chalk.bold(e.key)} [${e.type}]`);
98
+ if (e.title) console.log(chalk.dim(` "${e.title}"`));
99
+ }
100
+ console.log();
101
+ }
102
+
103
+ // Show skipped breakdown
104
+ if (skipped.length > 0) {
105
+ // Count by reason
106
+ const manualSkip = skipped.filter(e => e.message === 'Marked as no-doi');
107
+ const bookTypes = skipped.filter(e => e.message?.includes('typically has no DOI'));
108
+ const noField = skipped.filter(e => e.message === 'No DOI field');
109
+
110
+ console.log(chalk.dim('Skipped entries:'));
111
+ if (manualSkip.length > 0) {
112
+ console.log(chalk.dim(` ${manualSkip.length} marked with nodoi={true}`));
113
+ }
114
+ if (bookTypes.length > 0) {
115
+ const types = [...new Set(bookTypes.map(e => e.type))].join(', ');
116
+ console.log(chalk.dim(` ${bookTypes.length} by type (${types})`));
117
+ }
118
+ if (noField.length > 0) {
119
+ console.log(chalk.dim(` ${noField.length} with no DOI field`));
120
+ }
121
+ console.log();
122
+ }
123
+
124
+ // Final status
125
+ if (invalid.length === 0 && missing.length === 0) {
126
+ console.log(fmt.status('success', 'All DOIs valid'));
127
+ } else if (invalid.length > 0) {
128
+ console.log(fmt.status('error', `${invalid.length} invalid DOI(s) found`));
129
+ if (options.strict) process.exit(1);
130
+ } else {
131
+ console.log(fmt.status('warning', `${missing.length} article(s) missing DOI`));
132
+ }
133
+
134
+ // Hint about skipping
135
+ console.log();
136
+ console.log(chalk.dim('To skip DOI check for an entry, add: nodoi = {true}'));
137
+ console.log(chalk.dim('Or add comment before entry: % no-doi'));
138
+
139
+ } catch (err) {
140
+ spin.stop();
141
+ const error = err as Error;
142
+ console.error(fmt.status('error', error.message));
143
+ process.exit(1);
144
+ }
145
+
146
+ } else if (action === 'fetch') {
147
+ if (!input) {
148
+ console.error(fmt.status('error', 'DOI required'));
149
+ console.log(chalk.dim('Usage: rev doi fetch 10.1234/example'));
150
+ process.exit(1);
151
+ }
152
+
153
+ const spin = fmt.spinner(`Fetching BibTeX for ${input}...`).start();
154
+
155
+ try {
156
+ const result = await fetchBibtex(input);
157
+
158
+ if (result.success) {
159
+ spin.success('BibTeX retrieved');
160
+ console.log();
161
+ console.log(result.bibtex);
162
+ } else {
163
+ spin.error(result.error!);
164
+ process.exit(1);
165
+ }
166
+ } catch (err) {
167
+ const error = err as Error;
168
+ spin.error(error.message);
169
+ process.exit(1);
170
+ }
171
+
172
+ } else if (action === 'add') {
173
+ if (!input) {
174
+ console.error(fmt.status('error', 'DOI required'));
175
+ console.log(chalk.dim('Usage: rev doi add 10.1234/example'));
176
+ process.exit(1);
177
+ }
178
+
179
+ const bibPath = options.bib;
180
+ const spin = fmt.spinner(`Fetching and adding ${input}...`).start();
181
+
182
+ try {
183
+ const fetchResult = await fetchBibtex(input);
184
+
185
+ if (!fetchResult.success) {
186
+ spin.error(fetchResult.error!);
187
+ process.exit(1);
188
+ }
189
+
190
+ const addResult = addToBib(bibPath, fetchResult.bibtex!);
191
+
192
+ if (addResult.success) {
193
+ spin.success(`Added @${addResult.key} to ${bibPath}`);
194
+ } else {
195
+ spin.error(addResult.error!);
196
+ process.exit(1);
197
+ }
198
+ } catch (err) {
199
+ const error = err as Error;
200
+ spin.error(error.message);
201
+ process.exit(1);
202
+ }
203
+
204
+ } else if (action === 'lookup') {
205
+ const bibPath = input || options.bib;
206
+
207
+ if (!fs.existsSync(bibPath)) {
208
+ console.error(fmt.status('error', `File not found: ${bibPath}`));
209
+ process.exit(1);
210
+ }
211
+
212
+ console.log(fmt.header(`DOI Lookup: ${path.basename(bibPath)}`));
213
+ console.log();
214
+
215
+ const entries = parseBibEntries(bibPath);
216
+ const missing = entries.filter(e => !e.doi && !e.skip && e.expectDoi);
217
+
218
+ if (missing.length === 0) {
219
+ console.log(fmt.status('success', 'No entries need DOI lookup'));
220
+ return;
221
+ }
222
+
223
+ console.log(chalk.dim(`Found ${missing.length} entries without DOIs to search...\n`));
224
+
225
+ let found = 0;
226
+ let notFound = 0;
227
+ let lowConfidence = 0;
228
+ const results: Array<{ entry: any; result: any; status: string }> = [];
229
+
230
+ for (let i = 0; i < missing.length; i++) {
231
+ const entry = missing[i];
232
+
233
+ // Extract first author last name
234
+ let author = '';
235
+ if (entry.authorRaw) {
236
+ const firstAuthor = entry.authorRaw.split(' and ')[0];
237
+ // Handle "Last, First" or "First Last" formats
238
+ if (firstAuthor.includes(',')) {
239
+ author = firstAuthor.split(',')[0].trim();
240
+ } else {
241
+ const parts = firstAuthor.trim().split(/\s+/);
242
+ author = parts[parts.length - 1]; // Last word is usually surname
243
+ }
244
+ }
245
+
246
+ process.stdout.write(`\r${chalk.dim(`[${i + 1}/${missing.length}]`)} ${entry.key}...`);
247
+
248
+ const result = await lookupDoi(entry.title, author, entry.year, entry.journal);
249
+
250
+ if (result.found) {
251
+ if (result.confidence === 'high') {
252
+ found++;
253
+ results.push({ entry, result, status: 'found' });
254
+ } else if (result.confidence === 'medium') {
255
+ found++;
256
+ results.push({ entry, result, status: 'found' });
257
+ } else {
258
+ lowConfidence++;
259
+ results.push({ entry, result, status: 'low' });
260
+ }
261
+ } else {
262
+ notFound++;
263
+ results.push({ entry, result, status: 'not-found' });
264
+ }
265
+
266
+ // Rate limiting
267
+ await new Promise(r => setTimeout(r, 200));
268
+ }
269
+
270
+ // Clear progress line
271
+ process.stdout.write('\r\x1B[K');
272
+
273
+ // Show results
274
+ console.log(fmt.table(
275
+ ['Status', 'Count'],
276
+ [
277
+ [chalk.green('Found (high/medium confidence)'), chalk.green(found.toString())],
278
+ [chalk.yellow('Found (low confidence)'), chalk.yellow(lowConfidence.toString())],
279
+ [chalk.dim('Not found'), chalk.dim(notFound.toString())],
280
+ ]
281
+ ));
282
+ console.log();
283
+
284
+ // Filter by confidence level
285
+ const confLevel = options.confidence || 'medium';
286
+ const confLevels: Record<string, number> = { high: 3, medium: 2, low: 1 };
287
+ const minConf = confLevels[confLevel] || 2;
288
+
289
+ const filteredResults = results.filter(r => {
290
+ if (r.status === 'not-found') return false;
291
+ const resultConf = confLevels[r.result.confidence] || 1;
292
+ return resultConf >= minConf;
293
+ });
294
+
295
+ const hiddenCount = results.filter(r => {
296
+ if (r.status === 'not-found') return false;
297
+ const resultConf = confLevels[r.result.confidence] || 1;
298
+ return resultConf < minConf;
299
+ }).length;
300
+
301
+ if (filteredResults.length > 0) {
302
+ console.log(chalk.cyan(`Found DOIs (${confLevel}+ confidence):`));
303
+ console.log();
304
+
305
+ for (const { entry, result } of filteredResults) {
306
+ const conf = result.confidence === 'high' ? chalk.green('●') :
307
+ result.confidence === 'medium' ? chalk.yellow('●') :
308
+ chalk.red('○');
309
+
310
+ // Check year match
311
+ const entryYear = entry.year;
312
+ const foundYear = result.metadata?.year;
313
+ const yearExact = entryYear && foundYear && entryYear === foundYear;
314
+ const yearClose = entryYear && foundYear && Math.abs(entryYear - foundYear) === 1;
315
+ const yearMismatch = entryYear && foundYear && Math.abs(entryYear - foundYear) > 1;
316
+
317
+ console.log(` ${conf} ${chalk.bold(entry.key)} (${entryYear || '?'})`);
318
+ console.log(chalk.dim(` Title: ${entry.title}`));
319
+ console.log(chalk.cyan(` DOI: ${result.doi}`));
320
+
321
+ if (result.metadata?.journal) {
322
+ let yearDisplay: string;
323
+ if (yearExact) {
324
+ yearDisplay = chalk.green(`(${foundYear})`);
325
+ } else if (yearClose) {
326
+ yearDisplay = chalk.yellow(`(${foundYear}) ≈`);
327
+ } else if (yearMismatch) {
328
+ yearDisplay = chalk.red.bold(`(${foundYear}) ⚠ YEAR MISMATCH`);
329
+ } else {
330
+ yearDisplay = chalk.dim(`(${foundYear || '?'})`);
331
+ }
332
+ console.log(` ${chalk.dim('Found:')} ${result.metadata.journal} ${yearDisplay}`);
333
+ }
334
+
335
+ // Extra warning for year mismatch
336
+ if (yearMismatch) {
337
+ console.log(chalk.red(` ⚠ Expected ${entryYear}, found ${foundYear} - verify this is correct!`));
338
+ }
339
+
340
+ console.log();
341
+ }
342
+
343
+ // Offer to add DOIs
344
+ console.log(chalk.dim('To add a DOI to your .bib file:'));
345
+ console.log(chalk.dim(' 1. Open references.bib'));
346
+ console.log(chalk.dim(' 2. Add: doi = {10.xxxx/xxxxx}'));
347
+ console.log();
348
+ console.log(chalk.dim('Or use: rev doi add <doi> to fetch full BibTeX'));
349
+ }
350
+
351
+ // Show hidden count
352
+ if (hiddenCount > 0) {
353
+ console.log(chalk.yellow(`\n${hiddenCount} lower-confidence matches hidden.`));
354
+ if (confLevel === 'high') {
355
+ console.log(chalk.dim('Use --confidence medium or --confidence low to show more.'));
356
+ } else if (confLevel === 'medium') {
357
+ console.log(chalk.dim('Use --confidence low to show all matches.'));
358
+ }
359
+ }
360
+
361
+ // Show not found
362
+ if (notFound > 0) {
363
+ console.log(chalk.dim(`${notFound} entries could not be matched. These may be:`));
364
+ console.log(chalk.dim(' - Books, theses, or reports (often no DOI)'));
365
+ console.log(chalk.dim(' - Very old papers (pre-DOI era)'));
366
+ console.log(chalk.dim(' - Title mismatch (special characters, abbreviations)'));
367
+ }
368
+
369
+ } else {
370
+ console.error(fmt.status('error', `Unknown action: ${action}`));
371
+ console.log(chalk.dim('Actions: check, fetch, add, lookup'));
372
+ process.exit(1);
373
+ }
374
+ });
375
+
376
+ // ==========================================================================
377
+ // ORCID command - Fetch author info from ORCID
378
+ // ==========================================================================
379
+
380
+ program
381
+ .command('orcid')
382
+ .description('Fetch author information from ORCID')
383
+ .argument('<orcid>', 'ORCID iD (e.g., 0000-0002-1825-0097)')
384
+ .option('--yaml', 'Output as YAML for rev.yaml authors section')
385
+ .option('--badge', 'Output markdown badge')
386
+ .action(async (orcidInput: string, options: OrcidOptions) => {
387
+ const { fetchOrcidProfile, fetchOrcidWorkCount, formatAuthorYaml, getOrcidBadge, cleanOrcid, isValidOrcid } = await import('../orcid.js');
388
+
389
+ const orcid = cleanOrcid(orcidInput);
390
+
391
+ if (!isValidOrcid(orcid)) {
392
+ console.error(fmt.status('error', `Invalid ORCID format: ${orcidInput}`));
393
+ console.log(chalk.dim('Expected format: 0000-0000-0000-0000'));
394
+ console.log(chalk.dim('Or: https://orcid.org/0000-0000-0000-0000'));
395
+ process.exit(1);
396
+ }
397
+
398
+ console.log(chalk.cyan(`Fetching ORCID profile...`));
399
+
400
+ try {
401
+ const profile = await fetchOrcidProfile(orcid);
402
+ const workCount = await fetchOrcidWorkCount(orcid);
403
+
404
+ if (options.yaml) {
405
+ console.log();
406
+ console.log(formatAuthorYaml(profile));
407
+ return;
408
+ }
409
+
410
+ if (options.badge) {
411
+ console.log();
412
+ console.log(getOrcidBadge(orcid));
413
+ return;
414
+ }
415
+
416
+ console.log();
417
+ console.log(fmt.header('ORCID Profile'));
418
+ console.log();
419
+ console.log(` ${chalk.bold('Name:')} ${profile.name || chalk.dim('(not public)')}`);
420
+ console.log(` ${chalk.bold('ORCID:')} ${chalk.green(profile.orcid)}`);
421
+ console.log(` ${chalk.bold('Affiliation:')} ${profile.affiliation || chalk.dim('(not public)')}`);
422
+ console.log(` ${chalk.bold('Email:')} ${profile.email || chalk.dim('(not public)')}`);
423
+ console.log(` ${chalk.bold('Works:')} ${workCount} publication(s)`);
424
+ console.log();
425
+ console.log(chalk.dim(` Profile: https://orcid.org/${profile.orcid}`));
426
+ console.log();
427
+ console.log(chalk.dim(' Use --yaml to output for rev.yaml authors section'));
428
+ console.log(chalk.dim(' Use --badge to get markdown badge'));
429
+ } catch (err) {
430
+ const error = err as Error;
431
+ console.error(fmt.status('error', error.message));
432
+ process.exit(1);
433
+ }
434
+ });
435
+ }