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