docrev 0.10.1 → 0.11.0

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 (167) 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 +4 -2
  11. package/dist/lib/anchor-match.d.ts.map +1 -1
  12. package/dist/lib/anchor-match.js +52 -24
  13. package/dist/lib/anchor-match.js.map +1 -1
  14. package/dist/lib/annotations.d.ts +0 -6
  15. package/dist/lib/annotations.d.ts.map +1 -1
  16. package/dist/lib/annotations.js +26 -8
  17. package/dist/lib/annotations.js.map +1 -1
  18. package/dist/lib/build.d.ts.map +1 -1
  19. package/dist/lib/build.js +13 -10
  20. package/dist/lib/build.js.map +1 -1
  21. package/dist/lib/commands/build.d.ts.map +1 -1
  22. package/dist/lib/commands/build.js +5 -0
  23. package/dist/lib/commands/build.js.map +1 -1
  24. package/dist/lib/commands/doi.d.ts.map +1 -1
  25. package/dist/lib/commands/doi.js +14 -2
  26. package/dist/lib/commands/doi.js.map +1 -1
  27. package/dist/lib/commands/sync.d.ts.map +1 -1
  28. package/dist/lib/commands/sync.js +98 -107
  29. package/dist/lib/commands/sync.js.map +1 -1
  30. package/dist/lib/commands/utilities.js +164 -164
  31. package/dist/lib/commands/word-tools.js +8 -8
  32. package/dist/lib/comment-realign.d.ts +12 -21
  33. package/dist/lib/comment-realign.d.ts.map +1 -1
  34. package/dist/lib/comment-realign.js +40 -348
  35. package/dist/lib/comment-realign.js.map +1 -1
  36. package/dist/lib/dependencies.d.ts +10 -0
  37. package/dist/lib/dependencies.d.ts.map +1 -1
  38. package/dist/lib/dependencies.js +41 -9
  39. package/dist/lib/dependencies.js.map +1 -1
  40. package/dist/lib/doi.d.ts.map +1 -1
  41. package/dist/lib/doi.js +68 -80
  42. package/dist/lib/doi.js.map +1 -1
  43. package/dist/lib/errors.d.ts.map +1 -1
  44. package/dist/lib/errors.js +3 -1
  45. package/dist/lib/errors.js.map +1 -1
  46. package/dist/lib/grammar.js +3 -3
  47. package/dist/lib/import.d.ts +7 -4
  48. package/dist/lib/import.d.ts.map +1 -1
  49. package/dist/lib/import.js +58 -62
  50. package/dist/lib/import.js.map +1 -1
  51. package/dist/lib/macro-filter.lua +201 -201
  52. package/dist/lib/ooxml.d.ts +207 -0
  53. package/dist/lib/ooxml.d.ts.map +1 -0
  54. package/dist/lib/ooxml.js +634 -0
  55. package/dist/lib/ooxml.js.map +1 -0
  56. package/dist/lib/pdf-comments.js +44 -44
  57. package/dist/lib/plugins.js +57 -57
  58. package/dist/lib/pptx-color-filter.lua +37 -37
  59. package/dist/lib/pptx-themes.js +115 -115
  60. package/dist/lib/rate-limiter.d.ts +8 -0
  61. package/dist/lib/rate-limiter.d.ts.map +1 -1
  62. package/dist/lib/rate-limiter.js +41 -4
  63. package/dist/lib/rate-limiter.js.map +1 -1
  64. package/dist/lib/sections.d.ts.map +1 -1
  65. package/dist/lib/sections.js +5 -2
  66. package/dist/lib/sections.js.map +1 -1
  67. package/dist/lib/spelling.js +2 -2
  68. package/dist/lib/templates.js +387 -387
  69. package/dist/lib/themes.js +51 -51
  70. package/dist/lib/types.d.ts +9 -1
  71. package/dist/lib/types.d.ts.map +1 -1
  72. package/dist/lib/word-extraction.d.ts.map +1 -1
  73. package/dist/lib/word-extraction.js +48 -307
  74. package/dist/lib/word-extraction.js.map +1 -1
  75. package/dist/lib/word.d.ts.map +1 -1
  76. package/dist/lib/word.js +80 -175
  77. package/dist/lib/word.js.map +1 -1
  78. package/dist/lib/wordcomments.d.ts.map +1 -1
  79. package/dist/lib/wordcomments.js +53 -92
  80. package/dist/lib/wordcomments.js.map +1 -1
  81. package/docs-src/build.py +113 -113
  82. package/docs-src/extra.css +208 -208
  83. package/docs-src/md-to-html.lua +6 -6
  84. package/docs-src/template.html +116 -116
  85. package/eslint.config.js +27 -27
  86. package/lib/anchor-match.ts +307 -276
  87. package/lib/annotations.ts +664 -644
  88. package/lib/build.ts +1770 -1766
  89. package/lib/citations.ts +160 -160
  90. package/lib/commands/build.ts +860 -855
  91. package/lib/commands/citations.ts +515 -515
  92. package/lib/commands/comments.ts +1050 -1050
  93. package/lib/commands/context.ts +176 -176
  94. package/lib/commands/core.ts +309 -309
  95. package/lib/commands/doi.ts +451 -435
  96. package/lib/commands/file-ops.ts +372 -372
  97. package/lib/commands/history.ts +320 -320
  98. package/lib/commands/index.ts +87 -87
  99. package/lib/commands/init.ts +259 -259
  100. package/lib/commands/merge-resolve.ts +378 -378
  101. package/lib/commands/preview.ts +178 -178
  102. package/lib/commands/project-info.ts +244 -244
  103. package/lib/commands/quality.ts +517 -517
  104. package/lib/commands/response.ts +454 -454
  105. package/lib/commands/section-boundaries.ts +82 -82
  106. package/lib/commands/sections.ts +451 -451
  107. package/lib/commands/sync.ts +689 -709
  108. package/lib/commands/text-ops.ts +449 -449
  109. package/lib/commands/utilities.ts +448 -448
  110. package/lib/commands/verify-anchors.ts +272 -272
  111. package/lib/commands/word-tools.ts +340 -340
  112. package/lib/comment-realign.ts +99 -517
  113. package/lib/config.ts +84 -84
  114. package/lib/crossref.ts +781 -781
  115. package/lib/csl.ts +191 -191
  116. package/lib/dependencies.ts +132 -98
  117. package/lib/diff-engine.ts +465 -465
  118. package/lib/doi-cache.ts +115 -115
  119. package/lib/doi.ts +879 -897
  120. package/lib/equations.ts +506 -506
  121. package/lib/errors.ts +350 -346
  122. package/lib/format.ts +541 -541
  123. package/lib/git.ts +326 -326
  124. package/lib/grammar.ts +303 -303
  125. package/lib/image-registry.ts +180 -180
  126. package/lib/import.ts +906 -911
  127. package/lib/journals.ts +543 -543
  128. package/lib/macro-filter.lua +201 -201
  129. package/lib/macros.ts +273 -273
  130. package/lib/merge.ts +633 -633
  131. package/lib/ooxml.ts +768 -0
  132. package/lib/orcid.ts +144 -144
  133. package/lib/pdf-comments.ts +263 -263
  134. package/lib/pdf-import.ts +524 -524
  135. package/lib/plugins.ts +362 -362
  136. package/lib/postprocess.ts +188 -188
  137. package/lib/pptx-color-filter.lua +37 -37
  138. package/lib/pptx-template.ts +469 -469
  139. package/lib/pptx-themes.ts +483 -483
  140. package/lib/protect-restore.ts +520 -520
  141. package/lib/rate-limiter.ts +127 -94
  142. package/lib/response.ts +197 -197
  143. package/lib/restore-references.ts +240 -240
  144. package/lib/review.ts +327 -327
  145. package/lib/schema.ts +488 -488
  146. package/lib/scientific-words.ts +73 -73
  147. package/lib/sections.ts +428 -425
  148. package/lib/slides.ts +756 -756
  149. package/lib/spelling.ts +334 -334
  150. package/lib/templates.ts +526 -526
  151. package/lib/themes.ts +742 -742
  152. package/lib/trackchanges.ts +247 -247
  153. package/lib/tui.ts +450 -450
  154. package/lib/types.ts +558 -550
  155. package/lib/undo.ts +250 -250
  156. package/lib/utils.ts +69 -69
  157. package/lib/variables.ts +179 -179
  158. package/lib/word-extraction.ts +525 -806
  159. package/lib/word.ts +526 -643
  160. package/lib/wordcomments.ts +789 -840
  161. package/mkdocs.yml +64 -64
  162. package/package.json +137 -137
  163. package/scripts/postbuild.js +47 -47
  164. package/skill/REFERENCE.md +539 -539
  165. package/skill/SKILL.md +295 -295
  166. package/tsconfig.json +26 -26
  167. package/types/index.d.ts +525 -525
@@ -1,178 +1,178 @@
1
- /**
2
- * Preview commands: preview, watch
3
- *
4
- * Commands for building and viewing documents with live reload.
5
- */
6
-
7
- import type { Command } from 'commander';
8
- import {
9
- chalk,
10
- fs,
11
- path,
12
- fmt,
13
- loadBuildConfig,
14
- } from './context.js';
15
-
16
- // Use the actual BuildConfig from build.ts which allows string|Author[]
17
- type BuildConfig = ReturnType<typeof loadBuildConfig>;
18
-
19
- // Options interfaces
20
- interface PreviewOptions {
21
- // No options currently
22
- }
23
-
24
- interface WatchOptions {
25
- open?: boolean;
26
- }
27
-
28
- /**
29
- * Register preview commands with the program
30
- */
31
- export function register(program: Command): void {
32
- // ==========================================================================
33
- // PREVIEW command - Build and open document
34
- // ==========================================================================
35
-
36
- program
37
- .command('preview')
38
- .description('Build and open document in default app')
39
- .argument('[format]', 'Format to preview: pdf, docx', 'pdf')
40
- .action(async (format: string, _options: PreviewOptions) => {
41
- const { exec } = await import('child_process');
42
- const { build } = await import('../build.js');
43
-
44
- let config: Partial<BuildConfig> = {};
45
- try {
46
- config = loadBuildConfig('.') || {};
47
- } catch (err) {
48
- console.error(chalk.red('Not in a rev project directory (no rev.yaml found)'));
49
- process.exit(1);
50
- }
51
-
52
- console.log(chalk.dim(`Building ${format}...`));
53
- const result = await build('.', [format]);
54
-
55
- const buildResult = result.results.find(r => r.format === format);
56
- if (!buildResult?.success) {
57
- const errorMsg = buildResult?.error || 'Unknown error';
58
- console.error(chalk.red(`Build failed: ${errorMsg}`));
59
- process.exit(1);
60
- }
61
-
62
- const outputFile = buildResult.outputPath;
63
- if (!outputFile || !fs.existsSync(outputFile)) {
64
- console.error(chalk.red(`Output file not found: ${outputFile}`));
65
- process.exit(1);
66
- }
67
-
68
- // Open with system default
69
- const openCmd = process.platform === 'darwin' ? 'open' :
70
- process.platform === 'win32' ? 'start' : 'xdg-open';
71
-
72
- exec(`${openCmd} "${outputFile}"`, (err) => {
73
- if (err) {
74
- console.error(chalk.red(`Could not open file: ${err.message}`));
75
- } else {
76
- console.log(fmt.status('success', `Opened ${outputFile}`));
77
- }
78
- });
79
- });
80
-
81
- // ==========================================================================
82
- // WATCH command - Auto-rebuild on changes
83
- // ==========================================================================
84
-
85
- program
86
- .command('watch')
87
- .description('Watch files and auto-rebuild on changes')
88
- .argument('[format]', 'Format to build: pdf, docx, all', 'pdf')
89
- .option('--no-open', 'Do not open after first build')
90
- .action(async (format: string, options: WatchOptions) => {
91
- const { exec } = await import('child_process');
92
- const { build } = await import('../build.js');
93
-
94
- let config: Partial<BuildConfig> = {};
95
- try {
96
- config = loadBuildConfig('.') || {};
97
- } catch (err) {
98
- console.error(chalk.red('Not in a rev project directory (no rev.yaml found)'));
99
- process.exit(1);
100
- }
101
- let sections = config.sections || [];
102
-
103
- if (sections.length === 0) {
104
- sections = fs.readdirSync('.').filter(f =>
105
- f.endsWith('.md') && !['README.md', 'CLAUDE.md', 'paper.md'].includes(f)
106
- );
107
- }
108
-
109
- const filesToWatch = [
110
- ...sections,
111
- 'rev.yaml',
112
- config.bibliography || 'references.bib'
113
- ].filter(f => fs.existsSync(f));
114
-
115
- console.log(fmt.header('Watch Mode'));
116
- console.log(chalk.dim(`Watching: ${filesToWatch.join(', ')}`));
117
- console.log(chalk.dim('Press Ctrl+C to stop\n'));
118
-
119
- let building = false;
120
- let pendingBuild = false;
121
-
122
- const doBuild = async (): Promise<void> => {
123
- if (building) {
124
- pendingBuild = true;
125
- return;
126
- }
127
-
128
- building = true;
129
- console.log(chalk.dim(`\n[${new Date().toLocaleTimeString()}] Rebuilding...`));
130
-
131
- try {
132
- const formats = format === 'all' ? ['pdf', 'docx'] : [format];
133
- const result = await build('.', formats);
134
-
135
- for (const r of result.results) {
136
- if (r.success) {
137
- console.log(chalk.green(` ✓ ${r.format}: ${r.outputPath}`));
138
- } else {
139
- console.log(chalk.red(` ✗ ${r.format}: ${r.error}`));
140
- }
141
- }
142
- } catch (err) {
143
- console.error(chalk.red(` Build error: ${(err as Error).message}`));
144
- }
145
-
146
- building = false;
147
- if (pendingBuild) {
148
- pendingBuild = false;
149
- doBuild();
150
- }
151
- };
152
-
153
- // Initial build
154
- await doBuild();
155
-
156
- // Open after first build
157
- if (options.open) {
158
- const outputFile = format === 'docx' ?
159
- (config.title?.replace(/[^a-zA-Z0-9]/g, '-').toLowerCase() || 'paper') + '.docx' :
160
- (config.title?.replace(/[^a-zA-Z0-9]/g, '-').toLowerCase() || 'paper') + '.pdf';
161
-
162
- if (fs.existsSync(outputFile)) {
163
- const openCmd = process.platform === 'darwin' ? 'open' :
164
- process.platform === 'win32' ? 'start' : 'xdg-open';
165
- exec(`${openCmd} "${outputFile}"`);
166
- }
167
- }
168
-
169
- // Watch files
170
- for (const file of filesToWatch) {
171
- fs.watch(file, { persistent: true }, (eventType) => {
172
- if (eventType === 'change') {
173
- doBuild();
174
- }
175
- });
176
- }
177
- });
178
- }
1
+ /**
2
+ * Preview commands: preview, watch
3
+ *
4
+ * Commands for building and viewing documents with live reload.
5
+ */
6
+
7
+ import type { Command } from 'commander';
8
+ import {
9
+ chalk,
10
+ fs,
11
+ path,
12
+ fmt,
13
+ loadBuildConfig,
14
+ } from './context.js';
15
+
16
+ // Use the actual BuildConfig from build.ts which allows string|Author[]
17
+ type BuildConfig = ReturnType<typeof loadBuildConfig>;
18
+
19
+ // Options interfaces
20
+ interface PreviewOptions {
21
+ // No options currently
22
+ }
23
+
24
+ interface WatchOptions {
25
+ open?: boolean;
26
+ }
27
+
28
+ /**
29
+ * Register preview commands with the program
30
+ */
31
+ export function register(program: Command): void {
32
+ // ==========================================================================
33
+ // PREVIEW command - Build and open document
34
+ // ==========================================================================
35
+
36
+ program
37
+ .command('preview')
38
+ .description('Build and open document in default app')
39
+ .argument('[format]', 'Format to preview: pdf, docx', 'pdf')
40
+ .action(async (format: string, _options: PreviewOptions) => {
41
+ const { exec } = await import('child_process');
42
+ const { build } = await import('../build.js');
43
+
44
+ let config: Partial<BuildConfig> = {};
45
+ try {
46
+ config = loadBuildConfig('.') || {};
47
+ } catch (err) {
48
+ console.error(chalk.red('Not in a rev project directory (no rev.yaml found)'));
49
+ process.exit(1);
50
+ }
51
+
52
+ console.log(chalk.dim(`Building ${format}...`));
53
+ const result = await build('.', [format]);
54
+
55
+ const buildResult = result.results.find(r => r.format === format);
56
+ if (!buildResult?.success) {
57
+ const errorMsg = buildResult?.error || 'Unknown error';
58
+ console.error(chalk.red(`Build failed: ${errorMsg}`));
59
+ process.exit(1);
60
+ }
61
+
62
+ const outputFile = buildResult.outputPath;
63
+ if (!outputFile || !fs.existsSync(outputFile)) {
64
+ console.error(chalk.red(`Output file not found: ${outputFile}`));
65
+ process.exit(1);
66
+ }
67
+
68
+ // Open with system default
69
+ const openCmd = process.platform === 'darwin' ? 'open' :
70
+ process.platform === 'win32' ? 'start' : 'xdg-open';
71
+
72
+ exec(`${openCmd} "${outputFile}"`, (err) => {
73
+ if (err) {
74
+ console.error(chalk.red(`Could not open file: ${err.message}`));
75
+ } else {
76
+ console.log(fmt.status('success', `Opened ${outputFile}`));
77
+ }
78
+ });
79
+ });
80
+
81
+ // ==========================================================================
82
+ // WATCH command - Auto-rebuild on changes
83
+ // ==========================================================================
84
+
85
+ program
86
+ .command('watch')
87
+ .description('Watch files and auto-rebuild on changes')
88
+ .argument('[format]', 'Format to build: pdf, docx, all', 'pdf')
89
+ .option('--no-open', 'Do not open after first build')
90
+ .action(async (format: string, options: WatchOptions) => {
91
+ const { exec } = await import('child_process');
92
+ const { build } = await import('../build.js');
93
+
94
+ let config: Partial<BuildConfig> = {};
95
+ try {
96
+ config = loadBuildConfig('.') || {};
97
+ } catch (err) {
98
+ console.error(chalk.red('Not in a rev project directory (no rev.yaml found)'));
99
+ process.exit(1);
100
+ }
101
+ let sections = config.sections || [];
102
+
103
+ if (sections.length === 0) {
104
+ sections = fs.readdirSync('.').filter(f =>
105
+ f.endsWith('.md') && !['README.md', 'CLAUDE.md', 'paper.md'].includes(f)
106
+ );
107
+ }
108
+
109
+ const filesToWatch = [
110
+ ...sections,
111
+ 'rev.yaml',
112
+ config.bibliography || 'references.bib'
113
+ ].filter(f => fs.existsSync(f));
114
+
115
+ console.log(fmt.header('Watch Mode'));
116
+ console.log(chalk.dim(`Watching: ${filesToWatch.join(', ')}`));
117
+ console.log(chalk.dim('Press Ctrl+C to stop\n'));
118
+
119
+ let building = false;
120
+ let pendingBuild = false;
121
+
122
+ const doBuild = async (): Promise<void> => {
123
+ if (building) {
124
+ pendingBuild = true;
125
+ return;
126
+ }
127
+
128
+ building = true;
129
+ console.log(chalk.dim(`\n[${new Date().toLocaleTimeString()}] Rebuilding...`));
130
+
131
+ try {
132
+ const formats = format === 'all' ? ['pdf', 'docx'] : [format];
133
+ const result = await build('.', formats);
134
+
135
+ for (const r of result.results) {
136
+ if (r.success) {
137
+ console.log(chalk.green(` ✓ ${r.format}: ${r.outputPath}`));
138
+ } else {
139
+ console.log(chalk.red(` ✗ ${r.format}: ${r.error}`));
140
+ }
141
+ }
142
+ } catch (err) {
143
+ console.error(chalk.red(` Build error: ${(err as Error).message}`));
144
+ }
145
+
146
+ building = false;
147
+ if (pendingBuild) {
148
+ pendingBuild = false;
149
+ doBuild();
150
+ }
151
+ };
152
+
153
+ // Initial build
154
+ await doBuild();
155
+
156
+ // Open after first build
157
+ if (options.open) {
158
+ const outputFile = format === 'docx' ?
159
+ (config.title?.replace(/[^a-zA-Z0-9]/g, '-').toLowerCase() || 'paper') + '.docx' :
160
+ (config.title?.replace(/[^a-zA-Z0-9]/g, '-').toLowerCase() || 'paper') + '.pdf';
161
+
162
+ if (fs.existsSync(outputFile)) {
163
+ const openCmd = process.platform === 'darwin' ? 'open' :
164
+ process.platform === 'win32' ? 'start' : 'xdg-open';
165
+ exec(`${openCmd} "${outputFile}"`);
166
+ }
167
+ }
168
+
169
+ // Watch files
170
+ for (const file of filesToWatch) {
171
+ fs.watch(file, { persistent: true }, (eventType) => {
172
+ if (eventType === 'change') {
173
+ doBuild();
174
+ }
175
+ });
176
+ }
177
+ });
178
+ }