@hughescr/stryker-bun-runner 1.0.0-beta1 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +12 -13
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -2,12 +2,7 @@
2
2
 
3
3
  Stryker test runner plugin for Bun with perTest coverage support.
4
4
 
5
- [![npm version](https://img.shields.io/npm/v/@hughescr/stryker-bun-runner)](https://www.npmjs.com/package/@hughescr/stryker-bun-runner) [![LICENSE](https://img.shields.io/badge/LICENSE-Apache--2.0-blue)](LICENSE.md) [![Bun](https://img.shields.io/badge/Bun-%3E1.3.6-f9f1e1?logo=bun)](https://bun.sh) [![Stryker](https://img.shields.io/badge/Stryker-Plugin-e74c3c?logo=stryker)](https://stryker-mutator.io) [![Mutation testing badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fhughescr%2Fstryker-bun-runner%2Fmain)](https://dashboard.stryker-mutator.io/reports/github.com/hughescr/stryker-bun-runner/main) [![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-3178c6?logo=typescript&logoColor=white)](https://www.typescriptlang.org)
6
-
7
- > **Beta Status**: This package is published as `1.0.0-beta1` because it requires
8
- > a pre-release build of Bun with [PR #25986](https://github.com/oven-sh/bun/pull/25986)
9
- > merged. Once this fix is available in mainline Bun, we will release version `1.0.0`.
10
- > The plugin itself is feature-complete and stable.
5
+ [![npm version](https://img.shields.io/npm/v/@hughescr/stryker-bun-runner)](https://www.npmjs.com/package/@hughescr/stryker-bun-runner) [![LICENSE](https://img.shields.io/badge/LICENSE-Apache--2.0-blue)](LICENSE.md) [![Bun](https://img.shields.io/badge/Bun-%3E%3D1.3.7-f9f1e1?logo=bun)](https://bun.sh) [![Stryker](https://img.shields.io/badge/Stryker-Plugin-e74c3c?logo=stryker)](https://stryker-mutator.io) [![Mutation testing badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fhughescr%2Fstryker-bun-runner%2Fmain)](https://dashboard.stryker-mutator.io/reports/github.com/hughescr/stryker-bun-runner/main) [![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-3178c6?logo=typescript&logoColor=white)](https://www.typescriptlang.org)
11
6
 
12
7
  ## Features
13
8
 
@@ -20,17 +15,21 @@ Stryker test runner plugin for Bun with perTest coverage support.
20
15
 
21
16
  ### Bun Version
22
17
 
23
- This plugin currently requires **bun-25986** (a pre-release build with [oven-sh/bun#25986](https://github.com/oven-sh/bun/pull/25986)) for full functionality. This PR fixes the TestReporter WebSocket events that enable proper test-to-mutant correlation.
18
+ This plugin requires **Bun 1.3.7 or later** for full functionality. Bun 1.3.7 includes the TestReporter WebSocket events (from [PR #25986](https://github.com/oven-sh/bun/pull/25986)) that enable proper test-to-mutant correlation.
19
+
20
+ **Important:** Bun versions prior to 1.3.7 will NOT work with this plugin due to missing TestReporter events.
24
21
 
25
- **To install bun-25986:**
22
+ **To install Bun 1.3.7 or later:**
26
23
 
27
24
  ```bash
28
- bunx bun-pr 25986
25
+ bun upgrade
29
26
  ```
30
27
 
31
- **Important:** You must also configure Stryker to use `bun-25986` by setting `bunPath` in your config (see Configuration section below).
28
+ Or install a specific version:
32
29
 
33
- Once PR 25986 is merged into a stable Bun release, the default `bunPath` of `bun` will work and you can remove the `bunPath` setting entirely.
30
+ ```bash
31
+ curl -fsSL https://bun.sh/install | bash -s "bun-v1.3.7"
32
+ ```
34
33
 
35
34
  ### Other Requirements
36
35
 
@@ -52,7 +51,7 @@ export default {
52
51
  coverageAnalysis: 'perTest',
53
52
  mutate: ['src/**/*.ts'],
54
53
  bun: {
55
- bunPath: 'bun-25986', // Use bun-25986 until PR #25986 is merged (then use 'bun')
54
+ // bunPath defaults to 'bun' - only set if using a custom Bun installation
56
55
  inspectorTimeout: 5000, // Inspector connection timeout in ms (default: 5000)
57
56
  },
58
57
  };
@@ -83,7 +82,7 @@ This approach provides reliable test-to-mutant correlation, even with multiple t
83
82
 
84
83
  ```javascript
85
84
  bun: {
86
- bunPath: 'bun-25986', // Custom bun executable
85
+ bunPath: '/path/to/bun', // Custom bun executable (defaults to 'bun')
87
86
  timeout: 30000, // 30 second test timeout
88
87
  inspectorTimeout: 10000, // 10 second connection timeout
89
88
  env: { DEBUG: 'true' }, // Extra environment variables
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hughescr/stryker-bun-runner",
3
- "version": "1.0.0-beta1",
3
+ "version": "1.0.0",
4
4
  "description": "Stryker test runner plugin for Bun with perTest coverage support",
5
5
  "keywords": [
6
6
  "stryker",
@@ -61,6 +61,6 @@
61
61
  "@stryker-mutator/core": "^9.0.0"
62
62
  },
63
63
  "engines": {
64
- "bun": ">1.3.6"
64
+ "bun": ">=1.3.7"
65
65
  }
66
66
  }