docrev 0.10.0 → 0.10.1

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 (126) hide show
  1. package/.gitattributes +1 -1
  2. package/CHANGELOG.md +173 -164
  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 +17 -47
  13. package/dist/lib/anchor-match.js.map +1 -1
  14. package/dist/lib/build.js +4 -4
  15. package/dist/lib/commands/context.d.ts +1 -1
  16. package/dist/lib/commands/context.d.ts.map +1 -1
  17. package/dist/lib/commands/context.js +1 -1
  18. package/dist/lib/commands/context.js.map +1 -1
  19. package/dist/lib/commands/sections.js +7 -7
  20. package/dist/lib/commands/sections.js.map +1 -1
  21. package/dist/lib/commands/sync.d.ts.map +1 -1
  22. package/dist/lib/commands/sync.js +15 -14
  23. package/dist/lib/commands/sync.js.map +1 -1
  24. package/dist/lib/commands/utilities.js +164 -164
  25. package/dist/lib/commands/verify-anchors.js +6 -6
  26. package/dist/lib/commands/verify-anchors.js.map +1 -1
  27. package/dist/lib/commands/word-tools.js +8 -8
  28. package/dist/lib/grammar.js +3 -3
  29. package/dist/lib/macro-filter.lua +201 -201
  30. package/dist/lib/pdf-comments.js +44 -44
  31. package/dist/lib/plugins.js +57 -57
  32. package/dist/lib/pptx-color-filter.lua +37 -37
  33. package/dist/lib/pptx-themes.js +115 -115
  34. package/dist/lib/sections.d.ts +35 -0
  35. package/dist/lib/sections.d.ts.map +1 -1
  36. package/dist/lib/sections.js +81 -0
  37. package/dist/lib/sections.js.map +1 -1
  38. package/dist/lib/spelling.js +2 -2
  39. package/dist/lib/templates.js +387 -387
  40. package/dist/lib/themes.js +51 -51
  41. package/docs-src/build.py +113 -113
  42. package/docs-src/extra.css +208 -208
  43. package/docs-src/md-to-html.lua +6 -6
  44. package/docs-src/template.html +116 -116
  45. package/eslint.config.js +27 -27
  46. package/lib/anchor-match.ts +276 -308
  47. package/lib/annotations.ts +644 -644
  48. package/lib/build.ts +1766 -1766
  49. package/lib/citations.ts +160 -160
  50. package/lib/commands/build.ts +855 -855
  51. package/lib/commands/citations.ts +515 -515
  52. package/lib/commands/comments.ts +1050 -1050
  53. package/lib/commands/context.ts +176 -174
  54. package/lib/commands/core.ts +309 -309
  55. package/lib/commands/doi.ts +435 -435
  56. package/lib/commands/file-ops.ts +372 -372
  57. package/lib/commands/history.ts +320 -320
  58. package/lib/commands/index.ts +87 -87
  59. package/lib/commands/init.ts +259 -259
  60. package/lib/commands/merge-resolve.ts +378 -378
  61. package/lib/commands/preview.ts +178 -178
  62. package/lib/commands/project-info.ts +244 -244
  63. package/lib/commands/quality.ts +517 -517
  64. package/lib/commands/response.ts +454 -454
  65. package/lib/commands/section-boundaries.ts +82 -82
  66. package/lib/commands/sections.ts +451 -451
  67. package/lib/commands/sync.ts +709 -706
  68. package/lib/commands/text-ops.ts +449 -449
  69. package/lib/commands/utilities.ts +448 -448
  70. package/lib/commands/verify-anchors.ts +272 -272
  71. package/lib/commands/word-tools.ts +340 -340
  72. package/lib/comment-realign.ts +517 -517
  73. package/lib/config.ts +84 -84
  74. package/lib/crossref.ts +781 -781
  75. package/lib/csl.ts +191 -191
  76. package/lib/dependencies.ts +98 -98
  77. package/lib/diff-engine.ts +465 -465
  78. package/lib/doi-cache.ts +115 -115
  79. package/lib/doi.ts +897 -897
  80. package/lib/equations.ts +506 -506
  81. package/lib/errors.ts +346 -346
  82. package/lib/format.ts +541 -541
  83. package/lib/git.ts +326 -326
  84. package/lib/grammar.ts +303 -303
  85. package/lib/image-registry.ts +180 -180
  86. package/lib/import.ts +911 -911
  87. package/lib/journals.ts +543 -543
  88. package/lib/macro-filter.lua +201 -201
  89. package/lib/macros.ts +273 -273
  90. package/lib/merge.ts +633 -633
  91. package/lib/orcid.ts +144 -144
  92. package/lib/pdf-comments.ts +263 -263
  93. package/lib/pdf-import.ts +524 -524
  94. package/lib/plugins.ts +362 -362
  95. package/lib/postprocess.ts +188 -188
  96. package/lib/pptx-color-filter.lua +37 -37
  97. package/lib/pptx-template.ts +469 -469
  98. package/lib/pptx-themes.ts +483 -483
  99. package/lib/protect-restore.ts +520 -520
  100. package/lib/rate-limiter.ts +94 -94
  101. package/lib/response.ts +197 -197
  102. package/lib/restore-references.ts +240 -240
  103. package/lib/review.ts +327 -327
  104. package/lib/schema.ts +488 -488
  105. package/lib/scientific-words.ts +73 -73
  106. package/lib/sections.ts +425 -335
  107. package/lib/slides.ts +756 -756
  108. package/lib/spelling.ts +334 -334
  109. package/lib/templates.ts +526 -526
  110. package/lib/themes.ts +742 -742
  111. package/lib/trackchanges.ts +247 -247
  112. package/lib/tui.ts +450 -450
  113. package/lib/types.ts +550 -550
  114. package/lib/undo.ts +250 -250
  115. package/lib/utils.ts +69 -69
  116. package/lib/variables.ts +179 -179
  117. package/lib/word-extraction.ts +806 -806
  118. package/lib/word.ts +643 -643
  119. package/lib/wordcomments.ts +840 -840
  120. package/mkdocs.yml +64 -64
  121. package/package.json +137 -137
  122. package/scripts/postbuild.js +47 -47
  123. package/skill/REFERENCE.md +539 -539
  124. package/skill/SKILL.md +295 -295
  125. package/tsconfig.json +26 -26
  126. package/types/index.d.ts +525 -525
@@ -1,244 +1,244 @@
1
- /**
2
- * Project information commands: word-count (wc), stats, search
3
- *
4
- * Read-only queries about the project state.
5
- */
6
-
7
- import type { Command } from 'commander';
8
- import {
9
- chalk,
10
- fs,
11
- path,
12
- fmt,
13
- findFiles,
14
- loadBuildConfig,
15
- countAnnotations,
16
- getComments,
17
- countWords,
18
- } from './context.js';
19
-
20
- // Use the actual BuildConfig from build.ts which allows string|Author[]
21
- type BuildConfig = ReturnType<typeof loadBuildConfig>;
22
-
23
- // Options interfaces
24
- interface WordCountOptions {
25
- limit?: number;
26
- journal?: string;
27
- }
28
-
29
- interface StatsOptions {
30
- // No options currently
31
- }
32
-
33
- interface SearchOptions {
34
- ignoreCase?: boolean;
35
- context?: number;
36
- }
37
-
38
- /**
39
- * Register project-info commands with the program
40
- */
41
- export function register(program: Command): void {
42
- // ==========================================================================
43
- // WORD-COUNT command - Per-section word counts
44
- // ==========================================================================
45
-
46
- program
47
- .command('word-count')
48
- .alias('wc')
49
- .description('Show word counts per section')
50
- .option('-l, --limit <number>', 'Warn if total exceeds limit', parseInt)
51
- .option('-j, --journal <name>', 'Use journal word limit')
52
- .action(async (options: WordCountOptions) => {
53
- let config: Partial<BuildConfig> = {};
54
- try {
55
- config = loadBuildConfig('.') || {};
56
- } catch {
57
- // Not in a rev project, that's ok
58
- }
59
- const sections = config.sections || [];
60
-
61
- if (sections.length === 0) {
62
- // Try to find .md files
63
- const mdFiles = fs.readdirSync('.').filter(f =>
64
- f.endsWith('.md') && !['README.md', 'CLAUDE.md', 'paper.md'].includes(f)
65
- );
66
- if (mdFiles.length === 0) {
67
- console.error(chalk.red('No section files found. Run from a rev project directory.'));
68
- process.exit(1);
69
- }
70
- sections.push(...mdFiles);
71
- }
72
-
73
- let total = 0;
74
- const rows: string[][] = [];
75
-
76
- for (const section of sections) {
77
- if (!fs.existsSync(section)) continue;
78
- const text = fs.readFileSync(section, 'utf-8');
79
- const words = countWords(text);
80
- total += words;
81
- rows.push([section, words.toLocaleString()]);
82
- }
83
-
84
- rows.push(['', '']);
85
- rows.push([chalk.bold('Total'), chalk.bold(total.toLocaleString())]);
86
-
87
- console.log(fmt.header('Word Count'));
88
- console.log(fmt.table(['Section', 'Words'], rows));
89
-
90
- // Check limit
91
- let limit = options.limit;
92
- if (options.journal) {
93
- const { getJournalProfile } = await import('../journals.js');
94
- const profile = getJournalProfile(options.journal);
95
- if (profile?.requirements?.wordLimit?.main) {
96
- limit = profile.requirements.wordLimit.main;
97
- console.log(chalk.dim(`\nUsing ${profile.name} word limit: ${limit.toLocaleString()}`));
98
- }
99
- }
100
-
101
- if (limit && total > limit) {
102
- console.log(chalk.red(`\n⚠ Over limit by ${(total - limit).toLocaleString()} words`));
103
- } else if (limit) {
104
- console.log(chalk.green(`\n✓ Within limit (${(limit - total).toLocaleString()} words remaining)`));
105
- }
106
- });
107
-
108
- // ==========================================================================
109
- // STATS command - Project dashboard
110
- // ==========================================================================
111
-
112
- program
113
- .command('stats')
114
- .description('Show project statistics dashboard')
115
- .action(async (_options: StatsOptions) => {
116
- let config: Partial<BuildConfig> = {};
117
- try {
118
- config = loadBuildConfig('.') || {};
119
- } catch {
120
- // Not in a rev project, that's ok
121
- }
122
- let sections = config.sections || [];
123
-
124
- if (sections.length === 0) {
125
- sections = fs.readdirSync('.').filter(f =>
126
- f.endsWith('.md') && !['README.md', 'CLAUDE.md', 'paper.md'].includes(f)
127
- );
128
- }
129
-
130
- let totalWords = 0;
131
- let totalFigures = 0;
132
- let totalTables = 0;
133
- let totalComments = 0;
134
- let pendingComments = 0;
135
- const citations = new Set<string>();
136
-
137
- for (const section of sections) {
138
- if (!fs.existsSync(section)) continue;
139
- const text = fs.readFileSync(section, 'utf-8');
140
-
141
- totalWords += countWords(text);
142
- totalFigures += (text.match(/!\[.*?\]\(.*?\)/g) || []).length;
143
- totalTables += (text.match(/^\|[^|]+\|/gm) || []).length / 5; // Approximate
144
-
145
- const comments = getComments(text);
146
- totalComments += comments.length;
147
- pendingComments += comments.filter(c => !c.resolved).length;
148
-
149
- const cites = text.match(/@(\w+)(?![:\w])/g) || [];
150
- cites.forEach(c => citations.add(c.slice(1)));
151
- }
152
-
153
- console.log(fmt.header('Project Statistics'));
154
- console.log();
155
-
156
- const stats: [string, string | number][] = [
157
- ['Sections', sections.length],
158
- ['Words', totalWords.toLocaleString()],
159
- ['Figures', Math.round(totalFigures)],
160
- ['Tables', Math.round(totalTables)],
161
- ['Citations', citations.size],
162
- ['Comments', `${totalComments} (${pendingComments} pending)`],
163
- ];
164
-
165
- for (const [label, value] of stats) {
166
- console.log(` ${chalk.dim(label.padEnd(12))} ${chalk.bold(value)}`);
167
- }
168
-
169
- // Bibliography stats
170
- const bibPath = config.bibliography || 'references.bib';
171
- if (fs.existsSync(bibPath)) {
172
- const bibContent = fs.readFileSync(bibPath, 'utf-8');
173
- const bibEntries = (bibContent.match(/@\w+\s*\{/g) || []).length;
174
- console.log(` ${chalk.dim('Bib entries'.padEnd(12))} ${chalk.bold(bibEntries)}`);
175
- }
176
-
177
- console.log();
178
- });
179
-
180
- // ==========================================================================
181
- // SEARCH command - Search across section files
182
- // ==========================================================================
183
-
184
- program
185
- .command('search')
186
- .description('Search across all section files')
187
- .argument('<query>', 'Search query (supports regex)')
188
- .option('-i, --ignore-case', 'Case-insensitive search')
189
- .option('-c, --context <lines>', 'Show context lines', parseInt, 1)
190
- .action((query: string, options: SearchOptions) => {
191
- let config: Partial<BuildConfig> = {};
192
- try {
193
- config = loadBuildConfig('.') || {};
194
- } catch {
195
- // Not in a rev project, that's ok
196
- }
197
- let sections = config.sections || [];
198
-
199
- if (sections.length === 0) {
200
- sections = fs.readdirSync('.').filter(f =>
201
- f.endsWith('.md') && !['README.md', 'CLAUDE.md'].includes(f)
202
- );
203
- }
204
-
205
- const flags = options.ignoreCase ? 'gi' : 'g';
206
- let pattern: RegExp;
207
- try {
208
- pattern = new RegExp(query, flags);
209
- } catch {
210
- pattern = new RegExp(query.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'), flags);
211
- }
212
-
213
- let totalMatches = 0;
214
-
215
- for (const section of sections) {
216
- if (!fs.existsSync(section)) continue;
217
- const text = fs.readFileSync(section, 'utf-8');
218
- const lines = text.split('\n');
219
-
220
- const matches: { line: number; text: string }[] = [];
221
- for (let i = 0; i < lines.length; i++) {
222
- if (pattern.test(lines[i])) {
223
- matches.push({ line: i + 1, text: lines[i] });
224
- pattern.lastIndex = 0;
225
- }
226
- }
227
-
228
- if (matches.length > 0) {
229
- console.log(chalk.cyan.bold(`\n${section}`));
230
- for (const match of matches) {
231
- const highlighted = match.text.replace(pattern, (m) => chalk.yellow.bold(m));
232
- console.log(` ${chalk.dim(match.line + ':')} ${highlighted}`);
233
- }
234
- totalMatches += matches.length;
235
- }
236
- }
237
-
238
- if (totalMatches === 0) {
239
- console.log(chalk.yellow(`No matches found for "${query}"`));
240
- } else {
241
- console.log(chalk.dim(`\n${totalMatches} match${totalMatches === 1 ? '' : 'es'} found`));
242
- }
243
- });
244
- }
1
+ /**
2
+ * Project information commands: word-count (wc), stats, search
3
+ *
4
+ * Read-only queries about the project state.
5
+ */
6
+
7
+ import type { Command } from 'commander';
8
+ import {
9
+ chalk,
10
+ fs,
11
+ path,
12
+ fmt,
13
+ findFiles,
14
+ loadBuildConfig,
15
+ countAnnotations,
16
+ getComments,
17
+ countWords,
18
+ } from './context.js';
19
+
20
+ // Use the actual BuildConfig from build.ts which allows string|Author[]
21
+ type BuildConfig = ReturnType<typeof loadBuildConfig>;
22
+
23
+ // Options interfaces
24
+ interface WordCountOptions {
25
+ limit?: number;
26
+ journal?: string;
27
+ }
28
+
29
+ interface StatsOptions {
30
+ // No options currently
31
+ }
32
+
33
+ interface SearchOptions {
34
+ ignoreCase?: boolean;
35
+ context?: number;
36
+ }
37
+
38
+ /**
39
+ * Register project-info commands with the program
40
+ */
41
+ export function register(program: Command): void {
42
+ // ==========================================================================
43
+ // WORD-COUNT command - Per-section word counts
44
+ // ==========================================================================
45
+
46
+ program
47
+ .command('word-count')
48
+ .alias('wc')
49
+ .description('Show word counts per section')
50
+ .option('-l, --limit <number>', 'Warn if total exceeds limit', parseInt)
51
+ .option('-j, --journal <name>', 'Use journal word limit')
52
+ .action(async (options: WordCountOptions) => {
53
+ let config: Partial<BuildConfig> = {};
54
+ try {
55
+ config = loadBuildConfig('.') || {};
56
+ } catch {
57
+ // Not in a rev project, that's ok
58
+ }
59
+ const sections = config.sections || [];
60
+
61
+ if (sections.length === 0) {
62
+ // Try to find .md files
63
+ const mdFiles = fs.readdirSync('.').filter(f =>
64
+ f.endsWith('.md') && !['README.md', 'CLAUDE.md', 'paper.md'].includes(f)
65
+ );
66
+ if (mdFiles.length === 0) {
67
+ console.error(chalk.red('No section files found. Run from a rev project directory.'));
68
+ process.exit(1);
69
+ }
70
+ sections.push(...mdFiles);
71
+ }
72
+
73
+ let total = 0;
74
+ const rows: string[][] = [];
75
+
76
+ for (const section of sections) {
77
+ if (!fs.existsSync(section)) continue;
78
+ const text = fs.readFileSync(section, 'utf-8');
79
+ const words = countWords(text);
80
+ total += words;
81
+ rows.push([section, words.toLocaleString()]);
82
+ }
83
+
84
+ rows.push(['', '']);
85
+ rows.push([chalk.bold('Total'), chalk.bold(total.toLocaleString())]);
86
+
87
+ console.log(fmt.header('Word Count'));
88
+ console.log(fmt.table(['Section', 'Words'], rows));
89
+
90
+ // Check limit
91
+ let limit = options.limit;
92
+ if (options.journal) {
93
+ const { getJournalProfile } = await import('../journals.js');
94
+ const profile = getJournalProfile(options.journal);
95
+ if (profile?.requirements?.wordLimit?.main) {
96
+ limit = profile.requirements.wordLimit.main;
97
+ console.log(chalk.dim(`\nUsing ${profile.name} word limit: ${limit.toLocaleString()}`));
98
+ }
99
+ }
100
+
101
+ if (limit && total > limit) {
102
+ console.log(chalk.red(`\n⚠ Over limit by ${(total - limit).toLocaleString()} words`));
103
+ } else if (limit) {
104
+ console.log(chalk.green(`\n✓ Within limit (${(limit - total).toLocaleString()} words remaining)`));
105
+ }
106
+ });
107
+
108
+ // ==========================================================================
109
+ // STATS command - Project dashboard
110
+ // ==========================================================================
111
+
112
+ program
113
+ .command('stats')
114
+ .description('Show project statistics dashboard')
115
+ .action(async (_options: StatsOptions) => {
116
+ let config: Partial<BuildConfig> = {};
117
+ try {
118
+ config = loadBuildConfig('.') || {};
119
+ } catch {
120
+ // Not in a rev project, that's ok
121
+ }
122
+ let sections = config.sections || [];
123
+
124
+ if (sections.length === 0) {
125
+ sections = fs.readdirSync('.').filter(f =>
126
+ f.endsWith('.md') && !['README.md', 'CLAUDE.md', 'paper.md'].includes(f)
127
+ );
128
+ }
129
+
130
+ let totalWords = 0;
131
+ let totalFigures = 0;
132
+ let totalTables = 0;
133
+ let totalComments = 0;
134
+ let pendingComments = 0;
135
+ const citations = new Set<string>();
136
+
137
+ for (const section of sections) {
138
+ if (!fs.existsSync(section)) continue;
139
+ const text = fs.readFileSync(section, 'utf-8');
140
+
141
+ totalWords += countWords(text);
142
+ totalFigures += (text.match(/!\[.*?\]\(.*?\)/g) || []).length;
143
+ totalTables += (text.match(/^\|[^|]+\|/gm) || []).length / 5; // Approximate
144
+
145
+ const comments = getComments(text);
146
+ totalComments += comments.length;
147
+ pendingComments += comments.filter(c => !c.resolved).length;
148
+
149
+ const cites = text.match(/@(\w+)(?![:\w])/g) || [];
150
+ cites.forEach(c => citations.add(c.slice(1)));
151
+ }
152
+
153
+ console.log(fmt.header('Project Statistics'));
154
+ console.log();
155
+
156
+ const stats: [string, string | number][] = [
157
+ ['Sections', sections.length],
158
+ ['Words', totalWords.toLocaleString()],
159
+ ['Figures', Math.round(totalFigures)],
160
+ ['Tables', Math.round(totalTables)],
161
+ ['Citations', citations.size],
162
+ ['Comments', `${totalComments} (${pendingComments} pending)`],
163
+ ];
164
+
165
+ for (const [label, value] of stats) {
166
+ console.log(` ${chalk.dim(label.padEnd(12))} ${chalk.bold(value)}`);
167
+ }
168
+
169
+ // Bibliography stats
170
+ const bibPath = config.bibliography || 'references.bib';
171
+ if (fs.existsSync(bibPath)) {
172
+ const bibContent = fs.readFileSync(bibPath, 'utf-8');
173
+ const bibEntries = (bibContent.match(/@\w+\s*\{/g) || []).length;
174
+ console.log(` ${chalk.dim('Bib entries'.padEnd(12))} ${chalk.bold(bibEntries)}`);
175
+ }
176
+
177
+ console.log();
178
+ });
179
+
180
+ // ==========================================================================
181
+ // SEARCH command - Search across section files
182
+ // ==========================================================================
183
+
184
+ program
185
+ .command('search')
186
+ .description('Search across all section files')
187
+ .argument('<query>', 'Search query (supports regex)')
188
+ .option('-i, --ignore-case', 'Case-insensitive search')
189
+ .option('-c, --context <lines>', 'Show context lines', parseInt, 1)
190
+ .action((query: string, options: SearchOptions) => {
191
+ let config: Partial<BuildConfig> = {};
192
+ try {
193
+ config = loadBuildConfig('.') || {};
194
+ } catch {
195
+ // Not in a rev project, that's ok
196
+ }
197
+ let sections = config.sections || [];
198
+
199
+ if (sections.length === 0) {
200
+ sections = fs.readdirSync('.').filter(f =>
201
+ f.endsWith('.md') && !['README.md', 'CLAUDE.md'].includes(f)
202
+ );
203
+ }
204
+
205
+ const flags = options.ignoreCase ? 'gi' : 'g';
206
+ let pattern: RegExp;
207
+ try {
208
+ pattern = new RegExp(query, flags);
209
+ } catch {
210
+ pattern = new RegExp(query.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'), flags);
211
+ }
212
+
213
+ let totalMatches = 0;
214
+
215
+ for (const section of sections) {
216
+ if (!fs.existsSync(section)) continue;
217
+ const text = fs.readFileSync(section, 'utf-8');
218
+ const lines = text.split('\n');
219
+
220
+ const matches: { line: number; text: string }[] = [];
221
+ for (let i = 0; i < lines.length; i++) {
222
+ if (pattern.test(lines[i])) {
223
+ matches.push({ line: i + 1, text: lines[i] });
224
+ pattern.lastIndex = 0;
225
+ }
226
+ }
227
+
228
+ if (matches.length > 0) {
229
+ console.log(chalk.cyan.bold(`\n${section}`));
230
+ for (const match of matches) {
231
+ const highlighted = match.text.replace(pattern, (m) => chalk.yellow.bold(m));
232
+ console.log(` ${chalk.dim(match.line + ':')} ${highlighted}`);
233
+ }
234
+ totalMatches += matches.length;
235
+ }
236
+ }
237
+
238
+ if (totalMatches === 0) {
239
+ console.log(chalk.yellow(`No matches found for "${query}"`));
240
+ } else {
241
+ console.log(chalk.dim(`\n${totalMatches} match${totalMatches === 1 ? '' : 'es'} found`));
242
+ }
243
+ });
244
+ }