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