docrev 0.6.7 → 0.7.6

package/lib/commands/history.js

@@ -0,0 +1,307 @@
+/**
+ * History commands: diff, history, contributors
+ *
+ * Commands for git-based revision tracking and author statistics.
+ */
+
+import {
+  chalk,
+  fs,
+  path,
+  fmt,
+  loadBuildConfig,
+} from './context.js';
+
+/**
+ * Register history commands with the program
+ * @param {import('commander').Command} program
+ */
+export function register(program) {
+  // ==========================================================================
+  // DIFF command - Compare sections against git history
+  // ==========================================================================
+
+  program
+    .command('diff')
+    .description('Compare sections against git history')
+    .argument('[ref]', 'Git reference to compare against (default: main/master)')
+    .option('-f, --files <files>', 'Specific files to compare (comma-separated)')
+    .option('--stat', 'Show only statistics, not full diff')
+    .action(async (ref, options) => {
+      const {
+        isGitRepo,
+        getDefaultBranch,
+        getCurrentBranch,
+        getChangedFiles,
+        getWordCountDiff,
+        compareFileVersions,
+      } = await import('../git.js');
+
+      if (!isGitRepo()) {
+        console.error(fmt.status('error', 'Not a git repository'));
+        process.exit(1);
+      }
+
+      const compareRef = ref || getDefaultBranch();
+      const currentBranch = getCurrentBranch();
+
+      console.log(fmt.header('Git Diff'));
+      console.log(chalk.dim(`  Comparing: ${compareRef} → ${currentBranch || 'HEAD'}`));
+      console.log();
+
+      // Get files to compare
+      let filesToCompare;
+      if (options.files) {
+        filesToCompare = options.files.split(',').map(f => f.trim());
+      } else {
+        // Default to markdown section files
+        filesToCompare = fs.readdirSync('.').filter(f =>
+          f.endsWith('.md') && !['README.md', 'CLAUDE.md'].includes(f)
+        );
+      }
+
+      if (filesToCompare.length === 0) {
+        console.log(fmt.status('info', 'No markdown files found'));
+        return;
+      }
+
+      // Get changed files from git
+      const changedFiles = getChangedFiles(compareRef);
+      const changedSet = new Set(changedFiles.map(f => f.file));
+
+      // Get word count differences
+      const { total, byFile } = getWordCountDiff(filesToCompare, compareRef);
+
+      // Show results
+      const rows = [];
+      for (const file of filesToCompare) {
+        const stats = byFile[file];
+        if (stats && (stats.added > 0 || stats.removed > 0)) {
+          const status = changedSet.has(file)
+            ? changedFiles.find(f => f.file === file)?.status || 'modified'
+            : 'unchanged';
+          rows.push([
+            file,
+            status,
+            chalk.green(`+${stats.added}`),
+            chalk.red(`-${stats.removed}`),
+          ]);
+        }
+      }
+
+      if (rows.length === 0) {
+        console.log(fmt.status('success', 'No changes detected'));
+        return;
+      }
+
+      console.log(fmt.table(['File', 'Status', 'Added', 'Removed'], rows));
+      console.log();
+      console.log(chalk.dim(`Total: ${chalk.green(`+${total.added}`)} words, ${chalk.red(`-${total.removed}`)} words`));
+
+      // Show detailed diff if not --stat
+      if (!options.stat && rows.length > 0) {
+        console.log();
+        console.log(chalk.cyan('Changed sections:'));
+        for (const file of filesToCompare) {
+          const stats = byFile[file];
+          if (stats && (stats.added > 0 || stats.removed > 0)) {
+            const { changes } = compareFileVersions(file, compareRef);
+            console.log(chalk.bold(`\n  ${file}:`));
+
+            // Show first few significant changes
+            let shown = 0;
+            for (const change of changes) {
+              if (shown >= 3) {
+                console.log(chalk.dim('    ...'));
+                break;
+              }
+              const preview = change.text.slice(0, 60).replace(/\n/g, ' ');
+              if (change.type === 'add') {
+                console.log(chalk.green(`    + "${preview}..."`));
+              } else {
+                console.log(chalk.red(`    - "${preview}..."`));
+              }
+              shown++;
+            }
+          }
+        }
+      }
+    });
+
+  // ==========================================================================
+  // HISTORY command - Show revision history
+  // ==========================================================================
+
+  program
+    .command('history')
+    .description('Show revision history for section files')
+    .argument('[file]', 'Specific file (default: all sections)')
+    .option('-n, --limit <count>', 'Number of commits to show', '10')
+    .action(async (file, options) => {
+      const {
+        isGitRepo,
+        getFileHistory,
+        getRecentCommits,
+        hasUncommittedChanges,
+      } = await import('../git.js');
+
+      if (!isGitRepo()) {
+        console.error(fmt.status('error', 'Not a git repository'));
+        process.exit(1);
+      }
+
+      const limit = parseInt(options.limit) || 10;
+
+      console.log(fmt.header('Revision History'));
+      console.log();
+
+      if (file) {
+        // Show history for specific file
+        if (!fs.existsSync(file)) {
+          console.error(fmt.status('error', `File not found: ${file}`));
+          process.exit(1);
+        }
+
+        const history = getFileHistory(file, limit);
+
+        if (history.length === 0) {
+          console.log(fmt.status('info', 'No history found (file may not be committed)'));
+          return;
+        }
+
+        console.log(chalk.cyan(`History for ${file}:`));
+        console.log();
+
+        for (const commit of history) {
+          const date = new Date(commit.date).toLocaleDateString();
+          console.log(`  ${chalk.yellow(commit.hash)} ${chalk.dim(date)}`);
+          console.log(`    ${commit.message}`);
+        }
+      } else {
+        // Show recent commits affecting any file
+        const commits = getRecentCommits(limit);
+
+        if (commits.length === 0) {
+          console.log(fmt.status('info', 'No commits found'));
+          return;
+        }
+
+        if (hasUncommittedChanges()) {
+          console.log(chalk.yellow('  * Uncommitted changes'));
+          console.log();
+        }
+
+        for (const commit of commits) {
+          const date = new Date(commit.date).toLocaleDateString();
+          console.log(`  ${chalk.yellow(commit.hash)} ${chalk.dim(date)} ${chalk.blue(commit.author)}`);
+          console.log(`    ${commit.message}`);
+        }
+      }
+    });
+
+  // ==========================================================================
+  // CONTRIBUTORS command - Show who wrote what
+  // ==========================================================================
+
+  program
+    .command('contributors')
+    .alias('authors')
+    .description('Show author contributions across section files')
+    .argument('[file]', 'Specific file (default: all sections)')
+    .option('--blame', 'Show detailed line-by-line blame for a file')
+    .action(async (file, options) => {
+      const { isGitRepo, getAuthorStats, getContributors, getFileBlame } = await import('../git.js');
+
+      if (!isGitRepo()) {
+        console.error(fmt.status('error', 'Not a git repository'));
+        process.exit(1);
+      }
+
+      console.log(fmt.header('Contributors'));
+      console.log();
+
+      if (file) {
+        // Show stats for specific file
+        if (!fs.existsSync(file)) {
+          console.error(fmt.status('error', `File not found: ${file}`));
+          process.exit(1);
+        }
+
+        if (options.blame) {
+          // Detailed blame output
+          const blame = getFileBlame(file);
+          if (blame.length === 0) {
+            console.log(fmt.status('info', 'No git history (file may not be committed)'));
+            return;
+          }
+
+          console.log(chalk.cyan(`Blame for ${file}:`));
+          console.log();
+
+          for (const entry of blame) {
+            const authorShort = entry.author.slice(0, 15).padEnd(15);
+            const content = entry.content.length > 60 ? entry.content.slice(0, 60) + '...' : entry.content;
+            console.log(`  ${chalk.dim(entry.hash)} ${chalk.blue(authorShort)} ${chalk.dim(`L${String(entry.line).padStart(3)}`)} ${content}`);
+          }
+        } else {
+          // Summary stats
+          const stats = getAuthorStats(file);
+          if (Object.keys(stats).length === 0) {
+            console.log(fmt.status('info', 'No git history (file may not be committed)'));
+            return;
+          }
+
+          console.log(chalk.cyan(`Authors for ${file}:`));
+          console.log();
+
+          const sorted = Object.entries(stats).sort((a, b) => b[1].lines - a[1].lines);
+          for (const [author, data] of sorted) {
+            const bar = '█'.repeat(Math.ceil(data.percentage / 5));
+            console.log(`  ${chalk.blue(author.padEnd(25))} ${chalk.dim(String(data.lines).padStart(4))} lines ${chalk.green(bar)} ${data.percentage}%`);
+          }
+        }
+      } else {
+        // Show contributors across all sections
+        let config = {};
+        try {
+          config = loadBuildConfig() || {};
+        } catch {
+          // Not in a rev project
+        }
+
+        let sections = config.sections || [];
+        if (sections.length === 0) {
+          sections = fs.readdirSync('.').filter(f =>
+            f.endsWith('.md') && !['README.md', 'CLAUDE.md', 'paper.md'].includes(f)
+          );
+        }
+
+        if (sections.length === 0) {
+          console.error(fmt.status('error', 'No section files found'));
+          process.exit(1);
+        }
+
+        const contributors = getContributors(sections);
+
+        if (Object.keys(contributors).length === 0) {
+          console.log(fmt.status('info', 'No git history found'));
+          return;
+        }
+
+        const sorted = Object.entries(contributors).sort((a, b) => b[1].lines - a[1].lines);
+        const totalLines = sorted.reduce((sum, [, data]) => sum + data.lines, 0);
+
+        console.log(chalk.cyan('Project contributors:'));
+        console.log();
+
+        for (const [author, data] of sorted) {
+          const pct = Math.round((data.lines / totalLines) * 100);
+          const bar = '█'.repeat(Math.ceil(pct / 5));
+          console.log(`  ${chalk.blue(author.padEnd(25))} ${chalk.dim(String(data.lines).padStart(5))} lines  ${chalk.dim(String(data.files))} files ${chalk.green(bar)} ${pct}%`);
+        }
+
+        console.log();
+        console.log(chalk.dim(`  Total: ${totalLines} lines across ${sections.length} files`));
+      }
+    });
+}

package/lib/commands/index.js

@@ -0,0 +1,56 @@
+/**
+ * Command module index
+ *
+ * Exports registration functions for all command modules.
+ * Each module's register() function adds commands to the Commander program.
+ */
+
+import { register as registerCoreCommands } from './core.js';
+import { register as registerCommentCommands } from './comments.js';
+import { register as registerInitCommands } from './init.js';
+import { register as registerSectionCommands } from './sections.js';
+import { register as registerBuildCommands } from './build.js';
+import { register as registerResponseCommands } from './response.js';
+import { register as registerCitationCommands } from './citations.js';
+import { register as registerDoiCommands } from './doi.js';
+import { register as registerHistoryCommands } from './history.js';
+import { register as registerUtilityCommands } from './utilities.js';
+
+export {
+  registerCoreCommands,
+  registerCommentCommands,
+  registerInitCommands,
+  registerSectionCommands,
+  registerBuildCommands,
+  registerResponseCommands,
+  registerCitationCommands,
+  registerDoiCommands,
+  registerHistoryCommands,
+  registerUtilityCommands,
+};
+
+// Re-export context utilities for use by the main CLI
+export {
+  setQuietMode,
+  setJsonMode,
+  quietMode,
+  jsonMode,
+} from './context.js';
+
+/**
+ * Register all command modules with the program.
+ * @param {import('commander').Command} program
+ * @param {object} [pkg] - Package.json object for version info (optional)
+ */
+export function registerAllCommands(program, pkg) {
+  registerCoreCommands(program);
+  registerCommentCommands(program);
+  registerInitCommands(program);
+  registerSectionCommands(program);
+  registerBuildCommands(program, pkg);
+  registerResponseCommands(program);
+  registerCitationCommands(program);
+  registerDoiCommands(program);
+  registerHistoryCommands(program);
+  registerUtilityCommands(program, pkg);
+}

package/lib/commands/init.js

@@ -0,0 +1,247 @@
+/**
+ * Init commands: init, new, config
+ *
+ * Project initialization and configuration commands.
+ */
+
+import {
+  chalk,
+  fs,
+  path,
+  fmt,
+  generateConfig,
+  loadConfig,
+  saveConfig,
+  getTemplate,
+  listTemplates,
+  generateCustomTemplate,
+  getUserName,
+  setUserName,
+  getConfigPath,
+  getDefaultSections,
+  setDefaultSections,
+} from './context.js';
+
+/**
+ * Register init commands with the program
+ * @param {import('commander').Command} program
+ */
+export function register(program) {
+  // ==========================================================================
+  // INIT command - Generate sections.yaml config
+  // ==========================================================================
+
+  program
+    .command('init')
+    .description('Generate sections.yaml from existing .md files')
+    .option('-d, --dir <directory>', 'Directory to scan', '.')
+    .option('-o, --output <file>', 'Output config file', 'sections.yaml')
+    .option('--force', 'Overwrite existing config')
+    .action((options) => {
+      const dir = path.resolve(options.dir);
+
+      if (!fs.existsSync(dir)) {
+        console.error(chalk.red(`Directory not found: ${dir}`));
+        process.exit(1);
+      }
+
+      const outputPath = path.resolve(options.dir, options.output);
+
+      if (fs.existsSync(outputPath) && !options.force) {
+        console.error(chalk.yellow(`Config already exists: ${outputPath}`));
+        console.error(chalk.dim('Use --force to overwrite'));
+        process.exit(1);
+      }
+
+      console.log(chalk.cyan(`Scanning ${dir} for .md files...`));
+
+      const config = generateConfig(dir);
+      const sectionCount = Object.keys(config.sections).length;
+
+      if (sectionCount === 0) {
+        console.error(chalk.yellow('No .md files found (excluding paper.md, README.md)'));
+        process.exit(1);
+      }
+
+      saveConfig(outputPath, config);
+
+      console.log(chalk.green(`\nCreated ${outputPath} with ${sectionCount} sections:\n`));
+
+      for (const [file, section] of Object.entries(config.sections)) {
+        console.log(`  ${chalk.bold(file)}`);
+        console.log(chalk.dim(`    header: "${section.header}"`));
+        if (section.aliases?.length > 0) {
+          console.log(chalk.dim(`    aliases: ${JSON.stringify(section.aliases)}`));
+        }
+      }
+
+      console.log(chalk.cyan('\nEdit this file to:'));
+      console.log(chalk.dim('  • Add aliases for header variations'));
+      console.log(chalk.dim('  • Adjust order if needed'));
+      console.log(chalk.dim('  • Update headers if they change'));
+    });
+
+  // ==========================================================================
+  // NEW command - Create new paper project
+  // ==========================================================================
+
+  program
+    .command('new')
+    .description('Create a new paper project from template')
+    .argument('[name]', 'Project directory name')
+    .option('-t, --template <name>', 'Template: paper, minimal, thesis, review', 'paper')
+    .option('-s, --sections <sections>', 'Comma-separated section names (e.g., intro,methods,results)')
+    .option('--list', 'List available templates')
+    .action(async (name, options) => {
+      if (options.list) {
+        console.log(chalk.cyan('Available templates:\n'));
+        for (const t of listTemplates()) {
+          console.log(`  ${chalk.bold(t.id)} - ${t.description}`);
+        }
+        return;
+      }
+
+      if (!name) {
+        console.error(chalk.red('Error: project name is required'));
+        console.error(chalk.dim('Usage: rev new <name>'));
+        process.exit(1);
+      }
+
+      const projectDir = path.resolve(name);
+
+      if (fs.existsSync(projectDir)) {
+        console.error(chalk.red(`Directory already exists: ${name}`));
+        process.exit(1);
+      }
+
+      let template;
+      let sections = null;
+
+      // Determine sections: CLI option > user config > prompt
+      if (options.sections) {
+        // Parse CLI sections
+        sections = options.sections.split(',').map((s) => s.trim().toLowerCase().replace(/\.md$/, ''));
+      } else {
+        // Check user config for default sections
+        const defaultSections = getDefaultSections();
+        if (defaultSections && defaultSections.length > 0) {
+          sections = defaultSections;
+        }
+      }
+
+      // If no sections from CLI or config, and not using a named template with --template, prompt
+      // Only prompt if stdin is a TTY (interactive terminal)
+      if (!sections && options.template === 'paper') {
+        if (process.stdin.isTTY) {
+          const rl = (await import('readline')).createInterface({
+            input: process.stdin,
+            output: process.stdout,
+          });
+
+          const ask = (prompt) => new Promise((resolve) => rl.question(prompt, resolve));
+
+          console.log(chalk.cyan('Enter your document sections (comma-separated):'));
+          console.log(chalk.dim('  Example: introduction,methods,results,discussion'));
+          console.log(chalk.dim('  Press Enter to use default: introduction,methods,results,discussion\n'));
+
+          const answer = await ask(chalk.cyan('Sections: '));
+          rl.close();
+
+          if (answer.trim()) {
+            sections = answer.split(',').map((s) => s.trim().toLowerCase().replace(/\.md$/, ''));
+          } else {
+            // Use default paper template sections
+            sections = ['introduction', 'methods', 'results', 'discussion'];
+          }
+        } else {
+          // Non-interactive: use default sections
+          sections = ['introduction', 'methods', 'results', 'discussion'];
+        }
+      }
+
+      // Generate template based on sections
+      if (sections) {
+        template = generateCustomTemplate(sections);
+        console.log(chalk.cyan(`Creating project with sections: ${sections.join(', ')}\n`));
+      } else {
+        template = getTemplate(options.template);
+        if (!template) {
+          console.error(chalk.red(`Unknown template: ${options.template}`));
+          console.error(chalk.dim('Use --list to see available templates.'));
+          process.exit(1);
+        }
+        console.log(chalk.cyan(`Creating ${template.name} project in ${name}/...\n`));
+      }
+
+      // Create directory
+      fs.mkdirSync(projectDir, { recursive: true });
+
+      // Create subdirectories
+      for (const subdir of template.directories || []) {
+        fs.mkdirSync(path.join(projectDir, subdir), { recursive: true });
+        console.log(chalk.dim(`  Created ${subdir}/`));
+      }
+
+      // Create files
+      for (const [filename, content] of Object.entries(template.files)) {
+        const filePath = path.join(projectDir, filename);
+        fs.writeFileSync(filePath, content, 'utf-8');
+        console.log(chalk.dim(`  Created ${filename}`));
+      }
+
+      console.log(chalk.green(`\nProject created!`));
+      console.log(chalk.cyan('\nNext steps:'));
+      console.log(chalk.dim(`  cd ${name}`));
+      console.log(chalk.dim('  # Edit rev.yaml with your paper details'));
+      console.log(chalk.dim('  # Write your sections'));
+      console.log(chalk.dim('  rev build          # Build PDF and DOCX'));
+      console.log(chalk.dim('  rev build pdf      # Build PDF only'));
+    });
+
+  // ==========================================================================
+  // CONFIG command - Set user preferences
+  // ==========================================================================
+
+  program
+    .command('config')
+    .description('Set user preferences')
+    .argument('<key>', 'Config key: user, sections')
+    .argument('[value]', 'Value to set')
+    .action((key, value) => {
+      if (key === 'user') {
+        if (value) {
+          setUserName(value);
+          console.log(chalk.green(`User name set to: ${value}`));
+          console.log(chalk.dim(`Saved to ${getConfigPath()}`));
+        } else {
+          const name = getUserName();
+          if (name) {
+            console.log(`Current user: ${chalk.bold(name)}`);
+          } else {
+            console.log(chalk.yellow('No user name set.'));
+            console.log(chalk.dim('Set with: rev config user "Your Name"'));
+          }
+        }
+      } else if (key === 'sections') {
+        if (value) {
+          const sections = value.split(',').map((s) => s.trim().toLowerCase().replace(/\.md$/, ''));
+          setDefaultSections(sections);
+          console.log(chalk.green(`Default sections set to: ${sections.join(', ')}`));
+          console.log(chalk.dim(`Saved to ${getConfigPath()}`));
+        } else {
+          const sections = getDefaultSections();
+          if (sections && sections.length > 0) {
+            console.log(`Default sections: ${chalk.bold(sections.join(', '))}`);
+          } else {
+            console.log(chalk.yellow('No default sections set.'));
+            console.log(chalk.dim('Set with: rev config sections "intro,methods,results,discussion"'));
+            console.log(chalk.dim('When not set, rev new will prompt for sections.'));
+          }
+        }
+      } else {
+        console.error(chalk.red(`Unknown config key: ${key}`));
+        console.error(chalk.dim('Available keys: user, sections'));
+        process.exit(1);
+      }
+    });
+}