modestbench 0.2.0 → 0.3.1

package/src/cli/commands/init.ts

@@ -26,12 +26,12 @@ import {
  * Init command options interface
  */
 interface InitOptions {
-  configType: 'js' | 'json' | 'ts' | 'yaml';
-  cwd: string;
-  examples: boolean;
+  configType?: 'js' | 'json' | 'ts' | 'yaml';
+  cwd?: string;
+  examples?: boolean;
   force?: boolean | undefined;
   quiet?: boolean | undefined;
-  type: 'advanced' | 'basic' | 'library';
+  type?: 'advanced' | 'basic' | 'library';
   verbose?: boolean | undefined;
   yes?: boolean | undefined;
 }
@@ -43,39 +43,39 @@ const PROJECT_TEMPLATES = {
   advanced: {
     configOptions: {
       iterations: 1000,
-      outputDir: './benchmark-results',
-      pattern: 'benchmarks/**/*.bench.{js,ts}',
+      outputDir: '.modestbench',
+      pattern: 'bench/**/*.bench.{js,ts}',
       reporters: ['human', 'json'],
       time: 10000,
       warmup: 50,
     },
     description: 'Feature-rich setup with multiple reporters and configuration',
-    directories: ['benchmarks', 'benchmark-results'],
+    directories: ['bench', '.modestbench'],
     name: 'Advanced Project',
   },
   basic: {
     configOptions: {
       iterations: 100,
-      pattern: 'benchmarks/**/*.bench.{js,ts}',
+      pattern: 'bench/**/*.bench.{js,ts}',
       reporters: ['human'],
       time: 5000,
     },
     description: 'Simple benchmark setup for small projects',
-    directories: ['benchmarks'],
+    directories: ['bench'],
     name: 'Basic Project',
   },
   library: {
     configOptions: {
       bail: false,
       iterations: 5000,
-      outputDir: './benchmark-results',
-      pattern: 'benchmarks/**/*.bench.{js,ts}',
+      outputDir: '.modestbench',
+      pattern: 'bench/**/*.bench.{js,ts}',
       reporters: ['human', 'json'],
       time: 15000,
       warmup: 100,
     },
     description: 'Optimized for library performance testing',
-    directories: ['benchmarks', 'benchmarks/suites', 'benchmark-results'],
+    directories: ['bench', 'bench/suites', '.modestbench'],
     name: 'Library Project',
   },
 } as const;
@@ -244,7 +244,7 @@ export default {
 /**
  * Prompt user for confirmation with Y/n default to Yes
  */
-const promptUser = async (question: string): Promise<boolean> => {
+const _promptUser = async (question: string): Promise<boolean> => {
   const rl = createInterface({
     input: process.stdin,
     output: process.stdout,
@@ -268,7 +268,13 @@ export const handleInitCommand = async (
   options: InitOptions,
 ): Promise<number> => {
   try {
-    const template = PROJECT_TEMPLATES[options.type];
+    // Apply defaults for required options
+    const type = options.type ?? 'basic';
+    const cwd = options.cwd ?? process.cwd();
+    const configType = options.configType ?? 'json';
+    const examples = options.examples ?? false;
+
+    const template = PROJECT_TEMPLATES[type];
 
     if (!options.quiet) {
       console.log(`Initializing ${template.name}...`);
@@ -278,7 +284,7 @@ export const handleInitCommand = async (
 
     // Check if project already exists
     if (!options.force) {
-      const hasConflicts = await checkForConflicts(options);
+      const hasConflicts = await checkForConflicts(cwd, configType);
       if (hasConflicts) {
         console.error('Project files already exist. Use --force to overwrite.');
         return 1; // Already initialized
@@ -286,28 +292,31 @@ export const handleInitCommand = async (
     }
 
     // Create directory structure
-    await createDirectories(template.directories, options);
+    await createDirectories(template.directories, cwd);
 
     // Create configuration file
-    await createConfigFile(template.configOptions, options);
+    await createConfigFile(template.configOptions, cwd, configType);
 
     // Create example benchmarks if requested
-    if (options.examples) {
-      await createExampleBenchmarks(options);
+    if (examples) {
+      await createExampleBenchmarks(cwd);
     }
 
     // Create additional files
-    await createAdditionalFiles(options);
+    await createAdditionalFiles(cwd, {
+      quiet: options.quiet,
+      yes: options.yes,
+    });
 
     if (!options.quiet) {
       console.log('✅ Project initialized successfully!');
       console.log();
       console.log('Next steps:');
-      if (options.examples) {
+      if (examples) {
         console.log('  1. Run example benchmarks: modestbench run');
       } else {
         console.log(
-          '  1. Create your first benchmark file in the benchmarks/ directory',
+          '  1. Create your first benchmark file in the bench/ directory',
         );
       }
       console.log('  2. Customize configuration in your config file');
@@ -337,15 +346,15 @@ export const handleInitCommand = async (
 /**
  * Check for existing files that would conflict
  */
-const checkForConflicts = async (options: InitOptions): Promise<boolean> => {
-  const filesToCheck = [
-    'modestbench.config.' + options.configType,
-    'benchmarks',
-  ];
+const checkForConflicts = async (
+  cwd: string,
+  configType: string,
+): Promise<boolean> => {
+  const filesToCheck = ['modestbench.config.' + configType, 'benchmarks'];
 
   for (const file of filesToCheck) {
     try {
-      await access(resolve(options.cwd, file));
+      await access(resolve(cwd, file));
       return true; // File exists, conflict detected
     } catch {
       // File doesn't exist, no conflict
@@ -355,139 +364,13 @@ const checkForConflicts = async (options: InitOptions): Promise<boolean> => {
   return false;
 };
 
-/**
- * Handle .gitignore file creation or modification
- */
-const handleGitignore = async (options: InitOptions): Promise<void> => {
-  const gitignorePath = resolve(options.cwd, '.gitignore');
-  const modestbenchEntry = '.modestbench/';
-
-  // Default .gitignore content for new files
-  const defaultGitignoreContent = `# ModestBench
-benchmark-results/
-.modestbench/
-
-# Dependencies
-node_modules/
-
-# Environment
-.env
-.env.local
-
-# Logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-# OS
-.DS_Store
-Thumbs.db
-`;
-
-  try {
-    // Check if .gitignore exists
-    let gitignoreExists = false;
-    try {
-      await access(gitignorePath);
-      gitignoreExists = true;
-    } catch {
-      // File doesn't exist
-    }
-
-    if (!gitignoreExists) {
-      // Create new .gitignore with full content
-      await writeFile(gitignorePath, defaultGitignoreContent, 'utf8');
-      if (options.verbose) {
-        console.log('  ✓ .gitignore');
-      }
-      return;
-    }
-
-    // File exists, check if .modestbench/ is already present
-    const existingContent = await readFile(gitignorePath, 'utf8');
-
-    // Check if .modestbench/ is already in the file
-    const hasModestbenchEntry = existingContent
-      .split('\n')
-      .some((line) => line.trim() === modestbenchEntry);
-
-    if (hasModestbenchEntry) {
-      // Already has the entry, nothing to do
-      if (options.verbose) {
-        console.log('  ✓ .gitignore (already contains .modestbench/)');
-      }
-      return;
-    }
-
-    // Determine if we should prompt or auto-add
-    let shouldAdd = false;
-
-    if (options.yes || options.quiet) {
-      // Auto-accept in non-interactive mode
-      shouldAdd = true;
-    } else {
-      // Prompt the user
-      console.log();
-      console.log(
-        'The .modestbench/ directory stores benchmark history and should typically',
-      );
-      console.log('not be committed to version control.');
-      console.log();
-
-      shouldAdd = await promptUser(
-        'Would you like to add .modestbench/ to .gitignore? (Y/n) ',
-      );
-    }
-
-    if (shouldAdd) {
-      // Append .modestbench/ to existing .gitignore
-      let contentToAppend = '';
-
-      // Ensure file ends with newline
-      if (!existingContent.endsWith('\n')) {
-        contentToAppend += '\n';
-      }
-
-      // Add a blank line if the file doesn't end with one
-      if (!existingContent.endsWith('\n\n') && existingContent.trim() !== '') {
-        contentToAppend += '\n';
-      }
-
-      // Add comment and entry
-      contentToAppend += '# ModestBench history\n';
-      contentToAppend += modestbenchEntry + '\n';
-
-      await appendFile(gitignorePath, contentToAppend, 'utf8');
-
-      if (options.verbose || !options.quiet) {
-        console.log('  ✓ Added .modestbench/ to .gitignore');
-      }
-    } else {
-      if (options.verbose) {
-        console.log('  ⊘ Skipped adding .modestbench/ to .gitignore');
-      }
-    }
-  } catch (error) {
-    // Non-critical, just warn
-    console.warn(
-      'Warning: Could not create/modify .gitignore file:',
-      error instanceof Error ? error.message : String(error),
-    );
-  }
-};
-
 /**
  * Create additional project files
  */
-const createAdditionalFiles = async (options: InitOptions): Promise<void> => {
-  if (!options.quiet) {
-    console.log('Creating additional files...');
-  }
-
-  // Handle .gitignore
-  await handleGitignore(options);
-
+const createAdditionalFiles = async (
+  cwd: string,
+  options?: { quiet?: boolean; yes?: boolean },
+): Promise<void> => {
   // Create README.md
   const readmeContent = `# Benchmark Project
 
@@ -502,7 +385,7 @@ modestbench run
 
 Run specific benchmarks:
 \`\`\`bash
-modestbench run "benchmarks/array-*.bench.js"
+modestbench run "bench/array-*.bench.js"
 \`\`\`
 
 View benchmark history:
@@ -516,19 +399,78 @@ See \`modestbench.config.*\` for benchmark configuration options.
 
 ## Writing Benchmarks
 
-Create new benchmark files in the \`benchmarks/\` directory. See the examples for the expected format.
+Create new benchmark files in the \`bench/\` directory. See the examples for the expected format.
 `;
 
   try {
-    const readmePath = resolve(options.cwd, 'README.md');
+    const readmePath = resolve(cwd, 'README.md');
     await writeFile(readmePath, readmeContent, 'utf8');
-    if (options.verbose) {
-      console.log('  ✓ README.md');
-    }
   } catch {
     // Non-critical, just warn
     console.warn('Warning: Could not create README.md file');
   }
+
+  // Create or update .gitignore
+  await createOrUpdateGitignore(cwd, options);
+};
+
+/**
+ * Create or update .gitignore file to include ModestBench directories
+ */
+const createOrUpdateGitignore = async (
+  cwd: string,
+  options?: { quiet?: boolean; yes?: boolean },
+): Promise<void> => {
+  const gitignorePath = resolve(cwd, '.gitignore');
+  const modestbenchEntry = '.modestbench/';
+  const modestbenchSection = `\n# ModestBench history\n${modestbenchEntry}\n`;
+
+  try {
+    // Check if .gitignore exists
+    let existingContent = '';
+    try {
+      existingContent = await readFile(gitignorePath, 'utf8');
+    } catch {
+      // File doesn't exist, will create new one
+    }
+
+    if (existingContent) {
+      // File exists, check if .modestbench/ is already present
+      if (existingContent.includes(modestbenchEntry)) {
+        // Already present, nothing to do
+        return;
+      }
+
+      // Append .modestbench/ entry (--yes or --quiet means auto-accept)
+      if (options?.yes || options?.quiet) {
+        // Ensure content ends with newline
+        const contentToAppend = existingContent.endsWith('\n')
+          ? modestbenchSection
+          : `\n${modestbenchSection}`;
+        await appendFile(gitignorePath, contentToAppend, 'utf8');
+      }
+    } else {
+      // Create new .gitignore with common entries
+      const newContent = `# Dependencies
+node_modules/
+
+# Build output
+dist/
+build/
+*.log
+
+# Test coverage
+coverage/
+
+# Benchmark output
+benchmark-results/
+${modestbenchSection}`;
+      await writeFile(gitignorePath, newContent, 'utf8');
+    }
+  } catch {
+    // Non-critical, just warn
+    console.warn('Warning: Could not create/update .gitignore file');
+  }
 };
 
 /**
@@ -536,18 +478,15 @@ Create new benchmark files in the \`benchmarks/\` directory. See the examples fo
  */
 const createConfigFile = async (
   configOptions: any,
-  options: InitOptions,
+  cwd: string,
+  configType: string,
 ): Promise<void> => {
-  const filename = `modestbench.config.${options.configType}`;
-  const filePath = resolve(options.cwd, filename);
-
-  if (!options.quiet) {
-    console.log(`Creating configuration file: ${filename}`);
-  }
+  const filename = `modestbench.config.${configType}`;
+  const filePath = resolve(cwd, filename);
 
   let content: string;
 
-  switch (options.configType) {
+  switch (configType) {
     case 'js':
       content = `export default ${JSON.stringify(configOptions, null, 2)};\n`;
       break;
@@ -572,15 +511,12 @@ export default config;
 
     default:
       throw new UnsupportedConfigFormatError(
-        `Unsupported config format: ${options.configType}`,
+        `Unsupported config format: ${configType}`,
       );
   }
 
   try {
     await writeFile(filePath, content, 'utf8');
-    if (options.verbose) {
-      console.log(`  ✓ ${filename}`);
-    }
   } catch (error) {
     throw new InvalidArgumentError(
       `Failed to create config file: ${error instanceof Error ? error.message : String(error)}`,
@@ -594,19 +530,12 @@ export default config;
  */
 const createDirectories = async (
   directories: readonly string[],
-  options: InitOptions,
+  cwd: string,
 ): Promise<void> => {
-  if (!options.quiet) {
-    console.log('Creating directories...');
-  }
-
   for (const dir of directories) {
-    const dirPath = resolve(options.cwd, dir);
+    const dirPath = resolve(cwd, dir);
     try {
       await mkdir(dirPath, { recursive: true });
-      if (options.verbose) {
-        console.log(`  ✓ ${dir}/`);
-      }
     } catch (error) {
       throw new InvalidArgumentError(
         `Failed to create directory ${dir}: ${error instanceof Error ? error.message : String(error)}`,
@@ -619,21 +548,14 @@ const createDirectories = async (
 /**
  * Create example benchmark files
  */
-const createExampleBenchmarks = async (options: InitOptions): Promise<void> => {
-  if (!options.quiet) {
-    console.log('Creating example benchmarks...');
-  }
-
-  const benchmarksDir = resolve(options.cwd, 'benchmarks');
+const createExampleBenchmarks = async (cwd: string): Promise<void> => {
+  const benchmarksDir = resolve(cwd, 'bench');
 
   for (const [name, example] of Object.entries(EXAMPLE_BENCHMARKS)) {
     const filePath = join(benchmarksDir, example.filename);
 
     try {
       await writeFile(filePath, example.content, 'utf8');
-      if (options.verbose) {
-        console.log(`  ✓ ${example.filename}`);
-      }
     } catch (error) {
       throw new InvalidArgumentError(
         `Failed to create example ${name}: ${error instanceof Error ? error.message : String(error)}`,