docrev 0.10.1 → 0.11.0

package/lib/csl.ts

@@ -1,191 +1,191 @@
-/**
- * CSL citation style resolution and caching
- *
- * Resolves short CSL names (e.g. "nature") to local file paths,
- * downloading from the CSL repository if needed.
- */
-
-import * as fs from 'fs';
-import * as path from 'path';
-import * as os from 'os';
-import * as https from 'https';
-
-// =============================================================================
-// Constants
-// =============================================================================
-
-/** Cache directory for downloaded CSL files */
-const CSL_CACHE_DIR = path.join(os.homedir(), '.rev', 'csl');
-
-/** GitHub raw URL for the CSL styles repository */
-const CSL_REPO_BASE = 'https://raw.githubusercontent.com/citation-style-language/styles/master';
-
-/**
- * Short name → CSL filename mapping for common styles.
- * Names that match their filename exactly don't need an entry here.
- */
-const CSL_ALIASES: Record<string, string> = {
-  'apa': 'apa',
-  'chicago': 'chicago-author-date',
-  'vancouver': 'vancouver',
-  'ieee': 'ieee',
-  'nature': 'nature',
-  'science': 'science',
-  'cell': 'cell',
-  'pnas': 'pnas',
-  'plos': 'plos',
-  'elife': 'elife',
-  'ecology-letters': 'ecology-letters',
-  'ecology': 'ecology',
-  'ama': 'american-medical-association',
-  'acs': 'american-chemical-society',
-  'rsc': 'royal-society-of-chemistry',
-  'harvard': 'harvard-cite-them-right',
-  'mla': 'modern-language-association',
-  'elsevier': 'elsevier-harvard',
-  'springer': 'springer-basic-author-date',
-  'biomed-central': 'biomed-central',
-};
-
-// =============================================================================
-// Public API
-// =============================================================================
-
-/**
- * Get the CSL cache directory path
- */
-export function getCSLCacheDir(): string {
-  return CSL_CACHE_DIR;
-}
-
-/**
- * Resolve a CSL name or path to a local file path.
- *
- * Resolution order:
- * 1. If it's an absolute path or relative path that exists, return it
- * 2. Check project directory for <name>.csl
- * 3. Check ~/.rev/csl/ cache
- * 4. Return null (caller can then use fetchCSL to download)
- */
-export function resolveCSL(nameOrPath: string, projectDir?: string): string | null {
-  // Already a file path that exists
-  if (path.isAbsolute(nameOrPath) && fs.existsSync(nameOrPath)) {
-    return nameOrPath;
-  }
-
-  // Relative path in project directory
-  if (projectDir) {
-    const projectPath = path.join(projectDir, nameOrPath);
-    if (fs.existsSync(projectPath)) {
-      return projectPath;
-    }
-    // Try with .csl extension
-    const projectPathCsl = projectPath.endsWith('.csl') ? projectPath : `${projectPath}.csl`;
-    if (fs.existsSync(projectPathCsl)) {
-      return projectPathCsl;
-    }
-  }
-
-  // Resolve short name to filename
-  const baseName = resolveCSLName(nameOrPath);
-  const fileName = baseName.endsWith('.csl') ? baseName : `${baseName}.csl`;
-
-  // Check cache
-  const cachePath = path.join(CSL_CACHE_DIR, fileName);
-  if (fs.existsSync(cachePath)) {
-    return cachePath;
-  }
-
-  return null;
-}
-
-/**
- * Download a CSL style from the CSL repository to the local cache.
- *
- * @returns Path to the cached file, or null on failure
- */
-export async function fetchCSL(name: string): Promise<string | null> {
-  const baseName = resolveCSLName(name);
-  const fileName = baseName.endsWith('.csl') ? baseName : `${baseName}.csl`;
-  const url = `${CSL_REPO_BASE}/${fileName}`;
-  const cachePath = path.join(CSL_CACHE_DIR, fileName);
-
-  // Ensure cache directory exists
-  if (!fs.existsSync(CSL_CACHE_DIR)) {
-    fs.mkdirSync(CSL_CACHE_DIR, { recursive: true });
-  }
-
-  try {
-    const content = await httpGet(url);
-    if (content) {
-      fs.writeFileSync(cachePath, content, 'utf-8');
-      return cachePath;
-    }
-    return null;
-  } catch {
-    return null;
-  }
-}
-
-/**
- * List all cached CSL files
- */
-export function listCachedCSL(): Array<{ name: string; path: string }> {
-  if (!fs.existsSync(CSL_CACHE_DIR)) {
-    return [];
-  }
-
-  return fs.readdirSync(CSL_CACHE_DIR)
-    .filter(f => f.endsWith('.csl'))
-    .sort()
-    .map(f => ({
-      name: path.basename(f, '.csl'),
-      path: path.join(CSL_CACHE_DIR, f),
-    }));
-}
-
-/**
- * Get the list of known CSL short name aliases
- */
-export function getCSLAliases(): Record<string, string> {
-  return { ...CSL_ALIASES };
-}
-
-// =============================================================================
-// Internal helpers
-// =============================================================================
-
-/**
- * Resolve a short name to a CSL filename (without extension)
- */
-function resolveCSLName(name: string): string {
-  const normalized = name.toLowerCase().replace(/\.csl$/, '');
-  return CSL_ALIASES[normalized] || normalized;
-}
-
-/**
- * Simple HTTPS GET that follows redirects
- */
-function httpGet(url: string, redirectCount = 0): Promise<string | null> {
-  if (redirectCount > 5) return Promise.resolve(null);
-
-  return new Promise((resolve) => {
-    https.get(url, (res) => {
-      // Follow redirects
-      if ((res.statusCode === 301 || res.statusCode === 302) && res.headers.location) {
-        resolve(httpGet(res.headers.location, redirectCount + 1));
-        return;
-      }
-
-      if (res.statusCode !== 200) {
-        resolve(null);
-        return;
-      }
-
-      let data = '';
-      res.on('data', chunk => { data += chunk; });
-      res.on('end', () => resolve(data));
-      res.on('error', () => resolve(null));
-    }).on('error', () => resolve(null));
-  });
-}
+/**
+ * CSL citation style resolution and caching
+ *
+ * Resolves short CSL names (e.g. "nature") to local file paths,
+ * downloading from the CSL repository if needed.
+ */
+
+import * as fs from 'fs';
+import * as path from 'path';
+import * as os from 'os';
+import * as https from 'https';
+
+// =============================================================================
+// Constants
+// =============================================================================
+
+/** Cache directory for downloaded CSL files */
+const CSL_CACHE_DIR = path.join(os.homedir(), '.rev', 'csl');
+
+/** GitHub raw URL for the CSL styles repository */
+const CSL_REPO_BASE = 'https://raw.githubusercontent.com/citation-style-language/styles/master';
+
+/**
+ * Short name → CSL filename mapping for common styles.
+ * Names that match their filename exactly don't need an entry here.
+ */
+const CSL_ALIASES: Record<string, string> = {
+  'apa': 'apa',
+  'chicago': 'chicago-author-date',
+  'vancouver': 'vancouver',
+  'ieee': 'ieee',
+  'nature': 'nature',
+  'science': 'science',
+  'cell': 'cell',
+  'pnas': 'pnas',
+  'plos': 'plos',
+  'elife': 'elife',
+  'ecology-letters': 'ecology-letters',
+  'ecology': 'ecology',
+  'ama': 'american-medical-association',
+  'acs': 'american-chemical-society',
+  'rsc': 'royal-society-of-chemistry',
+  'harvard': 'harvard-cite-them-right',
+  'mla': 'modern-language-association',
+  'elsevier': 'elsevier-harvard',
+  'springer': 'springer-basic-author-date',
+  'biomed-central': 'biomed-central',
+};
+
+// =============================================================================
+// Public API
+// =============================================================================
+
+/**
+ * Get the CSL cache directory path
+ */
+export function getCSLCacheDir(): string {
+  return CSL_CACHE_DIR;
+}
+
+/**
+ * Resolve a CSL name or path to a local file path.
+ *
+ * Resolution order:
+ * 1. If it's an absolute path or relative path that exists, return it
+ * 2. Check project directory for <name>.csl
+ * 3. Check ~/.rev/csl/ cache
+ * 4. Return null (caller can then use fetchCSL to download)
+ */
+export function resolveCSL(nameOrPath: string, projectDir?: string): string | null {
+  // Already a file path that exists
+  if (path.isAbsolute(nameOrPath) && fs.existsSync(nameOrPath)) {
+    return nameOrPath;
+  }
+
+  // Relative path in project directory
+  if (projectDir) {
+    const projectPath = path.join(projectDir, nameOrPath);
+    if (fs.existsSync(projectPath)) {
+      return projectPath;
+    }
+    // Try with .csl extension
+    const projectPathCsl = projectPath.endsWith('.csl') ? projectPath : `${projectPath}.csl`;
+    if (fs.existsSync(projectPathCsl)) {
+      return projectPathCsl;
+    }
+  }
+
+  // Resolve short name to filename
+  const baseName = resolveCSLName(nameOrPath);
+  const fileName = baseName.endsWith('.csl') ? baseName : `${baseName}.csl`;
+
+  // Check cache
+  const cachePath = path.join(CSL_CACHE_DIR, fileName);
+  if (fs.existsSync(cachePath)) {
+    return cachePath;
+  }
+
+  return null;
+}
+
+/**
+ * Download a CSL style from the CSL repository to the local cache.
+ *
+ * @returns Path to the cached file, or null on failure
+ */
+export async function fetchCSL(name: string): Promise<string | null> {
+  const baseName = resolveCSLName(name);
+  const fileName = baseName.endsWith('.csl') ? baseName : `${baseName}.csl`;
+  const url = `${CSL_REPO_BASE}/${fileName}`;
+  const cachePath = path.join(CSL_CACHE_DIR, fileName);
+
+  // Ensure cache directory exists
+  if (!fs.existsSync(CSL_CACHE_DIR)) {
+    fs.mkdirSync(CSL_CACHE_DIR, { recursive: true });
+  }
+
+  try {
+    const content = await httpGet(url);
+    if (content) {
+      fs.writeFileSync(cachePath, content, 'utf-8');
+      return cachePath;
+    }
+    return null;
+  } catch {
+    return null;
+  }
+}
+
+/**
+ * List all cached CSL files
+ */
+export function listCachedCSL(): Array<{ name: string; path: string }> {
+  if (!fs.existsSync(CSL_CACHE_DIR)) {
+    return [];
+  }
+
+  return fs.readdirSync(CSL_CACHE_DIR)
+    .filter(f => f.endsWith('.csl'))
+    .sort()
+    .map(f => ({
+      name: path.basename(f, '.csl'),
+      path: path.join(CSL_CACHE_DIR, f),
+    }));
+}
+
+/**
+ * Get the list of known CSL short name aliases
+ */
+export function getCSLAliases(): Record<string, string> {
+  return { ...CSL_ALIASES };
+}
+
+// =============================================================================
+// Internal helpers
+// =============================================================================
+
+/**
+ * Resolve a short name to a CSL filename (without extension)
+ */
+function resolveCSLName(name: string): string {
+  const normalized = name.toLowerCase().replace(/\.csl$/, '');
+  return CSL_ALIASES[normalized] || normalized;
+}
+
+/**
+ * Simple HTTPS GET that follows redirects
+ */
+function httpGet(url: string, redirectCount = 0): Promise<string | null> {
+  if (redirectCount > 5) return Promise.resolve(null);
+
+  return new Promise((resolve) => {
+    https.get(url, (res) => {
+      // Follow redirects
+      if ((res.statusCode === 301 || res.statusCode === 302) && res.headers.location) {
+        resolve(httpGet(res.headers.location, redirectCount + 1));
+        return;
+      }
+
+      if (res.statusCode !== 200) {
+        resolve(null);
+        return;
+      }
+
+      let data = '';
+      res.on('data', chunk => { data += chunk; });
+      res.on('end', () => resolve(data));
+      res.on('error', () => resolve(null));
+    }).on('error', () => resolve(null));
+  });
+}

package/lib/dependencies.ts

@@ -1,98 +1,132 @@
-/**
- * Dependency checking utilities for pandoc, LaTeX, and related tools
- */
-
-import { execSync } from 'child_process';
-
-/**
- * Check if a command is available by running it silently
- */
-function commandExists(cmd: string): boolean {
-  try {
-    execSync(cmd, { stdio: 'ignore' });
-    return true;
-  } catch {
-    return false;
-  }
-}
-
-/**
- * Check if pandoc-crossref is available
- */
-export function hasPandocCrossref(): boolean {
-  return commandExists('pandoc-crossref --version');
-}
-
-/**
- * Check if pandoc is available
- */
-export function hasPandoc(): boolean {
-  return commandExists('pandoc --version');
-}
-
-/**
- * Check if LaTeX is available (for PDF generation)
- */
-export function hasLatex(): boolean {
-  return commandExists('pdflatex --version') || commandExists('xelatex --version');
-}
-
-/**
- * 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;
-}
+/**
+ * Dependency checking utilities for pandoc, LaTeX, and related tools
+ */
+
+import { execFileSync } from 'child_process';
+
+/**
+ * Run `<file> --version` without a shell and return its stdout, or null when
+ * the binary is absent (ENOENT) or exits non-zero (present but broken). Using
+ * execFileSync avoids shell quoting and treats both failure modes uniformly.
+ */
+function runVersion(file: string, args: string[] = ['--version']): string | null {
+  try {
+    return execFileSync(file, args, { stdio: ['ignore', 'pipe', 'ignore'], encoding: 'utf-8' });
+  } catch {
+    return null;
+  }
+}
+
+function commandExists(file: string, args: string[] = ['--version']): boolean {
+  return runVersion(file, args) !== null;
+}
+
+/**
+ * Check if pandoc-crossref is available
+ */
+export function hasPandocCrossref(): boolean {
+  return commandExists('pandoc-crossref');
+}
+
+/**
+ * Check if pandoc is available
+ */
+export function hasPandoc(): boolean {
+  return commandExists('pandoc');
+}
+
+/**
+ * Parsed pandoc version (e.g. "3.9"), or null when pandoc is unavailable.
+ */
+export function getPandocVersion(): string | null {
+  const out = runVersion('pandoc');
+  if (!out) return null;
+  const m = out.match(/pandoc(?:\.exe)?\s+(\d+\.\d+(?:\.\d+)?)/i);
+  return m ? m[1]! : null;
+}
+
+/**
+ * Whether pandoc bundles citeproc and accepts `--citeproc`. That flag and the
+ * built-in citeproc arrived in pandoc 2.11; earlier versions need the separate
+ * pandoc-citeproc filter.
+ */
+export function pandocSupportsCiteproc(): boolean {
+  const v = getPandocVersion();
+  if (!v) return false;
+  const parts = v.split('.').map((n) => parseInt(n, 10));
+  const major = parts[0] ?? 0;
+  const minor = parts[1] ?? 0;
+  return major > 2 || (major === 2 && minor >= 11);
+}
+
+/**
+ * Check if LaTeX is available (for PDF generation)
+ */
+export function hasLatex(): boolean {
+  return commandExists('pdflatex') || commandExists('xelatex');
+}
+
+/**
+ * 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')}`);
+  } else if (!pandocSupportsCiteproc()) {
+    const version = getPandocVersion();
+    status.messages.push(
+      `Pandoc ${version ?? '(unknown version)'} is older than 2.11; citation processing (--citeproc) needs 2.11+. Upgrade 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;
+}