docrev 0.11.3 → 0.12.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 (193) hide show
  1. package/CHANGELOG.md +22 -0
  2. package/LICENSE +21 -0
  3. package/dist/bin/rev.js +29 -21
  4. package/dist/bin/rev.js.map +1 -1
  5. package/dist/lib/build.d.ts +43 -0
  6. package/dist/lib/build.d.ts.map +1 -1
  7. package/dist/lib/build.js +175 -5
  8. package/dist/lib/build.js.map +1 -1
  9. package/dist/lib/commands/build.d.ts.map +1 -1
  10. package/dist/lib/commands/build.js +39 -125
  11. package/dist/lib/commands/build.js.map +1 -1
  12. package/dist/lib/commands/comments.js +3 -3
  13. package/dist/lib/commands/comments.js.map +1 -1
  14. package/dist/lib/commands/context.d.ts +12 -1
  15. package/dist/lib/commands/context.d.ts.map +1 -1
  16. package/dist/lib/commands/context.js +34 -1
  17. package/dist/lib/commands/context.js.map +1 -1
  18. package/dist/lib/commands/merge-resolve.js +1 -1
  19. package/dist/lib/commands/merge-resolve.js.map +1 -1
  20. package/dist/lib/commands/quality.js +2 -2
  21. package/dist/lib/commands/quality.js.map +1 -1
  22. package/dist/lib/commands/sections.js +1 -1
  23. package/dist/lib/commands/sections.js.map +1 -1
  24. package/dist/lib/commands/text-ops.js +1 -1
  25. package/dist/lib/commands/text-ops.js.map +1 -1
  26. package/dist/lib/commands/utilities.d.ts.map +1 -1
  27. package/dist/lib/commands/utilities.js +5 -2
  28. package/dist/lib/commands/utilities.js.map +1 -1
  29. package/dist/lib/commands/word-tools.js +2 -2
  30. package/dist/lib/commands/word-tools.js.map +1 -1
  31. package/dist/lib/crossref.d.ts.map +1 -1
  32. package/dist/lib/crossref.js +12 -41
  33. package/dist/lib/crossref.js.map +1 -1
  34. package/dist/lib/csl.d.ts.map +1 -1
  35. package/dist/lib/csl.js +14 -22
  36. package/dist/lib/csl.js.map +1 -1
  37. package/dist/lib/diff-engine.js +1 -1
  38. package/dist/lib/diff-engine.js.map +1 -1
  39. package/dist/lib/equations.d.ts.map +1 -1
  40. package/dist/lib/equations.js +12 -3
  41. package/dist/lib/equations.js.map +1 -1
  42. package/dist/lib/errors.d.ts.map +1 -1
  43. package/dist/lib/errors.js +1 -30
  44. package/dist/lib/errors.js.map +1 -1
  45. package/dist/lib/image-registry.d.ts.map +1 -1
  46. package/dist/lib/image-registry.js +4 -0
  47. package/dist/lib/image-registry.js.map +1 -1
  48. package/dist/lib/import.d.ts +1 -1
  49. package/dist/lib/import.d.ts.map +1 -1
  50. package/dist/lib/import.js +1 -1
  51. package/dist/lib/import.js.map +1 -1
  52. package/dist/lib/input.d.ts +0 -11
  53. package/dist/lib/input.d.ts.map +1 -1
  54. package/dist/lib/input.js +0 -35
  55. package/dist/lib/input.js.map +1 -1
  56. package/dist/lib/merge.d.ts.map +1 -1
  57. package/dist/lib/merge.js +9 -1
  58. package/dist/lib/merge.js.map +1 -1
  59. package/dist/lib/ooxml.d.ts +22 -0
  60. package/dist/lib/ooxml.d.ts.map +1 -1
  61. package/dist/lib/ooxml.js +130 -0
  62. package/dist/lib/ooxml.js.map +1 -1
  63. package/dist/lib/orcid.d.ts.map +1 -1
  64. package/dist/lib/orcid.js +16 -7
  65. package/dist/lib/orcid.js.map +1 -1
  66. package/dist/lib/plugins.d.ts.map +1 -1
  67. package/dist/lib/plugins.js +8 -4
  68. package/dist/lib/plugins.js.map +1 -1
  69. package/dist/lib/protect-restore.d.ts.map +1 -1
  70. package/dist/lib/protect-restore.js +7 -5
  71. package/dist/lib/protect-restore.js.map +1 -1
  72. package/dist/lib/restore-references.d.ts.map +1 -1
  73. package/dist/lib/restore-references.js +25 -3
  74. package/dist/lib/restore-references.js.map +1 -1
  75. package/dist/lib/schema.d.ts.map +1 -1
  76. package/dist/lib/schema.js +1 -19
  77. package/dist/lib/schema.js.map +1 -1
  78. package/dist/lib/slides.js +1 -1
  79. package/dist/lib/slides.js.map +1 -1
  80. package/dist/lib/spelling.js +1 -1
  81. package/dist/lib/spelling.js.map +1 -1
  82. package/dist/lib/tui.js +0 -1
  83. package/dist/lib/tui.js.map +1 -1
  84. package/dist/lib/utils.d.ts +14 -0
  85. package/dist/lib/utils.d.ts.map +1 -1
  86. package/dist/lib/utils.js +41 -0
  87. package/dist/lib/utils.js.map +1 -1
  88. package/dist/lib/word-extraction.d.ts +5 -5
  89. package/dist/lib/word-extraction.d.ts.map +1 -1
  90. package/dist/lib/word-extraction.js +25 -106
  91. package/dist/lib/word-extraction.js.map +1 -1
  92. package/dist/lib/word.d.ts +14 -38
  93. package/dist/lib/word.d.ts.map +1 -1
  94. package/dist/lib/word.js +24 -179
  95. package/dist/lib/word.js.map +1 -1
  96. package/dist/lib/wordcomments.d.ts.map +1 -1
  97. package/dist/lib/wordcomments.js +9 -7
  98. package/dist/lib/wordcomments.js.map +1 -1
  99. package/package.json +17 -6
  100. package/.gitattributes +0 -1
  101. package/PLAN-tables-and-postprocess.md +0 -850
  102. package/bin/rev.ts +0 -145
  103. package/docs-src/build.py +0 -113
  104. package/docs-src/extra.css +0 -208
  105. package/docs-src/md-to-html.lua +0 -6
  106. package/docs-src/template.html +0 -116
  107. package/eslint.config.js +0 -27
  108. package/lib/anchor-match.ts +0 -307
  109. package/lib/annotations.ts +0 -695
  110. package/lib/build.ts +0 -2047
  111. package/lib/citations.ts +0 -160
  112. package/lib/commands/build.ts +0 -885
  113. package/lib/commands/citations.ts +0 -515
  114. package/lib/commands/comments.ts +0 -1077
  115. package/lib/commands/context.ts +0 -185
  116. package/lib/commands/core.ts +0 -328
  117. package/lib/commands/doi.ts +0 -451
  118. package/lib/commands/file-ops.ts +0 -372
  119. package/lib/commands/history.ts +0 -320
  120. package/lib/commands/index.ts +0 -87
  121. package/lib/commands/init.ts +0 -259
  122. package/lib/commands/merge-resolve.ts +0 -378
  123. package/lib/commands/preview.ts +0 -178
  124. package/lib/commands/project-info.ts +0 -244
  125. package/lib/commands/quality.ts +0 -517
  126. package/lib/commands/response.ts +0 -454
  127. package/lib/commands/section-boundaries.ts +0 -82
  128. package/lib/commands/sections.ts +0 -451
  129. package/lib/commands/sync.ts +0 -689
  130. package/lib/commands/text-ops.ts +0 -449
  131. package/lib/commands/utilities.ts +0 -448
  132. package/lib/commands/verify-anchors.ts +0 -272
  133. package/lib/commands/word-tools.ts +0 -340
  134. package/lib/comment-realign.ts +0 -99
  135. package/lib/config.ts +0 -84
  136. package/lib/crossref.ts +0 -781
  137. package/lib/csl.ts +0 -191
  138. package/lib/dependencies.ts +0 -132
  139. package/lib/diff-engine.ts +0 -465
  140. package/lib/doi-cache.ts +0 -115
  141. package/lib/doi.ts +0 -879
  142. package/lib/equations.ts +0 -506
  143. package/lib/errors.ts +0 -350
  144. package/lib/format.ts +0 -541
  145. package/lib/git.ts +0 -326
  146. package/lib/grammar.ts +0 -303
  147. package/lib/image-registry.ts +0 -180
  148. package/lib/import.ts +0 -932
  149. package/lib/input.ts +0 -174
  150. package/lib/journals.ts +0 -543
  151. package/lib/macro-filter.lua +0 -201
  152. package/lib/macros.ts +0 -273
  153. package/lib/merge.ts +0 -633
  154. package/lib/ooxml.ts +0 -768
  155. package/lib/orcid.ts +0 -144
  156. package/lib/pdf-comments.ts +0 -263
  157. package/lib/pdf-import.ts +0 -524
  158. package/lib/plugins.ts +0 -362
  159. package/lib/postprocess.ts +0 -188
  160. package/lib/pptx-color-filter.lua +0 -37
  161. package/lib/pptx-template.ts +0 -469
  162. package/lib/pptx-themes/academic.pptx +0 -0
  163. package/lib/pptx-themes/corporate.pptx +0 -0
  164. package/lib/pptx-themes/dark.pptx +0 -0
  165. package/lib/pptx-themes/default.pptx +0 -0
  166. package/lib/pptx-themes/minimal.pptx +0 -0
  167. package/lib/pptx-themes/plant.pptx +0 -0
  168. package/lib/pptx-themes.ts +0 -483
  169. package/lib/protect-restore.ts +0 -520
  170. package/lib/rate-limiter.ts +0 -127
  171. package/lib/response.ts +0 -200
  172. package/lib/restore-references.ts +0 -240
  173. package/lib/review.ts +0 -327
  174. package/lib/schema.ts +0 -494
  175. package/lib/scientific-words.ts +0 -73
  176. package/lib/sections.ts +0 -428
  177. package/lib/slides.ts +0 -756
  178. package/lib/spelling.ts +0 -334
  179. package/lib/templates.ts +0 -526
  180. package/lib/themes.ts +0 -742
  181. package/lib/trackchanges.ts +0 -166
  182. package/lib/tui.ts +0 -450
  183. package/lib/types.ts +0 -546
  184. package/lib/undo.ts +0 -250
  185. package/lib/utils.ts +0 -69
  186. package/lib/variables.ts +0 -179
  187. package/lib/word-extraction.ts +0 -525
  188. package/lib/word.ts +0 -526
  189. package/lib/wordcomments.ts +0 -789
  190. package/mkdocs.yml +0 -64
  191. package/scripts/postbuild.js +0 -47
  192. package/tsconfig.json +0 -26
  193. package/types/index.d.ts +0 -531
@@ -1,244 +0,0 @@
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
- }