docrev 0.8.1 → 0.8.5

package/lib/dependencies.ts

@@ -0,0 +1,106 @@
+/**
+ * Dependency checking utilities for pandoc, LaTeX, and related tools
+ */
+
+import { execSync } from 'child_process';
+
+/**
+ * Check if pandoc-crossref is available
+ */
+export function hasPandocCrossref(): boolean {
+  try {
+    execSync('pandoc-crossref --version', { stdio: 'ignore' });
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+/**
+ * Check if pandoc is available
+ */
+export function hasPandoc(): boolean {
+  try {
+    execSync('pandoc --version', { stdio: 'ignore' });
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+/**
+ * Check if LaTeX is available (for PDF generation)
+ */
+export function hasLatex(): boolean {
+  try {
+    execSync('pdflatex --version', { stdio: 'ignore' });
+    return true;
+  } catch {
+    try {
+      execSync('xelatex --version', { stdio: 'ignore' });
+      return true;
+    } catch {
+      return false;
+    }
+  }
+}
+
+/**
+ * Get installation instructions for missing dependencies
+ */
+export function getInstallInstructions(dependency: string): string {
+  const platform = process.platform;
+  const instructions: Record<string, Record<string, string>> = {
+    pandoc: {
+      darwin: 'brew install pandoc',
+      win32: 'winget install JohnMacFarlane.Pandoc',
+      linux: 'sudo apt install pandoc',
+    },
+    latex: {
+      darwin: 'brew install --cask mactex-no-gui',
+      win32: 'Install MiKTeX from https://miktex.org/download',
+      linux: 'sudo apt install texlive-latex-base texlive-fonts-recommended',
+    },
+    'pandoc-crossref': {
+      darwin: 'brew install pandoc-crossref',
+      win32: 'Download from https://github.com/lierdakil/pandoc-crossref/releases',
+      linux: 'Download from https://github.com/lierdakil/pandoc-crossref/releases',
+    },
+  };
+
+  const platformInstructions = instructions[dependency];
+  if (!platformInstructions) return '';
+
+  return platformInstructions[platform] || platformInstructions.linux || '';
+}
+
+export interface DependencyStatus {
+  pandoc: boolean;
+  latex: boolean;
+  crossref: boolean;
+  messages: string[];
+}
+
+/**
+ * Check dependencies and return status
+ */
+export function checkDependencies(): DependencyStatus {
+  const status: DependencyStatus = {
+    pandoc: hasPandoc(),
+    latex: hasLatex(),
+    crossref: hasPandocCrossref(),
+    messages: [],
+  };
+
+  if (!status.pandoc) {
+    status.messages.push(`Pandoc not found. Install with: ${getInstallInstructions('pandoc')}`);
+  }
+  if (!status.latex) {
+    status.messages.push(`LaTeX not found (required for PDF). Install with: ${getInstallInstructions('latex')}`);
+  }
+  if (!status.crossref) {
+    status.messages.push(`pandoc-crossref not found (optional, for figure/table refs). Install with: ${getInstallInstructions('pandoc-crossref')}`);
+  }
+
+  return status;
+}

package/lib/doi-cache.ts

@@ -0,0 +1,115 @@
+/**
+ * DOI Cache - Reduces API calls for repeated lookups
+ */
+
+import * as fs from 'fs';
+import * as path from 'path';
+import * as os from 'os';
+import type { DoiCache, DoiCacheEntry, DoiCacheStats, DoiCheckResult, DoiLookupResult } from './types.js';
+
+const CACHE_FILE = path.join(os.homedir(), '.rev-doi-cache.json');
+const CACHE_TTL = 7 * 24 * 60 * 60 * 1000; // 7 days in ms
+
+let doiCache: DoiCache | null = null;
+
+/**
+ * Load DOI cache from disk
+ */
+export function loadCache(): DoiCache {
+  if (doiCache !== null) return doiCache;
+
+  try {
+    if (fs.existsSync(CACHE_FILE)) {
+      const data = JSON.parse(fs.readFileSync(CACHE_FILE, 'utf-8')) as DoiCache;
+      doiCache = data;
+      return doiCache;
+    }
+  } catch (e) {
+    if (process.env.DEBUG) {
+      console.warn('doi-cache: Failed to load cache:', (e as Error).message);
+    }
+  }
+
+  doiCache = { entries: {}, version: 1 };
+  return doiCache;
+}
+
+/**
+ * Save DOI cache to disk
+ */
+export function saveCache(): void {
+  if (!doiCache) return;
+
+  try {
+    fs.writeFileSync(CACHE_FILE, JSON.stringify(doiCache, null, 2), 'utf-8');
+  } catch (e) {
+    if (process.env.DEBUG) {
+      console.warn('doi-cache: Failed to save cache:', (e as Error).message);
+    }
+  }
+}
+
+/**
+ * Get cached DOI result
+ */
+export function getCachedDoi(doi: string): DoiCheckResult | DoiLookupResult | null {
+  const cache = loadCache();
+  const entry = cache.entries[doi];
+
+  if (!entry) return null;
+
+  // Check if cache entry is expired
+  if (Date.now() - entry.timestamp > CACHE_TTL) {
+    delete cache.entries[doi];
+    return null;
+  }
+
+  return entry.result;
+}
+
+/**
+ * Cache a DOI result
+ */
+export function cacheDoi(doi: string, result: DoiCheckResult | DoiLookupResult): void {
+  const cache = loadCache();
+  cache.entries[doi] = {
+    result,
+    timestamp: Date.now(),
+  };
+
+  // Limit cache size - remove oldest entries if over 1000
+  const entries = Object.entries(cache.entries);
+  if (entries.length > 1000) {
+    entries
+      .sort((a, b) => a[1].timestamp - b[1].timestamp)
+      .slice(0, entries.length - 800)
+      .forEach(([key]) => delete cache.entries[key]);
+  }
+
+  saveCache();
+}
+
+/**
+ * Clear the DOI cache
+ */
+export function clearDoiCache(): void {
+  doiCache = { entries: {}, version: 1 };
+  try {
+    if (fs.existsSync(CACHE_FILE)) {
+      fs.unlinkSync(CACHE_FILE);
+    }
+  } catch {
+    // Ignore
+  }
+}
+
+/**
+ * Get DOI cache statistics
+ */
+export function getDoiCacheStats(): DoiCacheStats {
+  const cache = loadCache();
+  return {
+    size: Object.keys(cache.entries).length,
+    path: CACHE_FILE,
+  };
+}