@flakiness/vitest 1.2.1 → 1.4.0

package/README.md

@@ -17,6 +17,7 @@ A custom Vitest reporter that generates Flakiness Reports from your Vitest test
   - [Environment Detection](#environment-detection)
   - [CI Integration](#ci-integration)
 - [Configuration Options](#configuration-options)
+  - [`title?: string`](#title-string)
   - [`flakinessProject?: string`](#flakinessproject-string)
   - [`endpoint?: string`](#endpoint-string)
   - [`token?: string`](#token-string)
@@ -160,6 +161,16 @@ The reporter automatically detects CI environments and includes:
 
 The reporter accepts the following options:
 
+### `title?: string`
+
+Optional human-readable report title. Typically used to name a CI run, matrix shard, or other execution group. Defaults to the `FLAKINESS_TITLE` environment variable, or auto-detects from the CI environment.
+
+```typescript
+reporters: [
+  ['@flakiness/vitest', { title: 'Shard 1/4 — Linux Chrome' }]
+]
+```
+
 ### `flakinessProject?: string`
 
 The Flakiness.io project identifier in `org/project` format. Used for GitHub OIDC authentication — when set, and the Flakiness.io project is bound to the GitHub repository running the workflow, the reporter authenticates uploads via GitHub Actions OIDC token with no access token required.
@@ -235,6 +246,7 @@ reporters: [
 
 The reporter respects the following environment variables:
 
+- **`FLAKINESS_TITLE`**: Human-readable report title (equivalent to `title` option)
 - **`FLAKINESS_ACCESS_TOKEN`**: Access token for Flakiness.io uploads (equivalent to `token` option)
 - **`FLAKINESS_ENDPOINT`**: Custom Flakiness.io endpoint URL (equivalent to `endpoint` option)
 - **`FLAKINESS_OUTPUT_DIR`**: Output directory for reports (equivalent to `outputFolder` option)
@@ -253,6 +265,7 @@ export default defineConfig({
     reporters: [
       'default',
       ['@flakiness/vitest', {
+        title: 'My Test Run',
         flakinessProject: 'my-org/my-project',
         endpoint: process.env.FLAKINESS_ENDPOINT,
         token: process.env.FLAKINESS_ACCESS_TOKEN,

package/lib/reporter.js

@@ -1,9 +1,10 @@
 import { FlakinessReport as FK } from "@flakiness/flakiness-report";
-import { CIUtils, CPUUtilization, GitWorktree, RAMUtilization, ReportUtils, uploadReport, writeReport } from "@flakiness/sdk";
-import chalk from "chalk";
+import { CIUtils, CPUUtilization, GitWorktree, RAMUtilization, ReportUtils, showReportCommand, uploadReport, writeReport } from "@flakiness/sdk";
 import crypto from "crypto";
 import assert from "node:assert";
 import path from "node:path";
+import * as nodeUtil from "node:util";
+const styleText = (format, text) => nodeUtil.styleText?.(format, text) ?? text;
 class FKVitestReporter {
   constructor(_options) {
     this._options = _options;
@@ -11,8 +12,8 @@ class FKVitestReporter {
   _impl;
   _vitest;
   _logger = {
-    warn: (txt) => console.warn(chalk.yellow(txt)),
-    error: (txt) => console.error(chalk.red(txt)),
+    warn: (txt) => console.warn(styleText("yellow", txt)),
+    error: (txt) => console.error(styleText("red", txt)),
     log: (txt) => console.log(txt)
   };
   setLoggerForTest(logger) {
@@ -320,7 +321,9 @@ class ReporterImpl {
       }
     }
     const duration = Date.now() - this._startTimestamp;
+    const title = this._options.title ?? process.env.FLAKINESS_TITLE ?? CIUtils.runTitle();
     const report = ReportUtils.normalizeReport({
+      title,
       url: CIUtils.runUrl(),
       flakinessProject: this._options.flakinessProject,
       category: "vitest",
@@ -355,12 +358,11 @@ class ReporterImpl {
         logger: this._logger
       });
     }
-    const defaultOutputFolder = path.join(process.cwd(), "flakiness-report");
-    const folder = defaultOutputFolder === outputFolder ? "" : path.relative(process.cwd(), outputFolder);
+    const command = showReportCommand(outputFolder);
     this._logger.log(`
 To open last Flakiness report, run:
 
-  ${chalk.cyan(`npx flakiness show ${folder}`)}
+  ${styleText("cyan", command)}
     `);
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flakiness/vitest",
-  "version": "1.2.1",
+  "version": "1.4.0",
   "description": "",
   "main": "lib/reporter.js",
   "keywords": [],
@@ -22,9 +22,8 @@
     "vitest": "^4.0.18"
   },
   "dependencies": {
-    "@flakiness/flakiness-report": "^0.28.0",
-    "@flakiness/sdk": "^2.2.2",
-    "chalk": "^5.6.2"
+    "@flakiness/flakiness-report": "^0.29.0",
+    "@flakiness/sdk": "^2.5.0"
   },
   "scripts": {
     "build": "kubik build.mts",

package/types/src/reporter.d.ts

@@ -16,6 +16,7 @@ export type FKVitestReporterOptions = {
     token?: string;
     outputFolder?: string;
     duplicates?: 'fail' | 'rename';
+    title?: string;
 };
 export interface FKVitestLogger {
     log(txt: string): void;

package/types/src/reporter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reporter.d.ts","sourceRoot":"","sources":["../../src/reporter.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,eAAe,EAAY,UAAU,EAAe,gBAAgB,EAAa,MAAM,EAAE,MAAM,aAAa,CAAC;AAC3H,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAIjD,UAAU,cAAc;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,IAAI,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,GAAC,QAAQ,CAAC;CAC9B,CAAA;AAED,MAAM,WAAW,cAAc;IAC7B,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,CAAC,OAAO,OAAO,gBAAiB,YAAW,QAAQ;IAS3C,OAAO,CAAC,QAAQ;IAR5B,OAAO,CAAC,KAAK,CAAC,CAAe;IAC7B,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,OAAO,CAAC,OAAO,CAId;gBAEmB,QAAQ,EAAE,uBAAuB;IAGrD,gBAAgB,CAAC,MAAM,EAAE,cAAc;IAIjC,gBAAgB,CAAC,GAAG,EAAE,cAAc;IAI1C,MAAM,CAAC,MAAM,EAAE,MAAM;IAIrB,cAAc;IAOR,YAAY,CAAC,WAAW,EAAE,aAAa,CAAC,UAAU,CAAC,EAAE,eAAe,EAAE,aAAa,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,gBAAgB;CAIrI"}
+{"version":3,"file":"reporter.d.ts","sourceRoot":"","sources":["../../src/reporter.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,eAAe,EAAY,UAAU,EAAe,gBAAgB,EAAa,MAAM,EAAE,MAAM,aAAa,CAAC;AAC3H,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAIjD,UAAU,cAAc;IACtB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,IAAI,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,GAAC,QAAQ,CAAC;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAA;AAED,MAAM,WAAW,cAAc;IAC7B,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAMD,MAAM,CAAC,OAAO,OAAO,gBAAiB,YAAW,QAAQ;IAS3C,OAAO,CAAC,QAAQ;IAR5B,OAAO,CAAC,KAAK,CAAC,CAAe;IAC7B,OAAO,CAAC,OAAO,CAAC,CAAS;IACzB,OAAO,CAAC,OAAO,CAId;gBAEmB,QAAQ,EAAE,uBAAuB;IAGrD,gBAAgB,CAAC,MAAM,EAAE,cAAc;IAIjC,gBAAgB,CAAC,GAAG,EAAE,cAAc;IAI1C,MAAM,CAAC,MAAM,EAAE,MAAM;IAIrB,cAAc;IAOR,YAAY,CAAC,WAAW,EAAE,aAAa,CAAC,UAAU,CAAC,EAAE,eAAe,EAAE,aAAa,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,gBAAgB;CAIrI"}