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,99 +1,99 @@
1
- /**
2
- * Realign comments from a reference DOCX onto markdown.
3
- *
4
- * This is the same job as `rev sync`: read the comments and their anchors from
5
- * a docx, then place them into the current markdown. It therefore reuses the
6
- * one extraction + placement engine rather than carrying a second docx parser
7
- * and a proportional position-mapper.
8
- */
9
-
10
- import * as fs from 'fs';
11
- import { extractWordComments, extractCommentAnchors } from './word-extraction.js';
12
- import { insertCommentsIntoMarkdown } from './import.js';
13
-
14
- interface RealignOptions {
15
- dryRun?: boolean;
16
- /** When set, realign only comments by these authors; otherwise all. */
17
- author?: string;
18
- replyAuthor?: string;
19
- }
20
-
21
- interface RealignResult {
22
- success: boolean;
23
- dryRun?: boolean;
24
- insertions: number;
25
- error?: string;
26
- }
27
-
28
- interface RealignMarkdownOptions {
29
- author?: string;
30
- replyAuthor?: string;
31
- }
32
-
33
- interface RealignMarkdownResult {
34
- success: boolean;
35
- markdown: string;
36
- insertions: number;
37
- error?: string;
38
- }
39
-
40
- /** Existing CriticMarkup comments, removed before the reference set is placed. */
41
- function stripExistingComments(markdown: string): string {
42
- return markdown.replace(/\s*\{>>[\s\S]+?<<\}/g, '');
43
- }
44
-
45
- /**
46
- * Realign the reference docx's comments onto an in-memory markdown string.
47
- * Existing comments are cleared first so re-running is idempotent.
48
- */
49
- export async function realignMarkdown(
50
- docxPath: string,
51
- markdown: string,
52
- options: RealignMarkdownOptions = {},
53
- ): Promise<RealignMarkdownResult> {
54
- try {
55
- let comments = await extractWordComments(docxPath);
56
- const { anchors } = await extractCommentAnchors(docxPath);
57
-
58
- if (options.author) {
59
- const keep = new Set([options.author, options.replyAuthor].filter(Boolean) as string[]);
60
- comments = comments.filter((c) => keep.has(c.author));
61
- }
62
-
63
- const stripped = stripExistingComments(markdown);
64
- const stats = { placed: 0, lowConfidence: 0, deduped: 0, unmatched: 0 };
65
- const result = insertCommentsIntoMarkdown(stripped, comments, anchors, {
66
- quiet: true,
67
- wrapAnchor: false,
68
- outStats: stats,
69
- });
70
-
71
- return { success: true, markdown: result, insertions: stats.placed + stats.lowConfidence };
72
- } catch (err: any) {
73
- return { success: false, markdown, insertions: 0, error: err.message };
74
- }
75
- }
76
-
77
- /**
78
- * Realign the reference docx's comments onto a markdown file in place.
79
- */
80
- export async function realignComments(
81
- docxPath: string,
82
- markdownPath: string,
83
- options: RealignOptions = {},
84
- ): Promise<RealignResult> {
85
- const { dryRun = false, author, replyAuthor } = options;
86
-
87
- const original = fs.readFileSync(markdownPath, 'utf-8');
88
- const realigned = await realignMarkdown(docxPath, original, { author, replyAuthor });
89
- if (!realigned.success) {
90
- return { success: false, insertions: 0, error: realigned.error };
91
- }
92
-
93
- if (dryRun) {
94
- return { success: true, dryRun: true, insertions: realigned.insertions };
95
- }
96
-
97
- fs.writeFileSync(markdownPath, realigned.markdown);
98
- return { success: true, insertions: realigned.insertions };
99
- }
1
+ /**
2
+ * Realign comments from a reference DOCX onto markdown.
3
+ *
4
+ * This is the same job as `rev sync`: read the comments and their anchors from
5
+ * a docx, then place them into the current markdown. It therefore reuses the
6
+ * one extraction + placement engine rather than carrying a second docx parser
7
+ * and a proportional position-mapper.
8
+ */
9
+
10
+ import * as fs from 'fs';
11
+ import { extractWordComments, extractCommentAnchors } from './word-extraction.js';
12
+ import { insertCommentsIntoMarkdown } from './import.js';
13
+
14
+ interface RealignOptions {
15
+ dryRun?: boolean;
16
+ /** When set, realign only comments by these authors; otherwise all. */
17
+ author?: string;
18
+ replyAuthor?: string;
19
+ }
20
+
21
+ interface RealignResult {
22
+ success: boolean;
23
+ dryRun?: boolean;
24
+ insertions: number;
25
+ error?: string;
26
+ }
27
+
28
+ interface RealignMarkdownOptions {
29
+ author?: string;
30
+ replyAuthor?: string;
31
+ }
32
+
33
+ interface RealignMarkdownResult {
34
+ success: boolean;
35
+ markdown: string;
36
+ insertions: number;
37
+ error?: string;
38
+ }
39
+
40
+ /** Existing CriticMarkup comments, removed before the reference set is placed. */
41
+ function stripExistingComments(markdown: string): string {
42
+ return markdown.replace(/\s*\{>>[\s\S]+?<<\}/g, '');
43
+ }
44
+
45
+ /**
46
+ * Realign the reference docx's comments onto an in-memory markdown string.
47
+ * Existing comments are cleared first so re-running is idempotent.
48
+ */
49
+ export async function realignMarkdown(
50
+ docxPath: string,
51
+ markdown: string,
52
+ options: RealignMarkdownOptions = {},
53
+ ): Promise<RealignMarkdownResult> {
54
+ try {
55
+ let comments = await extractWordComments(docxPath);
56
+ const { anchors } = await extractCommentAnchors(docxPath);
57
+
58
+ if (options.author) {
59
+ const keep = new Set([options.author, options.replyAuthor].filter(Boolean) as string[]);
60
+ comments = comments.filter((c) => keep.has(c.author));
61
+ }
62
+
63
+ const stripped = stripExistingComments(markdown);
64
+ const stats = { placed: 0, lowConfidence: 0, deduped: 0, unmatched: 0 };
65
+ const result = insertCommentsIntoMarkdown(stripped, comments, anchors, {
66
+ quiet: true,
67
+ wrapAnchor: false,
68
+ outStats: stats,
69
+ });
70
+
71
+ return { success: true, markdown: result, insertions: stats.placed + stats.lowConfidence };
72
+ } catch (err: any) {
73
+ return { success: false, markdown, insertions: 0, error: err.message };
74
+ }
75
+ }
76
+
77
+ /**
78
+ * Realign the reference docx's comments onto a markdown file in place.
79
+ */
80
+ export async function realignComments(
81
+ docxPath: string,
82
+ markdownPath: string,
83
+ options: RealignOptions = {},
84
+ ): Promise<RealignResult> {
85
+ const { dryRun = false, author, replyAuthor } = options;
86
+
87
+ const original = fs.readFileSync(markdownPath, 'utf-8');
88
+ const realigned = await realignMarkdown(docxPath, original, { author, replyAuthor });
89
+ if (!realigned.success) {
90
+ return { success: false, insertions: 0, error: realigned.error };
91
+ }
92
+
93
+ if (dryRun) {
94
+ return { success: true, dryRun: true, insertions: realigned.insertions };
95
+ }
96
+
97
+ fs.writeFileSync(markdownPath, realigned.markdown);
98
+ return { success: true, insertions: realigned.insertions };
99
+ }
package/lib/config.ts CHANGED
@@ -1,84 +1,84 @@
1
- /**
2
- * User configuration management
3
- * Stores user preferences in ~/.revrc
4
- */
5
-
6
- import type { UserConfig } from './types.js';
7
- import * as fs from 'fs';
8
- import * as path from 'path';
9
- import * as os from 'os';
10
-
11
- const CONFIG_PATH = path.join(os.homedir(), '.revrc');
12
-
13
- /**
14
- * Load user config
15
- * @returns User configuration object
16
- */
17
- export function loadUserConfig(): UserConfig {
18
- try {
19
- if (fs.existsSync(CONFIG_PATH)) {
20
- const content = fs.readFileSync(CONFIG_PATH, 'utf-8');
21
- return JSON.parse(content) as UserConfig;
22
- }
23
- } catch (e) {
24
- if (process.env.DEBUG) {
25
- const error = e as Error;
26
- console.warn('config: Failed to parse ~/.revrc:', error.message);
27
- }
28
- }
29
- return {};
30
- }
31
-
32
- /**
33
- * Save user config
34
- * @param config - User configuration to save
35
- */
36
- export function saveUserConfig(config: UserConfig): void {
37
- fs.writeFileSync(CONFIG_PATH, JSON.stringify(config, null, 2), 'utf-8');
38
- }
39
-
40
- /**
41
- * Get user name
42
- * @returns User name or null if not set
43
- */
44
- export function getUserName(): string | null {
45
- const config = loadUserConfig();
46
- return config.userName || null;
47
- }
48
-
49
- /**
50
- * Set user name
51
- * @param name - User name to set
52
- */
53
- export function setUserName(name: string): void {
54
- const config = loadUserConfig();
55
- config.userName = name;
56
- saveUserConfig(config);
57
- }
58
-
59
- /**
60
- * Get config file path
61
- * @returns Absolute path to config file
62
- */
63
- export function getConfigPath(): string {
64
- return CONFIG_PATH;
65
- }
66
-
67
- /**
68
- * Get default sections for new projects
69
- * @returns Array of section names or null if not set
70
- */
71
- export function getDefaultSections(): string[] | null {
72
- const config = loadUserConfig();
73
- return config.defaultSections || null;
74
- }
75
-
76
- /**
77
- * Set default sections for new projects
78
- * @param sections - Array of section names (without .md extension)
79
- */
80
- export function setDefaultSections(sections: string[]): void {
81
- const config = loadUserConfig();
82
- config.defaultSections = sections;
83
- saveUserConfig(config);
84
- }
1
+ /**
2
+ * User configuration management
3
+ * Stores user preferences in ~/.revrc
4
+ */
5
+
6
+ import type { UserConfig } from './types.js';
7
+ import * as fs from 'fs';
8
+ import * as path from 'path';
9
+ import * as os from 'os';
10
+
11
+ const CONFIG_PATH = path.join(os.homedir(), '.revrc');
12
+
13
+ /**
14
+ * Load user config
15
+ * @returns User configuration object
16
+ */
17
+ export function loadUserConfig(): UserConfig {
18
+ try {
19
+ if (fs.existsSync(CONFIG_PATH)) {
20
+ const content = fs.readFileSync(CONFIG_PATH, 'utf-8');
21
+ return JSON.parse(content) as UserConfig;
22
+ }
23
+ } catch (e) {
24
+ if (process.env.DEBUG) {
25
+ const error = e as Error;
26
+ console.warn('config: Failed to parse ~/.revrc:', error.message);
27
+ }
28
+ }
29
+ return {};
30
+ }
31
+
32
+ /**
33
+ * Save user config
34
+ * @param config - User configuration to save
35
+ */
36
+ export function saveUserConfig(config: UserConfig): void {
37
+ fs.writeFileSync(CONFIG_PATH, JSON.stringify(config, null, 2), 'utf-8');
38
+ }
39
+
40
+ /**
41
+ * Get user name
42
+ * @returns User name or null if not set
43
+ */
44
+ export function getUserName(): string | null {
45
+ const config = loadUserConfig();
46
+ return config.userName || null;
47
+ }
48
+
49
+ /**
50
+ * Set user name
51
+ * @param name - User name to set
52
+ */
53
+ export function setUserName(name: string): void {
54
+ const config = loadUserConfig();
55
+ config.userName = name;
56
+ saveUserConfig(config);
57
+ }
58
+
59
+ /**
60
+ * Get config file path
61
+ * @returns Absolute path to config file
62
+ */
63
+ export function getConfigPath(): string {
64
+ return CONFIG_PATH;
65
+ }
66
+
67
+ /**
68
+ * Get default sections for new projects
69
+ * @returns Array of section names or null if not set
70
+ */
71
+ export function getDefaultSections(): string[] | null {
72
+ const config = loadUserConfig();
73
+ return config.defaultSections || null;
74
+ }
75
+
76
+ /**
77
+ * Set default sections for new projects
78
+ * @param sections - Array of section names (without .md extension)
79
+ */
80
+ export function setDefaultSections(sections: string[]): void {
81
+ const config = loadUserConfig();
82
+ config.defaultSections = sections;
83
+ saveUserConfig(config);
84
+ }