docrev 0.11.1 → 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 (116) hide show
  1. package/.gitattributes +1 -1
  2. package/CHANGELOG.md +202 -197
  3. package/PLAN-tables-and-postprocess.md +850 -850
  4. package/README.md +433 -433
  5. package/bin/rev.js +11 -11
  6. package/bin/rev.ts +145 -145
  7. package/completions/rev.bash +127 -127
  8. package/completions/rev.ps1 +210 -210
  9. package/completions/rev.zsh +207 -207
  10. package/dist/lib/build.d.ts +28 -0
  11. package/dist/lib/build.d.ts.map +1 -1
  12. package/dist/lib/build.js +81 -4
  13. package/dist/lib/build.js.map +1 -1
  14. package/dist/lib/commands/utilities.js +164 -164
  15. package/dist/lib/commands/word-tools.js +8 -8
  16. package/dist/lib/grammar.js +3 -3
  17. package/dist/lib/macro-filter.lua +201 -201
  18. package/dist/lib/pdf-comments.js +44 -44
  19. package/dist/lib/plugins.js +57 -57
  20. package/dist/lib/pptx-color-filter.lua +37 -37
  21. package/dist/lib/pptx-themes.js +115 -115
  22. package/dist/lib/schema.d.ts.map +1 -1
  23. package/dist/lib/schema.js +8 -2
  24. package/dist/lib/schema.js.map +1 -1
  25. package/dist/lib/spelling.js +2 -2
  26. package/dist/lib/templates.js +387 -387
  27. package/dist/lib/themes.js +51 -51
  28. package/eslint.config.js +27 -27
  29. package/lib/anchor-match.ts +307 -307
  30. package/lib/annotations.ts +664 -664
  31. package/lib/build.ts +2047 -1956
  32. package/lib/citations.ts +160 -160
  33. package/lib/commands/build.ts +885 -885
  34. package/lib/commands/citations.ts +515 -515
  35. package/lib/commands/comments.ts +1050 -1050
  36. package/lib/commands/context.ts +176 -176
  37. package/lib/commands/core.ts +309 -309
  38. package/lib/commands/doi.ts +451 -451
  39. package/lib/commands/file-ops.ts +372 -372
  40. package/lib/commands/history.ts +320 -320
  41. package/lib/commands/index.ts +87 -87
  42. package/lib/commands/init.ts +259 -259
  43. package/lib/commands/merge-resolve.ts +378 -378
  44. package/lib/commands/preview.ts +178 -178
  45. package/lib/commands/project-info.ts +244 -244
  46. package/lib/commands/quality.ts +517 -517
  47. package/lib/commands/response.ts +454 -454
  48. package/lib/commands/section-boundaries.ts +82 -82
  49. package/lib/commands/sections.ts +451 -451
  50. package/lib/commands/sync.ts +689 -689
  51. package/lib/commands/text-ops.ts +449 -449
  52. package/lib/commands/utilities.ts +448 -448
  53. package/lib/commands/verify-anchors.ts +272 -272
  54. package/lib/commands/word-tools.ts +340 -340
  55. package/lib/comment-realign.ts +99 -99
  56. package/lib/config.ts +84 -84
  57. package/lib/crossref.ts +781 -781
  58. package/lib/csl.ts +191 -191
  59. package/lib/dependencies.ts +132 -132
  60. package/lib/diff-engine.ts +465 -465
  61. package/lib/doi-cache.ts +115 -115
  62. package/lib/doi.ts +879 -879
  63. package/lib/equations.ts +506 -506
  64. package/lib/errors.ts +350 -350
  65. package/lib/format.ts +541 -541
  66. package/lib/git.ts +326 -326
  67. package/lib/grammar.ts +303 -303
  68. package/lib/image-registry.ts +180 -180
  69. package/lib/import.ts +906 -906
  70. package/lib/journals.ts +543 -543
  71. package/lib/macro-filter.lua +201 -201
  72. package/lib/macros.ts +273 -273
  73. package/lib/merge.ts +633 -633
  74. package/lib/ooxml.ts +768 -768
  75. package/lib/orcid.ts +144 -144
  76. package/lib/pdf-comments.ts +263 -263
  77. package/lib/pdf-import.ts +524 -524
  78. package/lib/plugins.ts +362 -362
  79. package/lib/postprocess.ts +188 -188
  80. package/lib/pptx-color-filter.lua +37 -37
  81. package/lib/pptx-template.ts +469 -469
  82. package/lib/pptx-themes.ts +483 -483
  83. package/lib/protect-restore.ts +520 -520
  84. package/lib/rate-limiter.ts +127 -127
  85. package/lib/response.ts +197 -197
  86. package/lib/restore-references.ts +240 -240
  87. package/lib/review.ts +327 -327
  88. package/lib/schema.ts +494 -488
  89. package/lib/scientific-words.ts +73 -73
  90. package/lib/sections.ts +428 -428
  91. package/lib/slides.ts +756 -756
  92. package/lib/spelling.ts +334 -334
  93. package/lib/templates.ts +526 -526
  94. package/lib/themes.ts +742 -742
  95. package/lib/trackchanges.ts +166 -166
  96. package/lib/tui.ts +450 -450
  97. package/lib/types.ts +546 -546
  98. package/lib/undo.ts +250 -250
  99. package/lib/utils.ts +69 -69
  100. package/lib/variables.ts +179 -179
  101. package/lib/word-extraction.ts +525 -525
  102. package/lib/word.ts +526 -526
  103. package/lib/wordcomments.ts +789 -789
  104. package/package.json +1 -1
  105. package/scripts/postbuild.js +47 -47
  106. package/skill/REFERENCE.md +550 -550
  107. package/skill/SKILL.md +302 -302
  108. package/tsconfig.json +26 -26
  109. package/types/index.d.ts +531 -531
  110. package/issues.md +0 -180
  111. package/site/assets/extra.css +0 -208
  112. package/site/commands.html +0 -926
  113. package/site/configuration.html +0 -469
  114. package/site/index.html +0 -288
  115. package/site/troubleshooting.html +0 -461
  116. package/site/workflow.html +0 -518
package/lib/schema.ts CHANGED
@@ -1,488 +1,494 @@
1
- /**
2
- * JSON Schema validation for rev.yaml configuration
3
- */
4
-
5
- /**
6
- * Validation error
7
- */
8
- interface ValidationError {
9
- path: string;
10
- message: string;
11
- value?: unknown;
12
- }
13
-
14
- /**
15
- * Validation warning
16
- */
17
- interface ValidationWarning {
18
- path: string;
19
- message: string;
20
- }
21
-
22
- /**
23
- * Validation result
24
- */
25
- interface ValidationResult {
26
- valid: boolean;
27
- errors: ValidationError[];
28
- warnings: ValidationWarning[];
29
- }
30
-
31
- /**
32
- * JSON Schema type
33
- */
34
- interface Schema {
35
- $schema?: string;
36
- title?: string;
37
- description?: string;
38
- type?: string;
39
- properties?: Record<string, Schema>;
40
- required?: string[];
41
- items?: Schema;
42
- oneOf?: Schema[];
43
- enum?: string[];
44
- pattern?: string;
45
- format?: string;
46
- minimum?: number;
47
- maximum?: number;
48
- minItems?: number;
49
- maxItems?: number;
50
- additionalProperties?: boolean;
51
- default?: unknown;
52
- }
53
-
54
- /**
55
- * JSON Schema for rev.yaml
56
- */
57
- export const revYamlSchema: Schema = {
58
- $schema: 'http://json-schema.org/draft-07/schema#',
59
- title: 'rev.yaml configuration',
60
- description: 'Configuration file for docrev document workflow',
61
- type: 'object',
62
- properties: {
63
- title: {
64
- type: 'string',
65
- description: 'Document title',
66
- },
67
- version: {
68
- type: 'string',
69
- description: 'Document version',
70
- },
71
- authors: {
72
- type: 'array',
73
- description: 'List of authors',
74
- items: {
75
- oneOf: [
76
- { type: 'string' },
77
- {
78
- type: 'object',
79
- properties: {
80
- name: { type: 'string' },
81
- affiliation: { type: 'string' },
82
- email: { type: 'string', format: 'email' },
83
- orcid: { type: 'string', pattern: '^\\d{4}-\\d{4}-\\d{4}-\\d{3}[0-9X]$' },
84
- },
85
- required: ['name'],
86
- },
87
- ],
88
- },
89
- },
90
- journal: {
91
- type: 'string',
92
- description: 'Journal profile name for formatting defaults and validation',
93
- },
94
- 'pandoc-args': {
95
- type: 'array',
96
- description: 'Extra pandoc args applied to every format build (e.g. --lua-filter=...). Format-specific lists are appended after these; --pandoc-arg CLI values are appended last.',
97
- items: { type: 'string' },
98
- },
99
- output: {
100
- type: 'object',
101
- description: 'Per-format output filenames. Keys are format names (pdf, docx, tex, beamer, pptx); values are paths. Relative paths resolve under outputDir; absolute paths are honored as-is. Extension auto-added if missing. CLI `-o` overrides this map.',
102
- properties: {
103
- pdf: { type: 'string' },
104
- docx: { type: 'string' },
105
- tex: { type: 'string' },
106
- beamer: { type: 'string' },
107
- pptx: { type: 'string' },
108
- },
109
- additionalProperties: false,
110
- },
111
- sections: {
112
- type: 'array',
113
- description: 'Ordered list of section files to include',
114
- items: { type: 'string', pattern: '.*\\.md$' },
115
- },
116
- bibliography: {
117
- type: 'string',
118
- description: 'Path to bibliography file (.bib)',
119
- pattern: '.*\\.bib$',
120
- },
121
- csl: {
122
- type: 'string',
123
- description: 'Path to CSL citation style file',
124
- },
125
- crossref: {
126
- type: 'object',
127
- description: 'pandoc-crossref settings',
128
- properties: {
129
- figureTitle: { type: 'string', default: 'Figure' },
130
- tableTitle: { type: 'string', default: 'Table' },
131
- figPrefix: {
132
- oneOf: [
133
- { type: 'string' },
134
- { type: 'array', items: { type: 'string' }, minItems: 1, maxItems: 2 },
135
- ],
136
- },
137
- tblPrefix: {
138
- oneOf: [
139
- { type: 'string' },
140
- { type: 'array', items: { type: 'string' }, minItems: 1, maxItems: 2 },
141
- ],
142
- },
143
- eqnPrefix: {
144
- oneOf: [
145
- { type: 'string' },
146
- { type: 'array', items: { type: 'string' }, minItems: 1, maxItems: 2 },
147
- ],
148
- },
149
- secPrefix: {
150
- oneOf: [
151
- { type: 'string' },
152
- { type: 'array', items: { type: 'string' }, minItems: 1, maxItems: 2 },
153
- ],
154
- },
155
- linkReferences: { type: 'boolean', default: true },
156
- },
157
- additionalProperties: true,
158
- },
159
- pdf: {
160
- type: 'object',
161
- description: 'PDF output settings',
162
- properties: {
163
- template: { type: 'string' },
164
- documentclass: {
165
- type: 'string',
166
- enum: ['article', 'report', 'book', 'memoir', 'scrartcl', 'scrreprt', 'scrbook'],
167
- default: 'article',
168
- },
169
- fontsize: {
170
- type: 'string',
171
- pattern: '^\\d{1,2}pt$',
172
- default: '12pt',
173
- },
174
- geometry: { type: 'string', default: 'margin=1in' },
175
- linestretch: { type: 'number', minimum: 1, maximum: 3, default: 1.5 },
176
- numbersections: { type: 'boolean', default: false },
177
- toc: { type: 'boolean', default: false },
178
- header: { type: 'string' },
179
- footer: { type: 'string' },
180
- 'pandoc-args': {
181
- type: 'array',
182
- description: 'Extra pandoc args for PDF builds. Appended after the top-level pandoc-args list.',
183
- items: { type: 'string' },
184
- },
185
- },
186
- additionalProperties: true,
187
- },
188
- docx: {
189
- type: 'object',
190
- description: 'Word output settings',
191
- properties: {
192
- reference: { type: 'string', description: 'Reference document for styling' },
193
- keepComments: { type: 'boolean', default: true },
194
- toc: { type: 'boolean', default: false },
195
- translateRawFigures: {
196
- type: 'boolean',
197
- default: true,
198
- description: 'Auto-translate the common \\begin{figure}...\\end{figure} shape to portable ![](){#fig: ...} markdown so figures render in docx. Pandoc strips raw LaTeX in docx output silently otherwise.',
199
- },
200
- 'pandoc-args': {
201
- type: 'array',
202
- description: 'Extra pandoc args for DOCX builds. Appended after the top-level pandoc-args list.',
203
- items: { type: 'string' },
204
- },
205
- },
206
- additionalProperties: true,
207
- },
208
- tex: {
209
- type: 'object',
210
- description: 'LaTeX output settings',
211
- properties: {
212
- standalone: { type: 'boolean', default: true },
213
- 'pandoc-args': {
214
- type: 'array',
215
- description: 'Extra pandoc args for TeX builds. Appended after the top-level pandoc-args list.',
216
- items: { type: 'string' },
217
- },
218
- },
219
- additionalProperties: true,
220
- },
221
- macros: {
222
- type: 'array',
223
- description: 'Placeholder/highlight macros (e.g. \\tofill{X}). Built-in macros are merged automatically; entries here add new macros or override built-ins by name.',
224
- items: {
225
- type: 'object',
226
- properties: {
227
- name: {
228
- type: 'string',
229
- description: 'Macro command name without leading backslash, e.g. "tofill" for \\tofill{...}',
230
- pattern: '^[A-Za-z][A-Za-z0-9]*$',
231
- },
232
- default: {
233
- type: 'object',
234
- description: 'Default rendering rules across formats',
235
- properties: {
236
- color: { type: 'string', pattern: '^[0-9A-Fa-f]{6}$' },
237
- bold: { type: 'boolean' },
238
- italic: { type: 'boolean' },
239
- bracket: { type: 'boolean', default: true },
240
- prefix: { type: 'string' },
241
- suffix: { type: 'string' },
242
- },
243
- additionalProperties: false,
244
- },
245
- formats: {
246
- type: 'object',
247
- description: 'Per-format overrides (keys: docx, pdf, latex, html, ...)',
248
- additionalProperties: true,
249
- },
250
- },
251
- required: ['name'],
252
- additionalProperties: false,
253
- },
254
- },
255
- },
256
- additionalProperties: true,
257
- };
258
-
259
- /**
260
- * Validate a value against a simple schema
261
- */
262
- function validateValue(value: unknown, schema: Schema, path = ''): ValidationError[] {
263
- const errors: ValidationError[] = [];
264
-
265
- // Handle oneOf
266
- if (schema.oneOf) {
267
- const validForAny = schema.oneOf.some((subSchema) => {
268
- const subErrors = validateValue(value, subSchema, path);
269
- return subErrors.length === 0;
270
- });
271
- if (!validForAny) {
272
- errors.push({
273
- path,
274
- message: `Value does not match any allowed type`,
275
- value,
276
- });
277
- }
278
- return errors;
279
- }
280
-
281
- // Type check
282
- if (schema.type) {
283
- const actualType = Array.isArray(value) ? 'array' : typeof value;
284
- if (actualType !== schema.type) {
285
- errors.push({
286
- path,
287
- message: `Expected ${schema.type}, got ${actualType}`,
288
- value,
289
- });
290
- return errors; // Stop further validation if type is wrong
291
- }
292
- }
293
-
294
- // String validation
295
- if (schema.type === 'string' && typeof value === 'string') {
296
- if (schema.pattern) {
297
- const regex = new RegExp(schema.pattern);
298
- if (!regex.test(value)) {
299
- errors.push({
300
- path,
301
- message: `Value "${value}" does not match pattern ${schema.pattern}`,
302
- value,
303
- });
304
- }
305
- }
306
- if (schema.enum && !schema.enum.includes(value)) {
307
- errors.push({
308
- path,
309
- message: `Value "${value}" must be one of: ${schema.enum.join(', ')}`,
310
- value,
311
- });
312
- }
313
- }
314
-
315
- // Number validation
316
- if (schema.type === 'number' && typeof value === 'number') {
317
- if (schema.minimum !== undefined && value < schema.minimum) {
318
- errors.push({
319
- path,
320
- message: `Value ${value} is less than minimum ${schema.minimum}`,
321
- value,
322
- });
323
- }
324
- if (schema.maximum !== undefined && value > schema.maximum) {
325
- errors.push({
326
- path,
327
- message: `Value ${value} is greater than maximum ${schema.maximum}`,
328
- value,
329
- });
330
- }
331
- }
332
-
333
- // Array validation
334
- if (schema.type === 'array' && Array.isArray(value)) {
335
- if (schema.minItems !== undefined && value.length < schema.minItems) {
336
- errors.push({
337
- path,
338
- message: `Array must have at least ${schema.minItems} items`,
339
- value,
340
- });
341
- }
342
- if (schema.maxItems !== undefined && value.length > schema.maxItems) {
343
- errors.push({
344
- path,
345
- message: `Array must have at most ${schema.maxItems} items`,
346
- value,
347
- });
348
- }
349
- if (schema.items) {
350
- value.forEach((item, index) => {
351
- errors.push(...validateValue(item, schema.items!, `${path}[${index}]`));
352
- });
353
- }
354
- }
355
-
356
- // Object validation
357
- if (schema.type === 'object' && typeof value === 'object' && value !== null) {
358
- const obj = value as Record<string, unknown>;
359
- if (schema.properties) {
360
- for (const [key, propSchema] of Object.entries(schema.properties)) {
361
- if (obj[key] !== undefined) {
362
- errors.push(...validateValue(obj[key], propSchema, path ? `${path}.${key}` : key));
363
- }
364
- }
365
- }
366
- if (schema.required) {
367
- for (const key of schema.required) {
368
- if (obj[key] === undefined) {
369
- errors.push({
370
- path: path ? `${path}.${key}` : key,
371
- message: `Required property "${key}" is missing`,
372
- value: undefined,
373
- });
374
- }
375
- }
376
- }
377
- }
378
-
379
- return errors;
380
- }
381
-
382
- /**
383
- * Validate rev.yaml configuration
384
- */
385
- export function validateConfig(config: Record<string, unknown>): ValidationResult {
386
- const errors = validateValue(config, revYamlSchema);
387
- const warnings: ValidationWarning[] = [];
388
-
389
- // Additional semantic validations
390
- if (config.sections && Array.isArray(config.sections) && config.sections.length === 0) {
391
- warnings.push({
392
- path: 'sections',
393
- message: 'No sections specified - build will auto-detect .md files',
394
- });
395
- }
396
-
397
- if (config.bibliography && typeof config.bibliography === 'string' && !config.bibliography.endsWith('.bib')) {
398
- warnings.push({
399
- path: 'bibliography',
400
- message: 'Bibliography file should have .bib extension',
401
- });
402
- }
403
-
404
- const pdf = config.pdf as { linestretch?: number } | undefined;
405
- if (pdf?.linestretch && (pdf.linestretch < 1 || pdf.linestretch > 3)) {
406
- warnings.push({
407
- path: 'pdf.linestretch',
408
- message: 'Line stretch values outside 1-3 range may produce unexpected results',
409
- });
410
- }
411
-
412
- // Check for common typos
413
- const knownKeys = Object.keys(revYamlSchema.properties || {});
414
- for (const key of Object.keys(config)) {
415
- if (key.startsWith('_')) continue; // Internal keys
416
- if (!knownKeys.includes(key)) {
417
- // Check for similar keys (possible typos)
418
- const similar = knownKeys.find(
419
- (k) => levenshtein(key.toLowerCase(), k.toLowerCase()) <= 2
420
- );
421
- if (similar) {
422
- warnings.push({
423
- path: key,
424
- message: `Unknown property "${key}" - did you mean "${similar}"?`,
425
- });
426
- }
427
- }
428
- }
429
-
430
- return {
431
- valid: errors.length === 0,
432
- errors,
433
- warnings,
434
- };
435
- }
436
-
437
- /**
438
- * Format validation results for display
439
- */
440
- export function formatValidationResult(
441
- result: ValidationResult,
442
- chalk: { red: (s: string) => string; yellow: (s: string) => string; green: (s: string) => string }
443
- ): string {
444
- const lines: string[] = [];
445
-
446
- if (result.errors.length > 0) {
447
- lines.push(chalk.red('Configuration errors:'));
448
- for (const error of result.errors) {
449
- lines.push(chalk.red(` ✗ ${error.path}: ${error.message}`));
450
- }
451
- }
452
-
453
- if (result.warnings.length > 0) {
454
- if (lines.length > 0) lines.push('');
455
- lines.push(chalk.yellow('Warnings:'));
456
- for (const warning of result.warnings) {
457
- lines.push(chalk.yellow(` ! ${warning.path}: ${warning.message}`));
458
- }
459
- }
460
-
461
- if (result.valid && result.warnings.length === 0) {
462
- lines.push(chalk.green('✓ Configuration is valid'));
463
- }
464
-
465
- return lines.join('\n');
466
- }
467
-
468
- /**
469
- * Levenshtein distance for typo detection
470
- */
471
- function levenshtein(a: string, b: string): number {
472
- const matrix = Array(b.length + 1)
473
- .fill(null)
474
- .map(() => Array(a.length + 1).fill(null));
475
- for (let i = 0; i <= a.length; i++) matrix[0][i] = i;
476
- for (let j = 0; j <= b.length; j++) matrix[j][0] = j;
477
- for (let j = 1; j <= b.length; j++) {
478
- for (let i = 1; i <= a.length; i++) {
479
- const cost = a[i - 1] === b[j - 1] ? 0 : 1;
480
- matrix[j][i] = Math.min(
481
- matrix[j][i - 1] + 1,
482
- matrix[j - 1][i] + 1,
483
- matrix[j - 1][i - 1] + cost
484
- );
485
- }
486
- }
487
- return matrix[b.length][a.length];
488
- }
1
+ /**
2
+ * JSON Schema validation for rev.yaml configuration
3
+ */
4
+
5
+ /**
6
+ * Validation error
7
+ */
8
+ interface ValidationError {
9
+ path: string;
10
+ message: string;
11
+ value?: unknown;
12
+ }
13
+
14
+ /**
15
+ * Validation warning
16
+ */
17
+ interface ValidationWarning {
18
+ path: string;
19
+ message: string;
20
+ }
21
+
22
+ /**
23
+ * Validation result
24
+ */
25
+ interface ValidationResult {
26
+ valid: boolean;
27
+ errors: ValidationError[];
28
+ warnings: ValidationWarning[];
29
+ }
30
+
31
+ /**
32
+ * JSON Schema type
33
+ */
34
+ interface Schema {
35
+ $schema?: string;
36
+ title?: string;
37
+ description?: string;
38
+ type?: string;
39
+ properties?: Record<string, Schema>;
40
+ required?: string[];
41
+ items?: Schema;
42
+ oneOf?: Schema[];
43
+ enum?: string[];
44
+ pattern?: string;
45
+ format?: string;
46
+ minimum?: number;
47
+ maximum?: number;
48
+ minItems?: number;
49
+ maxItems?: number;
50
+ additionalProperties?: boolean;
51
+ default?: unknown;
52
+ }
53
+
54
+ /**
55
+ * JSON Schema for rev.yaml
56
+ */
57
+ export const revYamlSchema: Schema = {
58
+ $schema: 'http://json-schema.org/draft-07/schema#',
59
+ title: 'rev.yaml configuration',
60
+ description: 'Configuration file for docrev document workflow',
61
+ type: 'object',
62
+ properties: {
63
+ title: {
64
+ type: 'string',
65
+ description: 'Document title',
66
+ },
67
+ version: {
68
+ type: 'string',
69
+ description: 'Document version',
70
+ },
71
+ authors: {
72
+ type: 'array',
73
+ description: 'List of authors',
74
+ items: {
75
+ oneOf: [
76
+ { type: 'string' },
77
+ {
78
+ type: 'object',
79
+ properties: {
80
+ name: { type: 'string' },
81
+ affiliation: { type: 'string' },
82
+ email: { type: 'string', format: 'email' },
83
+ orcid: { type: 'string', pattern: '^\\d{4}-\\d{4}-\\d{4}-\\d{3}[0-9X]$' },
84
+ },
85
+ required: ['name'],
86
+ },
87
+ ],
88
+ },
89
+ },
90
+ journal: {
91
+ type: 'string',
92
+ description: 'Journal profile name for formatting defaults and validation',
93
+ },
94
+ 'pandoc-args': {
95
+ type: 'array',
96
+ description: 'Extra pandoc args applied to every format build (e.g. --lua-filter=...). Format-specific lists are appended after these; --pandoc-arg CLI values are appended last.',
97
+ items: { type: 'string' },
98
+ },
99
+ output: {
100
+ type: 'object',
101
+ description: 'Per-format output filenames. Keys are format names (pdf, docx, tex, beamer, pptx); values are paths. Relative paths resolve under outputDir; absolute paths are honored as-is. Extension auto-added if missing. CLI `-o` overrides this map.',
102
+ properties: {
103
+ pdf: { type: 'string' },
104
+ docx: { type: 'string' },
105
+ tex: { type: 'string' },
106
+ beamer: { type: 'string' },
107
+ pptx: { type: 'string' },
108
+ },
109
+ additionalProperties: false,
110
+ },
111
+ sections: {
112
+ type: 'array',
113
+ description: 'Ordered list of section files to include',
114
+ items: { type: 'string', pattern: '.*\\.md$' },
115
+ },
116
+ bibliography: {
117
+ type: 'string',
118
+ description: 'Path to bibliography file (.bib)',
119
+ pattern: '.*\\.bib$',
120
+ },
121
+ csl: {
122
+ type: 'string',
123
+ description: 'Path to CSL citation style file',
124
+ },
125
+ crossref: {
126
+ type: 'object',
127
+ description: 'pandoc-crossref settings',
128
+ properties: {
129
+ figureTitle: { type: 'string', default: 'Figure' },
130
+ tableTitle: { type: 'string', default: 'Table' },
131
+ figPrefix: {
132
+ oneOf: [
133
+ { type: 'string' },
134
+ { type: 'array', items: { type: 'string' }, minItems: 1, maxItems: 2 },
135
+ ],
136
+ },
137
+ tblPrefix: {
138
+ oneOf: [
139
+ { type: 'string' },
140
+ { type: 'array', items: { type: 'string' }, minItems: 1, maxItems: 2 },
141
+ ],
142
+ },
143
+ eqnPrefix: {
144
+ oneOf: [
145
+ { type: 'string' },
146
+ { type: 'array', items: { type: 'string' }, minItems: 1, maxItems: 2 },
147
+ ],
148
+ },
149
+ secPrefix: {
150
+ oneOf: [
151
+ { type: 'string' },
152
+ { type: 'array', items: { type: 'string' }, minItems: 1, maxItems: 2 },
153
+ ],
154
+ },
155
+ linkReferences: { type: 'boolean', default: true },
156
+ },
157
+ additionalProperties: true,
158
+ },
159
+ pdf: {
160
+ type: 'object',
161
+ description: 'PDF output settings',
162
+ properties: {
163
+ template: { type: 'string' },
164
+ documentclass: {
165
+ type: 'string',
166
+ enum: ['article', 'report', 'book', 'memoir', 'scrartcl', 'scrreprt', 'scrbook'],
167
+ default: 'article',
168
+ },
169
+ fontsize: {
170
+ type: 'string',
171
+ pattern: '^\\d{1,2}pt$',
172
+ default: '12pt',
173
+ },
174
+ geometry: { type: 'string', default: 'margin=1in' },
175
+ linestretch: { type: 'number', minimum: 1, maximum: 3, default: 1.5 },
176
+ numbersections: { type: 'boolean', default: false },
177
+ toc: { type: 'boolean', default: false },
178
+ header: {
179
+ type: 'string',
180
+ description: 'Path (relative to the project root) to a LaTeX preamble file injected via pandoc -H, e.g. a header.tex with \\usepackage{lineno}\\linenumbers or fancyhdr running headers. A missing file is reported, not silently dropped. For inline LaTeX use a top-level header-includes: block instead.',
181
+ },
182
+ footer: {
183
+ type: 'string',
184
+ description: 'Second LaTeX preamble file (relative to the project root), injected via -H after pdf.header.',
185
+ },
186
+ 'pandoc-args': {
187
+ type: 'array',
188
+ description: 'Extra pandoc args for PDF builds. Appended after the top-level pandoc-args list.',
189
+ items: { type: 'string' },
190
+ },
191
+ },
192
+ additionalProperties: true,
193
+ },
194
+ docx: {
195
+ type: 'object',
196
+ description: 'Word output settings',
197
+ properties: {
198
+ reference: { type: 'string', description: 'Reference document for styling' },
199
+ keepComments: { type: 'boolean', default: true },
200
+ toc: { type: 'boolean', default: false },
201
+ translateRawFigures: {
202
+ type: 'boolean',
203
+ default: true,
204
+ description: 'Auto-translate the common \\begin{figure}...\\end{figure} shape to portable ![](){#fig: ...} markdown so figures render in docx. Pandoc strips raw LaTeX in docx output silently otherwise.',
205
+ },
206
+ 'pandoc-args': {
207
+ type: 'array',
208
+ description: 'Extra pandoc args for DOCX builds. Appended after the top-level pandoc-args list.',
209
+ items: { type: 'string' },
210
+ },
211
+ },
212
+ additionalProperties: true,
213
+ },
214
+ tex: {
215
+ type: 'object',
216
+ description: 'LaTeX output settings',
217
+ properties: {
218
+ standalone: { type: 'boolean', default: true },
219
+ 'pandoc-args': {
220
+ type: 'array',
221
+ description: 'Extra pandoc args for TeX builds. Appended after the top-level pandoc-args list.',
222
+ items: { type: 'string' },
223
+ },
224
+ },
225
+ additionalProperties: true,
226
+ },
227
+ macros: {
228
+ type: 'array',
229
+ description: 'Placeholder/highlight macros (e.g. \\tofill{X}). Built-in macros are merged automatically; entries here add new macros or override built-ins by name.',
230
+ items: {
231
+ type: 'object',
232
+ properties: {
233
+ name: {
234
+ type: 'string',
235
+ description: 'Macro command name without leading backslash, e.g. "tofill" for \\tofill{...}',
236
+ pattern: '^[A-Za-z][A-Za-z0-9]*$',
237
+ },
238
+ default: {
239
+ type: 'object',
240
+ description: 'Default rendering rules across formats',
241
+ properties: {
242
+ color: { type: 'string', pattern: '^[0-9A-Fa-f]{6}$' },
243
+ bold: { type: 'boolean' },
244
+ italic: { type: 'boolean' },
245
+ bracket: { type: 'boolean', default: true },
246
+ prefix: { type: 'string' },
247
+ suffix: { type: 'string' },
248
+ },
249
+ additionalProperties: false,
250
+ },
251
+ formats: {
252
+ type: 'object',
253
+ description: 'Per-format overrides (keys: docx, pdf, latex, html, ...)',
254
+ additionalProperties: true,
255
+ },
256
+ },
257
+ required: ['name'],
258
+ additionalProperties: false,
259
+ },
260
+ },
261
+ },
262
+ additionalProperties: true,
263
+ };
264
+
265
+ /**
266
+ * Validate a value against a simple schema
267
+ */
268
+ function validateValue(value: unknown, schema: Schema, path = ''): ValidationError[] {
269
+ const errors: ValidationError[] = [];
270
+
271
+ // Handle oneOf
272
+ if (schema.oneOf) {
273
+ const validForAny = schema.oneOf.some((subSchema) => {
274
+ const subErrors = validateValue(value, subSchema, path);
275
+ return subErrors.length === 0;
276
+ });
277
+ if (!validForAny) {
278
+ errors.push({
279
+ path,
280
+ message: `Value does not match any allowed type`,
281
+ value,
282
+ });
283
+ }
284
+ return errors;
285
+ }
286
+
287
+ // Type check
288
+ if (schema.type) {
289
+ const actualType = Array.isArray(value) ? 'array' : typeof value;
290
+ if (actualType !== schema.type) {
291
+ errors.push({
292
+ path,
293
+ message: `Expected ${schema.type}, got ${actualType}`,
294
+ value,
295
+ });
296
+ return errors; // Stop further validation if type is wrong
297
+ }
298
+ }
299
+
300
+ // String validation
301
+ if (schema.type === 'string' && typeof value === 'string') {
302
+ if (schema.pattern) {
303
+ const regex = new RegExp(schema.pattern);
304
+ if (!regex.test(value)) {
305
+ errors.push({
306
+ path,
307
+ message: `Value "${value}" does not match pattern ${schema.pattern}`,
308
+ value,
309
+ });
310
+ }
311
+ }
312
+ if (schema.enum && !schema.enum.includes(value)) {
313
+ errors.push({
314
+ path,
315
+ message: `Value "${value}" must be one of: ${schema.enum.join(', ')}`,
316
+ value,
317
+ });
318
+ }
319
+ }
320
+
321
+ // Number validation
322
+ if (schema.type === 'number' && typeof value === 'number') {
323
+ if (schema.minimum !== undefined && value < schema.minimum) {
324
+ errors.push({
325
+ path,
326
+ message: `Value ${value} is less than minimum ${schema.minimum}`,
327
+ value,
328
+ });
329
+ }
330
+ if (schema.maximum !== undefined && value > schema.maximum) {
331
+ errors.push({
332
+ path,
333
+ message: `Value ${value} is greater than maximum ${schema.maximum}`,
334
+ value,
335
+ });
336
+ }
337
+ }
338
+
339
+ // Array validation
340
+ if (schema.type === 'array' && Array.isArray(value)) {
341
+ if (schema.minItems !== undefined && value.length < schema.minItems) {
342
+ errors.push({
343
+ path,
344
+ message: `Array must have at least ${schema.minItems} items`,
345
+ value,
346
+ });
347
+ }
348
+ if (schema.maxItems !== undefined && value.length > schema.maxItems) {
349
+ errors.push({
350
+ path,
351
+ message: `Array must have at most ${schema.maxItems} items`,
352
+ value,
353
+ });
354
+ }
355
+ if (schema.items) {
356
+ value.forEach((item, index) => {
357
+ errors.push(...validateValue(item, schema.items!, `${path}[${index}]`));
358
+ });
359
+ }
360
+ }
361
+
362
+ // Object validation
363
+ if (schema.type === 'object' && typeof value === 'object' && value !== null) {
364
+ const obj = value as Record<string, unknown>;
365
+ if (schema.properties) {
366
+ for (const [key, propSchema] of Object.entries(schema.properties)) {
367
+ if (obj[key] !== undefined) {
368
+ errors.push(...validateValue(obj[key], propSchema, path ? `${path}.${key}` : key));
369
+ }
370
+ }
371
+ }
372
+ if (schema.required) {
373
+ for (const key of schema.required) {
374
+ if (obj[key] === undefined) {
375
+ errors.push({
376
+ path: path ? `${path}.${key}` : key,
377
+ message: `Required property "${key}" is missing`,
378
+ value: undefined,
379
+ });
380
+ }
381
+ }
382
+ }
383
+ }
384
+
385
+ return errors;
386
+ }
387
+
388
+ /**
389
+ * Validate rev.yaml configuration
390
+ */
391
+ export function validateConfig(config: Record<string, unknown>): ValidationResult {
392
+ const errors = validateValue(config, revYamlSchema);
393
+ const warnings: ValidationWarning[] = [];
394
+
395
+ // Additional semantic validations
396
+ if (config.sections && Array.isArray(config.sections) && config.sections.length === 0) {
397
+ warnings.push({
398
+ path: 'sections',
399
+ message: 'No sections specified - build will auto-detect .md files',
400
+ });
401
+ }
402
+
403
+ if (config.bibliography && typeof config.bibliography === 'string' && !config.bibliography.endsWith('.bib')) {
404
+ warnings.push({
405
+ path: 'bibliography',
406
+ message: 'Bibliography file should have .bib extension',
407
+ });
408
+ }
409
+
410
+ const pdf = config.pdf as { linestretch?: number } | undefined;
411
+ if (pdf?.linestretch && (pdf.linestretch < 1 || pdf.linestretch > 3)) {
412
+ warnings.push({
413
+ path: 'pdf.linestretch',
414
+ message: 'Line stretch values outside 1-3 range may produce unexpected results',
415
+ });
416
+ }
417
+
418
+ // Check for common typos
419
+ const knownKeys = Object.keys(revYamlSchema.properties || {});
420
+ for (const key of Object.keys(config)) {
421
+ if (key.startsWith('_')) continue; // Internal keys
422
+ if (!knownKeys.includes(key)) {
423
+ // Check for similar keys (possible typos)
424
+ const similar = knownKeys.find(
425
+ (k) => levenshtein(key.toLowerCase(), k.toLowerCase()) <= 2
426
+ );
427
+ if (similar) {
428
+ warnings.push({
429
+ path: key,
430
+ message: `Unknown property "${key}" - did you mean "${similar}"?`,
431
+ });
432
+ }
433
+ }
434
+ }
435
+
436
+ return {
437
+ valid: errors.length === 0,
438
+ errors,
439
+ warnings,
440
+ };
441
+ }
442
+
443
+ /**
444
+ * Format validation results for display
445
+ */
446
+ export function formatValidationResult(
447
+ result: ValidationResult,
448
+ chalk: { red: (s: string) => string; yellow: (s: string) => string; green: (s: string) => string }
449
+ ): string {
450
+ const lines: string[] = [];
451
+
452
+ if (result.errors.length > 0) {
453
+ lines.push(chalk.red('Configuration errors:'));
454
+ for (const error of result.errors) {
455
+ lines.push(chalk.red(` ✗ ${error.path}: ${error.message}`));
456
+ }
457
+ }
458
+
459
+ if (result.warnings.length > 0) {
460
+ if (lines.length > 0) lines.push('');
461
+ lines.push(chalk.yellow('Warnings:'));
462
+ for (const warning of result.warnings) {
463
+ lines.push(chalk.yellow(` ! ${warning.path}: ${warning.message}`));
464
+ }
465
+ }
466
+
467
+ if (result.valid && result.warnings.length === 0) {
468
+ lines.push(chalk.green('✓ Configuration is valid'));
469
+ }
470
+
471
+ return lines.join('\n');
472
+ }
473
+
474
+ /**
475
+ * Levenshtein distance for typo detection
476
+ */
477
+ function levenshtein(a: string, b: string): number {
478
+ const matrix = Array(b.length + 1)
479
+ .fill(null)
480
+ .map(() => Array(a.length + 1).fill(null));
481
+ for (let i = 0; i <= a.length; i++) matrix[0][i] = i;
482
+ for (let j = 0; j <= b.length; j++) matrix[j][0] = j;
483
+ for (let j = 1; j <= b.length; j++) {
484
+ for (let i = 1; i <= a.length; i++) {
485
+ const cost = a[i - 1] === b[j - 1] ? 0 : 1;
486
+ matrix[j][i] = Math.min(
487
+ matrix[j][i - 1] + 1,
488
+ matrix[j - 1][i] + 1,
489
+ matrix[j - 1][i - 1] + cost
490
+ );
491
+ }
492
+ }
493
+ return matrix[b.length][a.length];
494
+ }