docrev 0.8.1 → 0.8.5

package/dist/lib/config.d.ts

@@ -0,0 +1,41 @@
+/**
+ * User configuration management
+ * Stores user preferences in ~/.revrc
+ */
+import type { UserConfig } from './types.js';
+/**
+ * Load user config
+ * @returns User configuration object
+ */
+export declare function loadUserConfig(): UserConfig;
+/**
+ * Save user config
+ * @param config - User configuration to save
+ */
+export declare function saveUserConfig(config: UserConfig): void;
+/**
+ * Get user name
+ * @returns User name or null if not set
+ */
+export declare function getUserName(): string | null;
+/**
+ * Set user name
+ * @param name - User name to set
+ */
+export declare function setUserName(name: string): void;
+/**
+ * Get config file path
+ * @returns Absolute path to config file
+ */
+export declare function getConfigPath(): string;
+/**
+ * Get default sections for new projects
+ * @returns Array of section names or null if not set
+ */
+export declare function getDefaultSections(): string[] | null;
+/**
+ * Set default sections for new projects
+ * @param sections - Array of section names (without .md extension)
+ */
+export declare function setDefaultSections(sections: string[]): void;
+//# sourceMappingURL=config.d.ts.map

package/dist/lib/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../lib/config.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAO7C;;;GAGG;AACH,wBAAgB,cAAc,IAAI,UAAU,CAa3C;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,UAAU,GAAG,IAAI,CAEvD;AAED;;;GAGG;AACH,wBAAgB,WAAW,IAAI,MAAM,GAAG,IAAI,CAG3C;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAI9C;AAED;;;GAGG;AACH,wBAAgB,aAAa,IAAI,MAAM,CAEtC;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,IAAI,MAAM,EAAE,GAAG,IAAI,CAGpD;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,IAAI,CAI3D"}

package/dist/lib/config.js

@@ -0,0 +1,76 @@
+/**
+ * User configuration management
+ * Stores user preferences in ~/.revrc
+ */
+import * as fs from 'fs';
+import * as path from 'path';
+import * as os from 'os';
+const CONFIG_PATH = path.join(os.homedir(), '.revrc');
+/**
+ * Load user config
+ * @returns User configuration object
+ */
+export function loadUserConfig() {
+    try {
+        if (fs.existsSync(CONFIG_PATH)) {
+            const content = fs.readFileSync(CONFIG_PATH, 'utf-8');
+            return JSON.parse(content);
+        }
+    }
+    catch (e) {
+        if (process.env.DEBUG) {
+            const error = e;
+            console.warn('config: Failed to parse ~/.revrc:', error.message);
+        }
+    }
+    return {};
+}
+/**
+ * Save user config
+ * @param config - User configuration to save
+ */
+export function saveUserConfig(config) {
+    fs.writeFileSync(CONFIG_PATH, JSON.stringify(config, null, 2), 'utf-8');
+}
+/**
+ * Get user name
+ * @returns User name or null if not set
+ */
+export function getUserName() {
+    const config = loadUserConfig();
+    return config.userName || null;
+}
+/**
+ * Set user name
+ * @param name - User name to set
+ */
+export function setUserName(name) {
+    const config = loadUserConfig();
+    config.userName = name;
+    saveUserConfig(config);
+}
+/**
+ * Get config file path
+ * @returns Absolute path to config file
+ */
+export function getConfigPath() {
+    return CONFIG_PATH;
+}
+/**
+ * Get default sections for new projects
+ * @returns Array of section names or null if not set
+ */
+export function getDefaultSections() {
+    const config = loadUserConfig();
+    return config.defaultSections || null;
+}
+/**
+ * Set default sections for new projects
+ * @param sections - Array of section names (without .md extension)
+ */
+export function setDefaultSections(sections) {
+    const config = loadUserConfig();
+    config.defaultSections = sections;
+    saveUserConfig(config);
+}
+//# sourceMappingURL=config.js.map

package/dist/lib/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../lib/config.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AAEzB,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,EAAE,QAAQ,CAAC,CAAC;AAEtD;;;GAGG;AACH,MAAM,UAAU,cAAc;IAC5B,IAAI,CAAC;QACH,IAAI,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;YAC/B,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;YACtD,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAe,CAAC;QAC3C,CAAC;IACH,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,IAAI,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC;YACtB,MAAM,KAAK,GAAG,CAAU,CAAC;YACzB,OAAO,CAAC,IAAI,CAAC,mCAAmC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;QACnE,CAAC;IACH,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,cAAc,CAAC,MAAkB;IAC/C,EAAE,CAAC,aAAa,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;AAC1E,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,WAAW;IACzB,MAAM,MAAM,GAAG,cAAc,EAAE,CAAC;IAChC,OAAO,MAAM,CAAC,QAAQ,IAAI,IAAI,CAAC;AACjC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,WAAW,CAAC,IAAY;IACtC,MAAM,MAAM,GAAG,cAAc,EAAE,CAAC;IAChC,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IACvB,cAAc,CAAC,MAAM,CAAC,CAAC;AACzB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,aAAa;IAC3B,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,kBAAkB;IAChC,MAAM,MAAM,GAAG,cAAc,EAAE,CAAC;IAChC,OAAO,MAAM,CAAC,eAAe,IAAI,IAAI,CAAC;AACxC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAAC,QAAkB;IACnD,MAAM,MAAM,GAAG,cAAc,EAAE,CAAC;IAChC,MAAM,CAAC,eAAe,GAAG,QAAQ,CAAC;IAClC,cAAc,CAAC,MAAM,CAAC,CAAC;AACzB,CAAC"}

package/dist/lib/crossref.d.ts

@@ -0,0 +1,108 @@
+/**
+ * Cross-reference handling - dynamic figure/table references
+ *
+ * Enables:
+ * - @fig:label syntax in source (auto-numbered)
+ * - Conversion to "Figure 1" in Word output
+ * - Auto-conversion back during import
+ */
+import type { DynamicRef, Registry, RefStatus, ConversionResult } from './types.js';
+/**
+ * Parsed reference number components
+ */
+interface ParsedRefNumber {
+    isSupp: boolean;
+    num: number;
+    suffix: string | null;
+}
+/**
+ * Detected reference with parsed numbers
+ */
+interface DetectedRef {
+    type: 'fig' | 'tbl' | 'eq';
+    match: string;
+    numbers: ParsedRefNumber[];
+    position: number;
+}
+/**
+ * Normalize a reference type to standard form
+ */
+export declare function normalizeType(typeStr: string): 'fig' | 'tbl' | 'eq' | string;
+/**
+ * Parse a reference number, handling supplementary (S1, S2) and letter suffixes (1a, 1b)
+ */
+export declare function parseRefNumber(numStr: string, suffix?: string | null): ParsedRefNumber;
+/**
+ * Parse a reference list string like "1, 2, and 3" or "1a-c" or "1a-3b"
+ * Returns an array of {num, isSupp, suffix} objects
+ */
+export declare function parseReferenceList(listStr: string): ParsedRefNumber[];
+/**
+ * Build a registry of figure/table labels from .md files
+ * Scans for {#fig:label} and {#tbl:label} anchors
+ *
+ * IMPORTANT: This function requires either explicit sections or a rev.yaml/sections.yaml config.
+ * It will NOT guess by scanning all .md files, as this leads to incorrect numbering
+ * when temporary files (paper_clean.md, etc.) exist in the directory.
+ */
+export declare function buildRegistry(directory: string, sections?: string[]): Registry;
+/**
+ * Get the display string for a label (e.g., "Figure 1", "Table S2")
+ */
+export declare function labelToDisplay(type: 'fig' | 'tbl' | 'eq', label: string, registry: Registry): string | null;
+/**
+ * Get the label for a display number (e.g., "fig:heatmap" from Figure 1)
+ */
+export declare function numberToLabel(type: 'fig' | 'tbl' | 'eq', num: number, isSupp: boolean, registry: Registry): string | null;
+/**
+ * Detect all hardcoded references in text
+ */
+export declare function detectHardcodedRefs(text: string): DetectedRef[];
+/**
+ * Convert hardcoded references to @-style references
+ */
+export declare function convertHardcodedRefs(text: string, registry: Registry): ConversionResult;
+/**
+ * Detect @-style references in text
+ */
+export declare function detectDynamicRefs(text: string): DynamicRef[];
+/**
+ * Get reference status for a file/text
+ */
+export declare function getRefStatus(text: string, registry: Registry): RefStatus;
+/**
+ * Detect forward references in combined text
+ * A forward reference is a @ref that appears before its {#anchor} definition
+ */
+export declare function detectForwardRefs(text: string): {
+    forwardRefs: Array<{
+        type: string;
+        label: string;
+        match: string;
+        position: number;
+    }>;
+    anchorPositions: Map<string, number>;
+};
+/**
+ * Resolve forward references to display format
+ * Only resolves refs that appear before their anchor definition
+ * Leaves other refs for pandoc-crossref to handle (preserves clickable links)
+ */
+export declare function resolveForwardRefs(text: string, registry: Registry): {
+    text: string;
+    resolved: Array<{
+        from: string;
+        to: string;
+        position: number;
+    }>;
+    unresolved: Array<{
+        ref: string;
+        position: number;
+    }>;
+};
+/**
+ * Format registry for display
+ */
+export declare function formatRegistry(registry: Registry): string;
+export {};
+//# sourceMappingURL=crossref.d.ts.map

package/dist/lib/crossref.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"crossref.d.ts","sourceRoot":"","sources":["../../lib/crossref.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAKH,OAAO,KAAK,EAGV,UAAU,EAEV,QAAQ,EACR,SAAS,EACT,gBAAgB,EACjB,MAAM,YAAY,CAAC;AA0BpB;;GAEG;AACH,UAAU,eAAe;IACvB,MAAM,EAAE,OAAO,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,UAAU,WAAW;IACnB,IAAI,EAAE,KAAK,GAAG,KAAK,GAAG,IAAI,CAAC;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,eAAe,EAAE,CAAC;IAC3B,QAAQ,EAAE,MAAM,CAAC;CAClB;AA2GD;;GAEG;AACH,wBAAgB,aAAa,CAAC,OAAO,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,IAAI,GAAG,MAAM,CAS5E;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,GAAE,MAAM,GAAG,IAAW,GAAG,eAAe,CAW5F;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,eAAe,EAAE,CA4GrE;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,GAAG,QAAQ,CA8F9E;AAED;;GAEG;AACH,wBAAgB,cAAc,CAC5B,IAAI,EAAE,KAAK,GAAG,KAAK,GAAG,IAAI,EAC1B,KAAK,EAAE,MAAM,EACb,QAAQ,EAAE,QAAQ,GACjB,MAAM,GAAG,IAAI,CAaf;AAED;;GAEG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,KAAK,GAAG,KAAK,GAAG,IAAI,EAC1B,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,OAAO,EACf,QAAQ,EAAE,QAAQ,GACjB,MAAM,GAAG,IAAI,CAKf;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,EAAE,CAmC/D;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,gBAAgB,CAgDvF;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,EAAE,CAsB5D;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAuBxE;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG;IAC/C,WAAW,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACrF,eAAe,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtC,CA4BA;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,QAAQ,GACjB;IACD,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAChE,UAAU,EAAE,KAAK,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACtD,CA6BA;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,QAAQ,GAAG,MAAM,CAiCzD"}