@flakiness/sdk 2.2.2 → 2.3.1

package/README.md

@@ -10,6 +10,8 @@ The Flakiness SDK provides a comprehensive set of tools for creating and managin
 npm i @flakiness/sdk @flakiness/flakiness-report
 ```
 
+Requires Node.js 22+.
+
 ## Quick Start
 
 Here's a minimal example of creating a Flakiness JSON Report:
@@ -96,6 +98,7 @@ Use this entry point when you need to process or manipulate reports in browser-b
 ### Working with Reports
 - **`readReport()`** - Read a Flakiness report and its attachments from disk
 - **`showReport()`** - Start a local server and open the report in your browser
+- **`showReportCommand()`** - Build a shell command for opening the report later with the Flakiness CLI
 - **`uploadReport()`** - Upload reports and attachments to Flakiness.io
 - **`writeReport()`** - Write reports to disk in the standard Flakiness report format
 
@@ -125,4 +128,3 @@ Use this entry point when you need to process or manipulate reports in browser-b
    ```
 
 If neither method is available, the upload is skipped with a `'skipped'` status.
-

package/lib/browser.js

@@ -13,7 +13,7 @@ __export(reportUtilsBrowser_exports, {
   visitTests: () => visitTests
 });
 
-// node_modules/.pnpm/@flakiness+flakiness-report@0.27.0_zod@4.3.5/node_modules/@flakiness/flakiness-report/lib/flakinessReport.js
+// node_modules/.pnpm/@flakiness+flakiness-report@0.28.0_zod@4.3.5/node_modules/@flakiness/flakiness-report/lib/flakinessReport.js
 var FlakinessReport;
 ((FlakinessReport22) => {
   FlakinessReport22.CATEGORY_PLAYWRIGHT = "playwright";
@@ -23,7 +23,7 @@ var FlakinessReport;
   FlakinessReport22.STREAM_STDERR = 2;
 })(FlakinessReport || (FlakinessReport = {}));
 
-// node_modules/.pnpm/@flakiness+flakiness-report@0.27.0_zod@4.3.5/node_modules/@flakiness/flakiness-report/lib/schema.js
+// node_modules/.pnpm/@flakiness+flakiness-report@0.28.0_zod@4.3.5/node_modules/@flakiness/flakiness-report/lib/schema.js
 import z from "zod/v4";
 var Schema;
 ((Schema2) => {
@@ -138,8 +138,15 @@ var Schema;
     samples: z.array(Schema2.SystemUtilizationSample)
   });
   Schema2.UtilizationTelemetry = z.tuple([Schema2.DurationMS, z.number().min(0).max(100)]);
+  Schema2.Source = z.object({
+    filePath: Schema2.GitFilePath,
+    text: z.string(),
+    lineOffset: z.number().optional(),
+    contentType: z.string().optional()
+  });
   Schema2.FlakinessProject = z.string();
   Schema2.Report = z.object({
+    sources: z.array(Schema2.Source).optional(),
     flakinessProject: Schema2.FlakinessProject.optional(),
     category: z.string().min(1).max(100),
     commitId: Schema2.CommitId,

package/lib/index.js

@@ -679,7 +679,7 @@ function createEnvironment(options) {
   };
 }
 
-// node_modules/.pnpm/@flakiness+flakiness-report@0.27.0_zod@4.3.5/node_modules/@flakiness/flakiness-report/lib/flakinessReport.js
+// node_modules/.pnpm/@flakiness+flakiness-report@0.28.0_zod@4.3.5/node_modules/@flakiness/flakiness-report/lib/flakinessReport.js
 var FlakinessReport;
 ((FlakinessReport22) => {
   FlakinessReport22.CATEGORY_PLAYWRIGHT = "playwright";
@@ -689,7 +689,7 @@ var FlakinessReport;
   FlakinessReport22.STREAM_STDERR = 2;
 })(FlakinessReport || (FlakinessReport = {}));
 
-// node_modules/.pnpm/@flakiness+flakiness-report@0.27.0_zod@4.3.5/node_modules/@flakiness/flakiness-report/lib/schema.js
+// node_modules/.pnpm/@flakiness+flakiness-report@0.28.0_zod@4.3.5/node_modules/@flakiness/flakiness-report/lib/schema.js
 import z from "zod/v4";
 var Schema;
 ((Schema2) => {
@@ -804,8 +804,15 @@ var Schema;
     samples: z.array(Schema2.SystemUtilizationSample)
   });
   Schema2.UtilizationTelemetry = z.tuple([Schema2.DurationMS, z.number().min(0).max(100)]);
+  Schema2.Source = z.object({
+    filePath: Schema2.GitFilePath,
+    text: z.string(),
+    lineOffset: z.number().optional(),
+    contentType: z.string().optional()
+  });
   Schema2.FlakinessProject = z.string();
   Schema2.Report = z.object({
+    sources: z.array(Schema2.Source).optional(),
     flakinessProject: Schema2.FlakinessProject.optional(),
     category: z.string().min(1).max(100),
     commitId: Schema2.CommitId,
@@ -1279,7 +1286,7 @@ async function listFilesRecursively(dir, result = []) {
 }
 
 // src/showReport.ts
-import chalk from "chalk";
+import { styleText } from "node:util";
 import open from "open";
 
 // src/staticServer.ts
@@ -1442,7 +1449,7 @@ async function showReport(reportFolder, options) {
   const url = new URL(reportViewerUrl);
   url.searchParams.set("port", String(server.port()));
   url.searchParams.set("token", token);
-  console.log(chalk.cyan(`
+  console.log(styleText("cyan", `
   Serving Flakiness report at ${url.toString()}
   Press Ctrl+C to quit.`));
   await open(url.toString());
@@ -1450,24 +1457,123 @@ async function showReport(reportFolder, options) {
   });
 }
 
+// src/showReportCommand.ts
+import fs7 from "node:fs";
+import path3 from "node:path";
+import which from "which";
+var DEFAULT_REPORT_FOLDER = "flakiness-report";
+var FLAKINESS_CLI_COMMANDS = {
+  GLOBAL: "flakiness",
+  PNPM: "pnpm dlx flakiness",
+  NPM: "npx flakiness"
+};
+function showReportCommand(reportFolder) {
+  const userCwd = path3.resolve(process.env.INIT_CWD || process.cwd());
+  const flakinessCLI = detectFlakinessCLIFromEnv() ?? detectFlakinessCLIFromFilesystem(userCwd) ?? detectFlakinessCLIFromPath() ?? FLAKINESS_CLI_COMMANDS.NPM;
+  const absoluteReportFolder = path3.resolve(reportFolder);
+  const reportFolderArg = formatReportFolderArg(absoluteReportFolder, userCwd);
+  return `${flakinessCLI} show${reportFolderArg ? ` ${reportFolderArg}` : ""}`;
+}
+function detectFlakinessCLIFromEnv() {
+  const userAgent = process.env.npm_config_user_agent ?? "";
+  if (userAgent.startsWith("pnpm/"))
+    return FLAKINESS_CLI_COMMANDS.PNPM;
+  if (userAgent.startsWith("npm/"))
+    return FLAKINESS_CLI_COMMANDS.NPM;
+  const execPath = process.env.npm_execpath ?? "";
+  const execName = execPath ? path3.basename(execPath).toLowerCase() : "";
+  if (execName.startsWith("pnpm"))
+    return FLAKINESS_CLI_COMMANDS.PNPM;
+  return void 0;
+}
+function detectFlakinessCLIFromFilesystem(userCwd) {
+  for (const dir of ancestorDirectories(userCwd)) {
+    const packageManager = parsePackageJSON(dir);
+    if (packageManager === "pnpm")
+      return FLAKINESS_CLI_COMMANDS.PNPM;
+    if (packageManager === "npm" || packageManager === "other")
+      return FLAKINESS_CLI_COMMANDS.NPM;
+    if (fs7.existsSync(path3.join(dir, "pnpm-lock.yaml")))
+      return FLAKINESS_CLI_COMMANDS.PNPM;
+    if (fs7.existsSync(path3.join(dir, "pnpm-workspace.yaml")))
+      return FLAKINESS_CLI_COMMANDS.PNPM;
+  }
+  return void 0;
+}
+function detectFlakinessCLIFromPath() {
+  if (which.sync("flakiness", { nothrow: true }))
+    return FLAKINESS_CLI_COMMANDS.GLOBAL;
+  if (which.sync("npx", { nothrow: true }))
+    return FLAKINESS_CLI_COMMANDS.NPM;
+  if (which.sync("pnpm", { nothrow: true }))
+    return FLAKINESS_CLI_COMMANDS.PNPM;
+  return void 0;
+}
+function parsePackageJSON(dir) {
+  const packageJsonPath = path3.join(dir, "package.json");
+  if (!fs7.existsSync(packageJsonPath))
+    return void 0;
+  try {
+    const packageJson = JSON.parse(fs7.readFileSync(packageJsonPath, "utf8"));
+    if (typeof packageJson.packageManager !== "string")
+      return void 0;
+    if (packageJson.packageManager.startsWith("pnpm@"))
+      return "pnpm";
+    if (packageJson.packageManager.startsWith("npm@"))
+      return "npm";
+    return "other";
+  } catch {
+    return void 0;
+  }
+}
+function ancestorDirectories(startDir) {
+  const directories = [];
+  let current = path3.resolve(startDir);
+  while (true) {
+    directories.push(current);
+    const parent = path3.dirname(current);
+    if (parent === current)
+      return directories;
+    current = parent;
+  }
+}
+function formatReportFolderArg(reportFolder, userCwd) {
+  if (isSamePath(reportFolder, path3.resolve(userCwd, DEFAULT_REPORT_FOLDER)))
+    return "";
+  const relativePath = path3.relative(userCwd, reportFolder) || ".";
+  return quoteShellArgument(relativePath);
+}
+function isSamePath(left, right) {
+  const normalizedLeft = path3.resolve(left);
+  const normalizedRight = path3.resolve(right);
+  if (process.platform === "win32")
+    return normalizedLeft.toLowerCase() === normalizedRight.toLowerCase();
+  return normalizedLeft === normalizedRight;
+}
+function quoteShellArgument(argument) {
+  if (/^[A-Za-z0-9_./:@%+=,-]+$/u.test(argument))
+    return argument;
+  return JSON.stringify(argument);
+}
+
 // src/writeReport.ts
-import fs7 from "fs";
-import path3 from "path";
+import fs8 from "fs";
+import path4 from "path";
 async function writeReport(report, attachments, outputFolder) {
-  const reportPath = path3.join(outputFolder, "report.json");
-  const attachmentsFolder = path3.join(outputFolder, "attachments");
-  await fs7.promises.rm(outputFolder, { recursive: true, force: true });
-  await fs7.promises.mkdir(outputFolder, { recursive: true });
-  await fs7.promises.writeFile(reportPath, JSON.stringify(report), "utf-8");
+  const reportPath = path4.join(outputFolder, "report.json");
+  const attachmentsFolder = path4.join(outputFolder, "attachments");
+  await fs8.promises.rm(outputFolder, { recursive: true, force: true });
+  await fs8.promises.mkdir(outputFolder, { recursive: true });
+  await fs8.promises.writeFile(reportPath, JSON.stringify(report), "utf-8");
   if (attachments.length)
-    await fs7.promises.mkdir(attachmentsFolder);
+    await fs8.promises.mkdir(attachmentsFolder);
   const movedAttachments = [];
   for (const attachment of attachments) {
-    const attachmentPath = path3.join(attachmentsFolder, attachment.id);
+    const attachmentPath = path4.join(attachmentsFolder, attachment.id);
     if (attachment.type === "file")
-      await fs7.promises.cp(attachment.path, attachmentPath);
+      await fs8.promises.cp(attachment.path, attachmentPath);
     else if (attachment.type === "buffer")
-      await fs7.promises.writeFile(attachmentPath, attachment.body);
+      await fs8.promises.writeFile(attachmentPath, attachment.body);
     movedAttachments.push({
       type: "file",
       contentType: attachment.contentType,
@@ -1486,6 +1592,7 @@ export {
   reportUtils_exports as ReportUtils,
   readReport,
   showReport,
+  showReportCommand,
   uploadReport,
   writeReport
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flakiness/sdk",
-  "version": "2.2.2",
+  "version": "2.3.1",
   "private": false,
   "repository": {
     "type": "git",
@@ -24,12 +24,16 @@
   "keywords": [],
   "author": "Degu Labs, Inc",
   "license": "MIT",
+  "engines": {
+    "node": ">=22"
+  },
   "devDependencies": {
-    "@flakiness/flakiness-report": "^0.27.0",
-    "@flakiness/playwright": "^1.3.2",
+    "@flakiness/flakiness-report": "^0.28.0",
+    "@flakiness/playwright": "^1.3.3",
     "@playwright/test": "^1.58.2",
     "@types/debug": "^4.1.12",
     "@types/node": "^25.0.3",
+    "@types/which": "^3.0.4",
     "esbuild": "^0.27.0",
     "kubik": "^0.24.0",
     "tsx": "^4.21.0",
@@ -39,14 +43,16 @@
     "@flakiness/flakiness-report": ">=0.26.0 <1.0.0"
   },
   "dependencies": {
-    "chalk": "^5.6.2",
     "debug": "^4.4.3",
     "open": "^10.2.0",
     "stable-hash": "^0.0.6",
+    "which": "^6.0.1",
     "zod": "^4.3.5"
   },
   "scripts": {
     "minor": "./version.mjs minor",
-    "patch": "./version.mjs patch"
+    "patch": "./version.mjs patch",
+    "test": "pnpm playwright test",
+    "build": "kubik ./build.mts"
   }
 }

package/types/src/index.d.ts

@@ -6,6 +6,7 @@ export { GithubOIDC } from './githubOIDC.js';
 export * as ReportUtils from './reportUtils.js';
 export { readReport } from './readReport.js';
 export { showReport } from './showReport.js';
+export { showReportCommand } from './showReportCommand.js';
 export { uploadReport } from './uploadReport.js';
 export { writeReport } from './writeReport.js';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAC;AAGhD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAC;AAGhD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC"}

package/types/src/showReportCommand.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Builds a command that opens a Flakiness report with the Flakiness CLI.
+ *
+ * The command is tailored for the shell directory from which the current process
+ * was originally invoked. This matters when package managers like pnpm change the
+ * working directory while running scripts.
+ *
+ * @param {string} reportFolder - Absolute or relative path to the report folder.
+ *
+ * @returns {string} A shell command such as `pnpm dlx flakiness show`.
+ *
+ * @example
+ * ```typescript
+ * const command = showReportCommand('./flakiness-report');
+ * // Returns: "npx flakiness show"
+ * ```
+ */
+export declare function showReportCommand(reportFolder: string): string;
+//# sourceMappingURL=showReportCommand.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"showReportCommand.d.ts","sourceRoot":"","sources":["../../src/showReportCommand.ts"],"names":[],"mappings":"AAcA;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,iBAAiB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAM9D"}

package/types/src/stripAnsi.d.ts

@@ -11,7 +11,9 @@
  *
  * @example
  * ```typescript
- * const clean = stripAnsi(chalk.red('Error: test failed'));
+ * import { styleText } from 'node:util';
+ *
+ * const clean = stripAnsi(styleText('red', 'Error: test failed'));
  * // Returns: 'Error: test failed' (without color codes)
  * ```
  */

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

@@ -1 +1 @@
-{"version":3,"file":"stripAnsi.d.ts","sourceRoot":"","sources":["../../src/stripAnsi.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE7C"}
+{"version":3,"file":"stripAnsi.d.ts","sourceRoot":"","sources":["../../src/stripAnsi.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE7C"}