docrev 0.10.1 → 0.10.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 (119) hide show
  1. package/.gitattributes +1 -1
  2. package/CHANGELOG.md +184 -173
  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 +47 -17
  13. package/dist/lib/anchor-match.js.map +1 -1
  14. package/dist/lib/build.js +4 -4
  15. package/dist/lib/commands/sync.d.ts.map +1 -1
  16. package/dist/lib/commands/sync.js +78 -100
  17. package/dist/lib/commands/sync.js.map +1 -1
  18. package/dist/lib/commands/utilities.js +164 -164
  19. package/dist/lib/commands/word-tools.js +8 -8
  20. package/dist/lib/grammar.js +3 -3
  21. package/dist/lib/macro-filter.lua +201 -201
  22. package/dist/lib/pdf-comments.js +44 -44
  23. package/dist/lib/plugins.js +57 -57
  24. package/dist/lib/pptx-color-filter.lua +37 -37
  25. package/dist/lib/pptx-themes.js +115 -115
  26. package/dist/lib/sections.d.ts.map +1 -1
  27. package/dist/lib/sections.js +5 -2
  28. package/dist/lib/sections.js.map +1 -1
  29. package/dist/lib/spelling.js +2 -2
  30. package/dist/lib/templates.js +387 -387
  31. package/dist/lib/themes.js +51 -51
  32. package/eslint.config.js +27 -27
  33. package/issues.md +180 -0
  34. package/lib/anchor-match.ts +308 -276
  35. package/lib/annotations.ts +644 -644
  36. package/lib/build.ts +1766 -1766
  37. package/lib/citations.ts +160 -160
  38. package/lib/commands/build.ts +855 -855
  39. package/lib/commands/citations.ts +515 -515
  40. package/lib/commands/comments.ts +1050 -1050
  41. package/lib/commands/context.ts +176 -176
  42. package/lib/commands/core.ts +309 -309
  43. package/lib/commands/doi.ts +435 -435
  44. package/lib/commands/file-ops.ts +372 -372
  45. package/lib/commands/history.ts +320 -320
  46. package/lib/commands/index.ts +87 -87
  47. package/lib/commands/init.ts +259 -259
  48. package/lib/commands/merge-resolve.ts +378 -378
  49. package/lib/commands/preview.ts +178 -178
  50. package/lib/commands/project-info.ts +244 -244
  51. package/lib/commands/quality.ts +517 -517
  52. package/lib/commands/response.ts +454 -454
  53. package/lib/commands/section-boundaries.ts +82 -82
  54. package/lib/commands/sections.ts +451 -451
  55. package/lib/commands/sync.ts +676 -709
  56. package/lib/commands/text-ops.ts +449 -449
  57. package/lib/commands/utilities.ts +448 -448
  58. package/lib/commands/verify-anchors.ts +272 -272
  59. package/lib/commands/word-tools.ts +340 -340
  60. package/lib/comment-realign.ts +517 -517
  61. package/lib/config.ts +84 -84
  62. package/lib/crossref.ts +781 -781
  63. package/lib/csl.ts +191 -191
  64. package/lib/dependencies.ts +98 -98
  65. package/lib/diff-engine.ts +465 -465
  66. package/lib/doi-cache.ts +115 -115
  67. package/lib/doi.ts +897 -897
  68. package/lib/equations.ts +506 -506
  69. package/lib/errors.ts +346 -346
  70. package/lib/format.ts +541 -541
  71. package/lib/git.ts +326 -326
  72. package/lib/grammar.ts +303 -303
  73. package/lib/image-registry.ts +180 -180
  74. package/lib/import.ts +911 -911
  75. package/lib/journals.ts +543 -543
  76. package/lib/macro-filter.lua +201 -201
  77. package/lib/macros.ts +273 -273
  78. package/lib/merge.ts +633 -633
  79. package/lib/orcid.ts +144 -144
  80. package/lib/pdf-comments.ts +263 -263
  81. package/lib/pdf-import.ts +524 -524
  82. package/lib/plugins.ts +362 -362
  83. package/lib/postprocess.ts +188 -188
  84. package/lib/pptx-color-filter.lua +37 -37
  85. package/lib/pptx-template.ts +469 -469
  86. package/lib/pptx-themes.ts +483 -483
  87. package/lib/protect-restore.ts +520 -520
  88. package/lib/rate-limiter.ts +94 -94
  89. package/lib/response.ts +197 -197
  90. package/lib/restore-references.ts +240 -240
  91. package/lib/review.ts +327 -327
  92. package/lib/schema.ts +488 -488
  93. package/lib/scientific-words.ts +73 -73
  94. package/lib/sections.ts +428 -425
  95. package/lib/slides.ts +756 -756
  96. package/lib/spelling.ts +334 -334
  97. package/lib/templates.ts +526 -526
  98. package/lib/themes.ts +742 -742
  99. package/lib/trackchanges.ts +247 -247
  100. package/lib/tui.ts +450 -450
  101. package/lib/types.ts +550 -550
  102. package/lib/undo.ts +250 -250
  103. package/lib/utils.ts +69 -69
  104. package/lib/variables.ts +179 -179
  105. package/lib/word-extraction.ts +806 -806
  106. package/lib/word.ts +643 -643
  107. package/lib/wordcomments.ts +840 -840
  108. package/package.json +137 -137
  109. package/scripts/postbuild.js +47 -47
  110. package/site/assets/extra.css +208 -0
  111. package/site/commands.html +926 -0
  112. package/site/configuration.html +469 -0
  113. package/site/index.html +288 -0
  114. package/site/troubleshooting.html +461 -0
  115. package/site/workflow.html +518 -0
  116. package/skill/REFERENCE.md +539 -539
  117. package/skill/SKILL.md +295 -295
  118. package/tsconfig.json +26 -26
  119. package/types/index.d.ts +525 -525
@@ -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
+ }