docrev 0.11.0 → 0.11.2

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