docrev 0.11.1 → 0.11.3

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