fix(init): init templates now use proper default .modestbench/ dir for output

Author: boneskull

modestbench.config.json

@@ -7,7 +7,7 @@
     "version": "1.0.0",
     "description": "Demonstration benchmarks for ModestBench framework"
   },
-  "outputDir": "./benchmark-results",
+  "outputDir": "./.modestbench",
   "pattern": "examples/**/*.bench.{js,ts}",
   "quiet": false,
   "reporterConfig": {

src/cli/commands/init.ts

@@ -17,6 +17,11 @@ import { createInterface } from 'node:readline';
 
 import type { CliContext } from '../index.js';
 
+import {
+  DEFAULT_BENCHMARK_DIR,
+  DEFAULT_OUTPUT_DIR,
+  SITE_URL,
+} from '../../constants.js';
 import {
   InvalidArgumentError,
   UnsupportedConfigFormatError,
@@ -43,40 +48,44 @@ const PROJECT_TEMPLATES = {
   advanced: {
     configOptions: {
       iterations: 1000,
-      outputDir: '.modestbench',
-      pattern: 'bench/**/*.bench.{js,ts}',
+      outputDir: DEFAULT_OUTPUT_DIR,
+      pattern: `${DEFAULT_BENCHMARK_DIR}/**/*.bench.{js,ts}`,
       reporters: ['human', 'json'],
       time: 10000,
       warmup: 50,
     },
     description: 'Feature-rich setup with multiple reporters and configuration',
-    directories: ['bench', '.modestbench'],
+    directories: [DEFAULT_BENCHMARK_DIR, DEFAULT_OUTPUT_DIR],
     name: 'Advanced Project',
   },
   basic: {
     configOptions: {
       iterations: 100,
-      outputDir: '.modestbench',
-      pattern: 'bench/**/*.bench.{js,ts}',
+      outputDir: DEFAULT_OUTPUT_DIR,
+      pattern: `${DEFAULT_BENCHMARK_DIR}/**/*.bench.{js,ts}`,
       reporters: ['human'],
       time: 5000,
     },
     description: 'Simple benchmark setup for small projects',
-    directories: ['bench', '.modestbench'],
+    directories: [DEFAULT_BENCHMARK_DIR, DEFAULT_OUTPUT_DIR],
     name: 'Basic Project',
   },
   library: {
     configOptions: {
       bail: false,
       iterations: 5000,
-      outputDir: '.modestbench',
-      pattern: 'bench/**/*.bench.{js,ts}',
+      outputDir: DEFAULT_OUTPUT_DIR,
+      pattern: `${DEFAULT_BENCHMARK_DIR}/**/*.bench.{js,ts}`,
       reporters: ['human', 'json'],
       time: 15000,
       warmup: 100,
     },
     description: 'Optimized for library performance testing',
-    directories: ['bench', 'bench/suites', '.modestbench'],
+    directories: [
+      DEFAULT_BENCHMARK_DIR,
+      `${DEFAULT_BENCHMARK_DIR}/suites`,
+      DEFAULT_OUTPUT_DIR,
+    ],
     name: 'Library Project',
   },
 } as const;
@@ -375,7 +384,7 @@ const createAdditionalFiles = async (
   // Create README.md
   const readmeContent = `# Benchmark Project
 
-This project uses [ModestBench](https://github.com/your-org/modestbench) for performance testing.
+This project uses [ModestBench](${SITE_URL}) for performance testing.
 
 ## Getting Started
 
@@ -386,7 +395,7 @@ modestbench run
 
 Run specific benchmarks:
 \`\`\`bash
-modestbench run "bench/array-*.bench.js"
+modestbench run "${DEFAULT_BENCHMARK_DIR}/array-*.bench.js"
 \`\`\`
 
 View benchmark history:
@@ -400,7 +409,7 @@ See \`modestbench.config.*\` for benchmark configuration options.
 
 ## Writing Benchmarks
 
-Create new benchmark files in the \`bench/\` directory. See the examples for the expected format.
+Create new benchmark files in the \`${DEFAULT_BENCHMARK_DIR}/\` directory. See the examples for the expected format.
 `;
 
   try {
@@ -423,7 +432,7 @@ const createOrUpdateGitignore = async (
   options?: { quiet?: boolean; yes?: boolean },
 ): Promise<void> => {
   const gitignorePath = resolve(cwd, '.gitignore');
-  const modestbenchEntry = '.modestbench/';
+  const modestbenchEntry = `${DEFAULT_OUTPUT_DIR}/`;
   const modestbenchSection = `\n# ModestBench history\n${modestbenchEntry}\n`;
 
   try {
@@ -436,13 +445,13 @@ const createOrUpdateGitignore = async (
     }
 
     if (existingContent) {
-      // File exists, check if .modestbench/ is already present
+      // File exists, check if ${DEFAULT_OUTPUT_DIR}/ is already present
       if (existingContent.includes(modestbenchEntry)) {
         // Already present, nothing to do
         return;
       }
 
-      // Append .modestbench/ entry (--yes or --quiet means auto-accept)
+      // Append default output dir entry (--yes or --quiet means auto-accept)
       if (options?.yes || options?.quiet) {
         // Ensure content ends with newline
         const contentToAppend = existingContent.endsWith('\n')
@@ -464,7 +473,6 @@ build/
 coverage/
 
 # Benchmark output
-benchmark-results/
 ${modestbenchSection}`;
       await writeFile(gitignorePath, newContent, 'utf8');
     }
@@ -550,7 +558,7 @@ const createDirectories = async (
  * Create example benchmark files
  */
 const createExampleBenchmarks = async (cwd: string): Promise<void> => {
-  const benchmarksDir = resolve(cwd, 'bench');
+  const benchmarksDir = resolve(cwd, DEFAULT_BENCHMARK_DIR);
 
   for (const [name, example] of Object.entries(EXAMPLE_BENCHMARKS)) {
     const filePath = join(benchmarksDir, example.filename);

src/cli/index.ts

@@ -24,6 +24,7 @@ import type {
 import { bootstrap } from '../bootstrap.js';
 import {
   ABORT_TIMEOUT,
+  DEFAULT_BENCHMARK_DIR,
   DEFAULT_ENGINE,
   DEFAULT_REPORTER,
   Engines,
@@ -177,7 +178,7 @@ export const main = async (
           yargs
             .positional('pattern', {
               array: true,
-              defaultDescription: '(auto-discovered from bench/ directory)',
+              defaultDescription: `(auto-discovered from ${DEFAULT_BENCHMARK_DIR} directory)`,
               describe:
                 'File paths, directory paths, or glob patterns for benchmark files',
               type: 'string',

src/constants.ts

@@ -131,3 +131,18 @@ export const ErrorCodes = {
   VALIDATION_TYPE_FAILED: 'ERR_MB_VALIDATION_TYPE_FAILED',
   //#endregion
 } as const;
+
+/**
+ * Default output directory for reporters, history, cache, etc.
+ */
+export const DEFAULT_OUTPUT_DIR = './.modestbench';
+
+/**
+ * Default directory containing `*.bench.*` files
+ */
+export const DEFAULT_BENCHMARK_DIR = 'bench';
+
+/**
+ * URL of the site
+ */
+export const SITE_URL = 'https://modestbench.dev';

src/errors/base.ts

@@ -5,10 +5,12 @@
  * documentation URLs, and consistent error display.
  */
 
+import { SITE_URL } from '../constants.js';
+
 /**
  * Base URL for error documentation
  */
-const ERROR_DOC_BASE_URL = 'https://modestbench.dev/reference/errors';
+const ERROR_DOC_BASE_URL = `${SITE_URL}/reference/errors`;
 
 /**
  * Abstract base class for ModestBench aggregate errors

src/services/config-manager.ts

@@ -19,7 +19,7 @@ import type {
 } from '../types/index.js';
 
 import { safeParseConfig } from '../config/schema.js';
-import { ErrorCodes } from '../constants.js';
+import { DEFAULT_BENCHMARK_DIR, ErrorCodes } from '../constants.js';
 import { ConfigLoadError, ConfigValidationError } from '../errors/index.js';
 
 /**
@@ -56,7 +56,7 @@ const DEFAULT_CONFIG: ModestBenchConfig = {
   limitBy: 'iterations', // Default to limiting by iteration count
   metadata: {},
   outputDir: undefined, // No default output directory - reporters will use stdout unless explicitly configured
-  pattern: 'bench/**/*.bench.{js,ts,mjs,cjs,mts,cts}', // Search bench/ directory recursively
+  pattern: `${DEFAULT_BENCHMARK_DIR}/**/*.bench.{js,ts,mjs,cjs,mts,cts}`, // Search bench/ directory recursively
   quiet: false,
   reporterConfig: {},
   reporters: [getDefaultReporter()],

test/fixtures/data-builders.ts

@@ -25,6 +25,7 @@ import type {
   TaskResult,
 } from '../../src/types/index.js';
 
+import { DEFAULT_OUTPUT_DIR } from '../../src/constants.js';
 import { createRunId } from '../../src/utils/identifiers.js';
 
 /**
@@ -62,7 +63,7 @@ export const buildMockConfig = (
     iterations: 100,
     limitBy: 'iterations',
     metadata: {},
-    outputDir: './benchmark-results',
+    outputDir: DEFAULT_OUTPUT_DIR,
     pattern: '**/*.bench.{js,ts}',
     quiet: false,
     reporterConfig: {},

test/integration/init-command.test.ts

@@ -15,6 +15,10 @@ import { tmpdir } from 'node:os';
 import { join } from 'node:path';
 import { afterEach, beforeEach, describe, it } from 'node:test';
 
+import {
+  DEFAULT_BENCHMARK_DIR,
+  DEFAULT_OUTPUT_DIR,
+} from '../../src/constants.js';
 import { ModestBenchConfigurationManager } from '../../src/services/config-manager.js';
 import { runCommand } from '../util.js';
 
@@ -290,7 +294,7 @@ describe('modestbench init command - integration', () => {
       await runCommand(['init', '--no-examples'], tempDir);
 
       // Bench directory should exist but be empty
-      const benchmarksDir = join(tempDir, 'bench');
+      const benchmarksDir = join(tempDir, DEFAULT_BENCHMARK_DIR);
       await access(benchmarksDir); // Directory exists
 
       // Example files should not exist
@@ -304,7 +308,7 @@ describe('modestbench init command - integration', () => {
       await runCommand(['init', '--examples'], tempDir);
 
       const exampleContent = await readFile(
-        join(tempDir, 'bench', 'example.bench.js'),
+        join(tempDir, DEFAULT_BENCHMARK_DIR, 'example.bench.js'),
         'utf8',
       );
 
@@ -330,7 +334,7 @@ describe('modestbench init command - integration', () => {
       expect(
         content,
         'to contain',
-        'benchmark-results/',
+        `${DEFAULT_OUTPUT_DIR}/`,
         'and',
         'to contain',
         'node_modules/',
@@ -343,7 +347,7 @@ describe('modestbench init command - integration', () => {
       const gitignorePath = join(tempDir, '.gitignore');
       const content = await readFile(gitignorePath, 'utf8');
 
-      expect(content, 'to contain', '.modestbench/');
+      expect(content, 'to contain', `${DEFAULT_OUTPUT_DIR}/`);
     });
 
     it('should append .modestbench/ to existing .gitignore with --yes flag', async () => {
@@ -362,7 +366,7 @@ describe('modestbench init command - integration', () => {
       expect(content, 'to contain', '*.log');
 
       // Should contain newly added .modestbench/
-      expect(content, 'to contain', '.modestbench/');
+      expect(content, 'to contain', `${DEFAULT_OUTPUT_DIR}/`);
       expect(content, 'to contain', '# ModestBench history');
     });
 
@@ -378,16 +382,16 @@ describe('modestbench init command - integration', () => {
       const content = await readFile(gitignorePath, 'utf8');
 
       // Should contain newly added .modestbench/
-      expect(content, 'to contain', '.modestbench/');
+      expect(content, 'to contain', `${DEFAULT_OUTPUT_DIR}/`);
     });
 
-    it('should not duplicate .modestbench/ if already present', async () => {
+    it(`should not duplicate ${DEFAULT_OUTPUT_DIR}/ if already present`, async () => {
       const gitignorePath = join(tempDir, '.gitignore');
 
       // Create existing .gitignore with .modestbench/ already in it
       await writeFile(
         gitignorePath,
-        'node_modules/\n.modestbench/\n*.log\n',
+        'node_modules/\n${DEFAULT_OUTPUT_DIR}/\n*.log\n',
         'utf8',
       );
 
@@ -397,11 +401,11 @@ describe('modestbench init command - integration', () => {
       const content = await readFile(gitignorePath, 'utf8');
 
       // Count occurrences of .modestbench/
-      const matches = content.match(/\.modestbench\//g);
+      const matches = content.match(new RegExp(`${DEFAULT_OUTPUT_DIR}/`, 'g'));
       expect(matches?.length, 'to equal', 1);
     });
 
-    it('should format appended .modestbench/ with proper newlines', async () => {
+    it(`should format appended ${DEFAULT_OUTPUT_DIR}/ with proper newlines`, async () => {
       const gitignorePath = join(tempDir, '.gitignore');
 
       // Create existing .gitignore without trailing newline
@@ -416,7 +420,7 @@ describe('modestbench init command - integration', () => {
       expect(
         content,
         'to contain',
-        'node_modules/\n\n# ModestBench history\n.modestbench/\n',
+        `node_modules/\n\n# ModestBench history\n${DEFAULT_OUTPUT_DIR}/\n`,
       );
     });