vitest-runner 1.0.0 → 1.0.1

package/README.md

@@ -149,7 +149,6 @@ Runs the test suite and resolves with an exit code (`0` = all passed, `1` = any
 import { run } from 'vitest-runner';
 
 const code = await run({
-  cwd: process.cwd(),
   testDir: 'src/tests',
 });
 
@@ -160,7 +159,7 @@ process.exit(code);
 
 | Option | Type | Default | Description |
 |--------|------|---------|-------------|
-| `cwd` | `string` | **required** | Absolute project root directory |
+| `cwd` | `string` | `process.cwd()` | Absolute project root directory |
 | `testDir` | `string` | `cwd` | Directory (absolute or relative to `cwd`) to scan for `*.test.vitest.{js,mjs}` files |
 | `vitestConfig` | `string` | auto-detect | Explicit vitest config path; when omitted the runner walks standard config names (`vitest.config.ts`, `vite.config.ts`, etc.) relative to `cwd` |
 | `testPatterns` | `string[]` | `[]` | File / folder patterns to filter — empty means all files in `testDir` |
@@ -188,33 +187,29 @@ process.exit(code);
 #### Examples
 
 ```js
-// Run all tests under src/tests/
-await run({ cwd: process.cwd(), testDir: 'src/tests' });
+// Run all tests under src/tests/ (cwd defaults to process.cwd())
+await run({ testDir: 'src/tests' });
 
 // Run only the config and metadata suites
 await run({
-  cwd: process.cwd(),
   testDir: 'src/tests',
   testPatterns: ['src/tests/config', 'src/tests/metadata'],
 });
 
 // Coverage run (OOM-safe blob + merge mode)
 await run({
-  cwd: process.cwd(),
   testDir: 'src/tests',
   vitestArgs: ['--coverage'],
 });
 
 // Quiet coverage with live progress bar
 await run({
-  cwd: process.cwd(),
   testDir: 'src/tests',
   coverageQuiet: true,
 });
 
 // Give heap-heavy files a larger ceiling while keeping the global limit lower
 await run({
-  cwd: process.cwd(),
   testDir: 'src/tests',
   maxOldSpaceMb: 2048,
   earlyRunPatterns: ['listener-cleanup/'],

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "vitest-runner",
-	"version": "1.0.0",
+	"version": "1.0.1",
 	"description": "Sequential Vitest runner to avoid OOM issues with large test suites",
 	"type": "module",
 	"main": "index.cjs",

package/src/runner.mjs

@@ -11,15 +11,14 @@
  * are forwarded to child processes unchanged.
  *
  * @example
- * // Run every test file found under src/tests/
+ * // Run every test file found under src/tests/ (cwd defaults to process.cwd())
  * import { run } from 'vitest-runner';
- * const code = await run({ cwd: process.cwd(), testDir: 'src/tests' });
+ * const code = await run({ testDir: 'src/tests' });
  * process.exit(code);
  *
  * @example
  * // Run a subset with custom heap limit
  * const code = await run({
- *   cwd: process.cwd(),
  *   testDir: 'src/tests',
  *   testPatterns: ['src/tests/config'],
  *   maxOldSpaceMb: 4096,
@@ -47,7 +46,7 @@ import { colourPct } from "./utils/ansi.mjs";
 
 /**
  * @typedef {Object} RunOptions
- * @property {string} cwd - Absolute project root directory.
+ * @property {string} [cwd=process.cwd()] - Absolute project root directory (defaults to `process.cwd()`).
  * @property {string} [testDir] - Directory to scan for test files (relative or absolute; defaults to `cwd`).
  * @property {string} [vitestConfig] - Explicit vitest config path; auto-detected from `cwd` when omitted.
  * @property {string[]} [testPatterns=[]] - File / folder patterns to filter (empty = all files in `testDir`).
@@ -101,7 +100,7 @@ function getHeapForFile(filePath, globalMaxMb, overrides) {
  */
 export async function run(opts) {
 	const {
-		cwd,
+		cwd = process.cwd(),
 		testDir,
 		testPatterns = [],
 		testListFile,

package/types/src/runner.d.mts

@@ -20,9 +20,9 @@ export type PerFileHeapOverride = {
 };
 export type RunOptions = {
     /**
-     * - Absolute project root directory.
+     * - Absolute project root directory (defaults to `process.cwd()`).
      */
-    cwd: string;
+    cwd?: string;
     /**
      * - Directory to scan for test files (relative or absolute; defaults to `cwd`).
      */