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
@@ -1,180 +1,180 @@
1
- /**
2
- * Image registry utilities for tracking figures and tables in markdown documents
3
- *
4
- * The registry maps figure/table labels and display numbers to source paths,
5
- * enabling Word import to match rendered figures back to original sources.
6
- */
7
-
8
- import * as fs from 'fs';
9
- import * as path from 'path';
10
-
11
- /**
12
- * Image registry entry
13
- */
14
- interface ImageEntry {
15
- caption: string;
16
- path: string;
17
- label: string | null;
18
- type: 'fig' | 'tbl';
19
- number?: string;
20
- }
21
-
22
- /**
23
- * Image registry
24
- */
25
- interface ImageRegistry {
26
- figures: ImageEntry[];
27
- byLabel: Map<string, ImageEntry>;
28
- byNumber: Map<string, ImageEntry>;
29
- byCaption: Map<string, ImageEntry>;
30
- }
31
-
32
- /**
33
- * Crossref registry info
34
- */
35
- interface CrossrefInfo {
36
- num: number;
37
- isSupp: boolean;
38
- }
39
-
40
- /**
41
- * Crossref registry
42
- */
43
- interface CrossrefRegistry {
44
- figures: Map<string, CrossrefInfo>;
45
- tables: Map<string, CrossrefInfo>;
46
- }
47
-
48
- /**
49
- * Saved registry data
50
- */
51
- interface RegistryData {
52
- version: number;
53
- created: string;
54
- figures: ImageEntry[];
55
- }
56
-
57
- /**
58
- * Pattern to extract markdown images with optional pandoc-crossref anchors
59
- * Captures: ![caption](path){#fig:label} or ![caption](path)
60
- * Groups: [1] = caption, [2] = path, [3] = label type (fig/tbl), [4] = label
61
- */
62
- export const IMAGE_PATTERN = /!\[([^\]]*)\]\(([^)]+)\)(?:\{#(fig|tbl):([^}]+)\})?/g;
63
-
64
- /**
65
- * Build image registry from markdown content
66
- * Maps figure labels and display numbers to source paths
67
- */
68
- export function buildImageRegistry(
69
- content: string,
70
- crossrefRegistry: CrossrefRegistry | null = null
71
- ): ImageRegistry {
72
- const figures: ImageEntry[] = [];
73
- const byLabel = new Map<string, ImageEntry>();
74
- const byNumber = new Map<string, ImageEntry>();
75
- const byCaption = new Map<string, ImageEntry>();
76
-
77
- IMAGE_PATTERN.lastIndex = 0;
78
- let match: RegExpExecArray | null;
79
-
80
- while ((match = IMAGE_PATTERN.exec(content)) !== null) {
81
- const caption = match[1];
82
- const imagePath = match[2];
83
- const labelType = match[3] as 'fig' | 'tbl' | undefined; // 'fig' or 'tbl' or undefined
84
- const label = match[4]; // label without prefix
85
-
86
- const entry: ImageEntry = {
87
- caption,
88
- path: imagePath,
89
- label: label || null,
90
- type: labelType || 'fig',
91
- };
92
-
93
- // Add display number if we have a crossref registry
94
- if (label && crossrefRegistry) {
95
- const info = crossrefRegistry.figures.get(label) || crossrefRegistry.tables.get(label);
96
- if (info) {
97
- entry.number = info.isSupp ? `S${info.num}` : `${info.num}`;
98
- byNumber.set(`${entry.type}:${entry.number}`, entry);
99
- }
100
- }
101
-
102
- figures.push(entry);
103
-
104
- if (label) {
105
- byLabel.set(`${labelType || 'fig'}:${label}`, entry);
106
- }
107
-
108
- // Index by first 50 chars of caption for fuzzy matching
109
- if (caption) {
110
- const captionKey = caption.slice(0, 50).toLowerCase().trim();
111
- byCaption.set(captionKey, entry);
112
- }
113
- }
114
-
115
- return { figures, byLabel, byNumber, byCaption };
116
- }
117
-
118
- /**
119
- * Write image registry to .rev directory
120
- */
121
- export function writeImageRegistry(directory: string, registry: ImageRegistry): string {
122
- const revDir = path.join(directory, '.rev');
123
- if (!fs.existsSync(revDir)) {
124
- fs.mkdirSync(revDir, { recursive: true });
125
- }
126
-
127
- // Convert Maps to objects for JSON serialization
128
- const data: RegistryData = {
129
- version: 1,
130
- created: new Date().toISOString(),
131
- figures: registry.figures,
132
- };
133
-
134
- const registryPath = path.join(revDir, 'image-registry.json');
135
- fs.writeFileSync(registryPath, JSON.stringify(data, null, 2), 'utf-8');
136
-
137
- return registryPath;
138
- }
139
-
140
- /**
141
- * Read image registry from .rev directory
142
- */
143
- export function readImageRegistry(directory: string): (ImageRegistry & RegistryData) | null {
144
- const registryPath = path.join(directory, '.rev', 'image-registry.json');
145
-
146
- if (!fs.existsSync(registryPath)) {
147
- return null;
148
- }
149
-
150
- try {
151
- const data = JSON.parse(fs.readFileSync(registryPath, 'utf-8')) as RegistryData;
152
-
153
- // Rebuild lookup maps from figures array
154
- const byLabel = new Map<string, ImageEntry>();
155
- const byNumber = new Map<string, ImageEntry>();
156
- const byCaption = new Map<string, ImageEntry>();
157
-
158
- for (const entry of data.figures || []) {
159
- if (entry.label) {
160
- byLabel.set(`${entry.type || 'fig'}:${entry.label}`, entry);
161
- }
162
- if (entry.number) {
163
- byNumber.set(`${entry.type || 'fig'}:${entry.number}`, entry);
164
- }
165
- if (entry.caption) {
166
- const captionKey = entry.caption.slice(0, 50).toLowerCase().trim();
167
- byCaption.set(captionKey, entry);
168
- }
169
- }
170
-
171
- return {
172
- ...data,
173
- byLabel,
174
- byNumber,
175
- byCaption,
176
- };
177
- } catch (err) {
178
- return null;
179
- }
180
- }
1
+ /**
2
+ * Image registry utilities for tracking figures and tables in markdown documents
3
+ *
4
+ * The registry maps figure/table labels and display numbers to source paths,
5
+ * enabling Word import to match rendered figures back to original sources.
6
+ */
7
+
8
+ import * as fs from 'fs';
9
+ import * as path from 'path';
10
+
11
+ /**
12
+ * Image registry entry
13
+ */
14
+ interface ImageEntry {
15
+ caption: string;
16
+ path: string;
17
+ label: string | null;
18
+ type: 'fig' | 'tbl';
19
+ number?: string;
20
+ }
21
+
22
+ /**
23
+ * Image registry
24
+ */
25
+ interface ImageRegistry {
26
+ figures: ImageEntry[];
27
+ byLabel: Map<string, ImageEntry>;
28
+ byNumber: Map<string, ImageEntry>;
29
+ byCaption: Map<string, ImageEntry>;
30
+ }
31
+
32
+ /**
33
+ * Crossref registry info
34
+ */
35
+ interface CrossrefInfo {
36
+ num: number;
37
+ isSupp: boolean;
38
+ }
39
+
40
+ /**
41
+ * Crossref registry
42
+ */
43
+ interface CrossrefRegistry {
44
+ figures: Map<string, CrossrefInfo>;
45
+ tables: Map<string, CrossrefInfo>;
46
+ }
47
+
48
+ /**
49
+ * Saved registry data
50
+ */
51
+ interface RegistryData {
52
+ version: number;
53
+ created: string;
54
+ figures: ImageEntry[];
55
+ }
56
+
57
+ /**
58
+ * Pattern to extract markdown images with optional pandoc-crossref anchors
59
+ * Captures: ![caption](path){#fig:label} or ![caption](path)
60
+ * Groups: [1] = caption, [2] = path, [3] = label type (fig/tbl), [4] = label
61
+ */
62
+ export const IMAGE_PATTERN = /!\[([^\]]*)\]\(([^)]+)\)(?:\{#(fig|tbl):([^}]+)\})?/g;
63
+
64
+ /**
65
+ * Build image registry from markdown content
66
+ * Maps figure labels and display numbers to source paths
67
+ */
68
+ export function buildImageRegistry(
69
+ content: string,
70
+ crossrefRegistry: CrossrefRegistry | null = null
71
+ ): ImageRegistry {
72
+ const figures: ImageEntry[] = [];
73
+ const byLabel = new Map<string, ImageEntry>();
74
+ const byNumber = new Map<string, ImageEntry>();
75
+ const byCaption = new Map<string, ImageEntry>();
76
+
77
+ IMAGE_PATTERN.lastIndex = 0;
78
+ let match: RegExpExecArray | null;
79
+
80
+ while ((match = IMAGE_PATTERN.exec(content)) !== null) {
81
+ const caption = match[1];
82
+ const imagePath = match[2];
83
+ const labelType = match[3] as 'fig' | 'tbl' | undefined; // 'fig' or 'tbl' or undefined
84
+ const label = match[4]; // label without prefix
85
+
86
+ const entry: ImageEntry = {
87
+ caption,
88
+ path: imagePath,
89
+ label: label || null,
90
+ type: labelType || 'fig',
91
+ };
92
+
93
+ // Add display number if we have a crossref registry
94
+ if (label && crossrefRegistry) {
95
+ const info = crossrefRegistry.figures.get(label) || crossrefRegistry.tables.get(label);
96
+ if (info) {
97
+ entry.number = info.isSupp ? `S${info.num}` : `${info.num}`;
98
+ byNumber.set(`${entry.type}:${entry.number}`, entry);
99
+ }
100
+ }
101
+
102
+ figures.push(entry);
103
+
104
+ if (label) {
105
+ byLabel.set(`${labelType || 'fig'}:${label}`, entry);
106
+ }
107
+
108
+ // Index by first 50 chars of caption for fuzzy matching
109
+ if (caption) {
110
+ const captionKey = caption.slice(0, 50).toLowerCase().trim();
111
+ byCaption.set(captionKey, entry);
112
+ }
113
+ }
114
+
115
+ return { figures, byLabel, byNumber, byCaption };
116
+ }
117
+
118
+ /**
119
+ * Write image registry to .rev directory
120
+ */
121
+ export function writeImageRegistry(directory: string, registry: ImageRegistry): string {
122
+ const revDir = path.join(directory, '.rev');
123
+ if (!fs.existsSync(revDir)) {
124
+ fs.mkdirSync(revDir, { recursive: true });
125
+ }
126
+
127
+ // Convert Maps to objects for JSON serialization
128
+ const data: RegistryData = {
129
+ version: 1,
130
+ created: new Date().toISOString(),
131
+ figures: registry.figures,
132
+ };
133
+
134
+ const registryPath = path.join(revDir, 'image-registry.json');
135
+ fs.writeFileSync(registryPath, JSON.stringify(data, null, 2), 'utf-8');
136
+
137
+ return registryPath;
138
+ }
139
+
140
+ /**
141
+ * Read image registry from .rev directory
142
+ */
143
+ export function readImageRegistry(directory: string): (ImageRegistry & RegistryData) | null {
144
+ const registryPath = path.join(directory, '.rev', 'image-registry.json');
145
+
146
+ if (!fs.existsSync(registryPath)) {
147
+ return null;
148
+ }
149
+
150
+ try {
151
+ const data = JSON.parse(fs.readFileSync(registryPath, 'utf-8')) as RegistryData;
152
+
153
+ // Rebuild lookup maps from figures array
154
+ const byLabel = new Map<string, ImageEntry>();
155
+ const byNumber = new Map<string, ImageEntry>();
156
+ const byCaption = new Map<string, ImageEntry>();
157
+
158
+ for (const entry of data.figures || []) {
159
+ if (entry.label) {
160
+ byLabel.set(`${entry.type || 'fig'}:${entry.label}`, entry);
161
+ }
162
+ if (entry.number) {
163
+ byNumber.set(`${entry.type || 'fig'}:${entry.number}`, entry);
164
+ }
165
+ if (entry.caption) {
166
+ const captionKey = entry.caption.slice(0, 50).toLowerCase().trim();
167
+ byCaption.set(captionKey, entry);
168
+ }
169
+ }
170
+
171
+ return {
172
+ ...data,
173
+ byLabel,
174
+ byNumber,
175
+ byCaption,
176
+ };
177
+ } catch (err) {
178
+ return null;
179
+ }
180
+ }