docrev 0.9.4 → 0.9.6

package/lib/commands/project-info.ts

@@ -0,0 +1,244 @@
+/**
+ * Project information commands: word-count (wc), stats, search
+ *
+ * Read-only queries about the project state.
+ */
+
+import type { Command } from 'commander';
+import {
+  chalk,
+  fs,
+  path,
+  fmt,
+  findFiles,
+  loadBuildConfig,
+  countAnnotations,
+  getComments,
+  countWords,
+} from './context.js';
+
+// Use the actual BuildConfig from build.ts which allows string|Author[]
+type BuildConfig = ReturnType<typeof loadBuildConfig>;
+
+// Options interfaces
+interface WordCountOptions {
+  limit?: number;
+  journal?: string;
+}
+
+interface StatsOptions {
+  // No options currently
+}
+
+interface SearchOptions {
+  ignoreCase?: boolean;
+  context?: number;
+}
+
+/**
+ * Register project-info commands with the program
+ */
+export function register(program: Command): void {
+  // ==========================================================================
+  // WORD-COUNT command - Per-section word counts
+  // ==========================================================================
+
+  program
+    .command('word-count')
+    .alias('wc')
+    .description('Show word counts per section')
+    .option('-l, --limit <number>', 'Warn if total exceeds limit', parseInt)
+    .option('-j, --journal <name>', 'Use journal word limit')
+    .action(async (options: WordCountOptions) => {
+      let config: Partial<BuildConfig> = {};
+      try {
+        config = loadBuildConfig('.') || {};
+      } catch {
+        // Not in a rev project, that's ok
+      }
+      const sections = config.sections || [];
+
+      if (sections.length === 0) {
+        // Try to find .md files
+        const mdFiles = fs.readdirSync('.').filter(f =>
+          f.endsWith('.md') && !['README.md', 'CLAUDE.md', 'paper.md'].includes(f)
+        );
+        if (mdFiles.length === 0) {
+          console.error(chalk.red('No section files found. Run from a rev project directory.'));
+          process.exit(1);
+        }
+        sections.push(...mdFiles);
+      }
+
+      let total = 0;
+      const rows: string[][] = [];
+
+      for (const section of sections) {
+        if (!fs.existsSync(section)) continue;
+        const text = fs.readFileSync(section, 'utf-8');
+        const words = countWords(text);
+        total += words;
+        rows.push([section, words.toLocaleString()]);
+      }
+
+      rows.push(['', '']);
+      rows.push([chalk.bold('Total'), chalk.bold(total.toLocaleString())]);
+
+      console.log(fmt.header('Word Count'));
+      console.log(fmt.table(['Section', 'Words'], rows));
+
+      // Check limit
+      let limit = options.limit;
+      if (options.journal) {
+        const { getJournalProfile } = await import('../journals.js');
+        const profile = getJournalProfile(options.journal);
+        if (profile?.requirements?.wordLimit?.main) {
+          limit = profile.requirements.wordLimit.main;
+          console.log(chalk.dim(`\nUsing ${profile.name} word limit: ${limit.toLocaleString()}`));
+        }
+      }
+
+      if (limit && total > limit) {
+        console.log(chalk.red(`\n⚠ Over limit by ${(total - limit).toLocaleString()} words`));
+      } else if (limit) {
+        console.log(chalk.green(`\n✓ Within limit (${(limit - total).toLocaleString()} words remaining)`));
+      }
+    });
+
+  // ==========================================================================
+  // STATS command - Project dashboard
+  // ==========================================================================
+
+  program
+    .command('stats')
+    .description('Show project statistics dashboard')
+    .action(async (_options: StatsOptions) => {
+      let config: Partial<BuildConfig> = {};
+      try {
+        config = loadBuildConfig('.') || {};
+      } catch {
+        // Not in a rev project, that's ok
+      }
+      let sections = config.sections || [];
+
+      if (sections.length === 0) {
+        sections = fs.readdirSync('.').filter(f =>
+          f.endsWith('.md') && !['README.md', 'CLAUDE.md', 'paper.md'].includes(f)
+        );
+      }
+
+      let totalWords = 0;
+      let totalFigures = 0;
+      let totalTables = 0;
+      let totalComments = 0;
+      let pendingComments = 0;
+      const citations = new Set<string>();
+
+      for (const section of sections) {
+        if (!fs.existsSync(section)) continue;
+        const text = fs.readFileSync(section, 'utf-8');
+
+        totalWords += countWords(text);
+        totalFigures += (text.match(/!\[.*?\]\(.*?\)/g) || []).length;
+        totalTables += (text.match(/^\|[^|]+\|/gm) || []).length / 5; // Approximate
+
+        const comments = getComments(text);
+        totalComments += comments.length;
+        pendingComments += comments.filter(c => !c.resolved).length;
+
+        const cites = text.match(/@(\w+)(?![:\w])/g) || [];
+        cites.forEach(c => citations.add(c.slice(1)));
+      }
+
+      console.log(fmt.header('Project Statistics'));
+      console.log();
+
+      const stats: [string, string | number][] = [
+        ['Sections', sections.length],
+        ['Words', totalWords.toLocaleString()],
+        ['Figures', Math.round(totalFigures)],
+        ['Tables', Math.round(totalTables)],
+        ['Citations', citations.size],
+        ['Comments', `${totalComments} (${pendingComments} pending)`],
+      ];
+
+      for (const [label, value] of stats) {
+        console.log(`  ${chalk.dim(label.padEnd(12))} ${chalk.bold(value)}`);
+      }
+
+      // Bibliography stats
+      const bibPath = config.bibliography || 'references.bib';
+      if (fs.existsSync(bibPath)) {
+        const bibContent = fs.readFileSync(bibPath, 'utf-8');
+        const bibEntries = (bibContent.match(/@\w+\s*\{/g) || []).length;
+        console.log(`  ${chalk.dim('Bib entries'.padEnd(12))} ${chalk.bold(bibEntries)}`);
+      }
+
+      console.log();
+    });
+
+  // ==========================================================================
+  // SEARCH command - Search across section files
+  // ==========================================================================
+
+  program
+    .command('search')
+    .description('Search across all section files')
+    .argument('<query>', 'Search query (supports regex)')
+    .option('-i, --ignore-case', 'Case-insensitive search')
+    .option('-c, --context <lines>', 'Show context lines', parseInt, 1)
+    .action((query: string, options: SearchOptions) => {
+      let config: Partial<BuildConfig> = {};
+      try {
+        config = loadBuildConfig('.') || {};
+      } catch {
+        // Not in a rev project, that's ok
+      }
+      let sections = config.sections || [];
+
+      if (sections.length === 0) {
+        sections = fs.readdirSync('.').filter(f =>
+          f.endsWith('.md') && !['README.md', 'CLAUDE.md'].includes(f)
+        );
+      }
+
+      const flags = options.ignoreCase ? 'gi' : 'g';
+      let pattern: RegExp;
+      try {
+        pattern = new RegExp(query, flags);
+      } catch {
+        pattern = new RegExp(query.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'), flags);
+      }
+
+      let totalMatches = 0;
+
+      for (const section of sections) {
+        if (!fs.existsSync(section)) continue;
+        const text = fs.readFileSync(section, 'utf-8');
+        const lines = text.split('\n');
+
+        const matches: { line: number; text: string }[] = [];
+        for (let i = 0; i < lines.length; i++) {
+          if (pattern.test(lines[i])) {
+            matches.push({ line: i + 1, text: lines[i] });
+            pattern.lastIndex = 0;
+          }
+        }
+
+        if (matches.length > 0) {
+          console.log(chalk.cyan.bold(`\n${section}`));
+          for (const match of matches) {
+            const highlighted = match.text.replace(pattern, (m) => chalk.yellow.bold(m));
+            console.log(`  ${chalk.dim(match.line + ':')} ${highlighted}`);
+          }
+          totalMatches += matches.length;
+        }
+      }
+
+      if (totalMatches === 0) {
+        console.log(chalk.yellow(`No matches found for "${query}"`));
+      } else {
+        console.log(chalk.dim(`\n${totalMatches} match${totalMatches === 1 ? '' : 'es'} found`));
+      }
+    });
+}