cypress-rerun-failed-specs-sid-g 1.0.7

package/README.md

@@ -0,0 +1,167 @@
+# ⭐ cypress-rerun-failed-specs-sid-g
+
+A Cypress plugin and CLI tool that automatically **reruns only failed spec files** from the previous Cypress run.  
+It helps reduce flaky failures, saves CI time, and avoids rerunning the entire test suite.
+
+---
+
+## ❓ What problem does this solve?
+
+In real-world Cypress projects:
+
+- Tests can be **flaky**
+- CI pipelines fail even when reruns would pass
+- Rerunning the **entire suite** is slow and expensive
+
+### ✅ This plugin solves that by:
+- Detecting **only failed spec files**
+- Rerunning **only those specs**
+- Optionally auto‑rerunning in CI (opt‑in, safe by default)
+
+---
+
+## 📦 Installation
+
+Install as a dev dependency:
+
+```bash
+npm install cypress-rerun-failed-specs-sid-g --save-dev
+```
+
+## JavaScript cypress.config.js
+
+```
+const rerunFailed = require("cypress-rerun-failed-specs-sid-g");
+
+module.exports = {
+  e2e: {
+    setupNodeEvents(on, config) {
+      rerunFailed(on, config);
+      return config;
+    }
+  }
+};
+```
+## TypeScript (cypress.config.ts)
+
+```
+import rerunFailed from "cypress-rerun-failed-specs-sid-g";
+import { defineConfig } from "cypress";
+
+export default defineConfig({
+  e2e: {
+    setupNodeEvents(on, config) {
+      rerunFailed(on, config);
+      return config;
+    }
+  }
+});
+```
+
+▶️ How to Use
+Step 1: Run Cypress normally
+```
+npx cypress run
+```
+If any specs fail, the plugin generates:
+```
+cypress/failed-specs.json
+```
+Step 2: Rerun only failed specs
+```
+npx cypress-rerun-failed
+```
+Only the failed spec files from the last run are executed.
+
+⚙️ CLI Commands & Options
+```
+npx cypress-rerun-failed [options]
+```
+Available Options
+Option	Description
+```
+--browser <name>	Run in a specific browser (chrome, firefox, edge)
+--headed	Run Cypress in headed (UI) mode
+--retries <number>	Retry failed specs N times
+--help	Show CLI help
+```
+Example Commands
+# Basic rerun
+```
+npx cypress-rerun-failed
+```
+# Run in Chrome
+```
+npx cypress-rerun-failed --browser chrome
+```
+# Headed mode
+```
+npx cypress-rerun-failed --headed
+```
+# Retry failed specs twice
+```
+npx cypress-rerun-failed --retries 2
+```
+# Combine options
+```
+npx cypress-rerun-failed --browser chrome --headed --retries 2
+```
+🔁 CI Usage (Optional & Safe)
+Auto‑rerun is disabled by default.
+
+Enable via environment variables
+macOS / Linux
+```
+export CYPRESS_RERUN_FAILED=true
+export CYPRESS_RERUN_MAX_ATTEMPTS=2
+```
+Windows (PowerShell)
+```
+$env:CYPRESS_RERUN_FAILED="true"
+$env:CYPRESS_RERUN_MAX_ATTEMPTS="2"
+```
+Example: GitHub Actions
+```
+env:
+  CYPRESS_RERUN_FAILED: "true"
+  CYPRESS_RERUN_MAX_ATTEMPTS: "2"
+```
+
+CI Behavior
+
+Initial Cypress run executes
+
+Failed specs are detected
+
+Only failed specs are rerun
+
+Stops after max retry attempts
+
+Proper exit codes for CI pipelines
+
+📂 Generated Files
+```
+cypress/results/*.json	Mochawesome JSON reports
+
+cypress/failed-specs.json	List of failed spec files
+```
+🛡️ Why this plugin is safe
+Auto‑rerun is opt‑in
+
+Max retry protection (no infinite loops)
+
+No network calls
+
+No postinstall scripts
+
+Cross‑platform (Windows / macOS / Linux)
+
+🧩 TypeScript Support
+TypeScript typings are included.
+
+import rerunFailed from "cypress-rerun-failed-specs-sid-g";
+📄 License
+MIT
+
+👤 Author
+Siddhant Gadakh

package/bin/cli.js

@@ -0,0 +1,89 @@
+#!/usr/bin/env node
+
+const { spawnSync } = require("child_process");
+const path = require("path");
+const fs = require("fs");
+const { getFailedSpecs } = require("../src");
+
+
+const args = process.argv.slice(2);
+
+function getArg(flag) {
+  const index = args.indexOf(flag);
+  return index !== -1 ? args[index + 1] : null;
+}
+
+
+if (args.includes("--help") || args.includes("-h")) {
+  console.log(`
+sid-cypress-rerun-failed
+
+Usage:
+  npx cypress-rerun-failed [options]
+
+Options:
+  --browser <name>     Run in specific browser (chrome, firefox, edge)
+  --headed             Run Cypress in headed mode
+  --retries <number>   Retry failed specs
+  --help, -h           Show this help message
+
+Examples:
+  npx cypress-rerun-failed
+  npx cypress-rerun-failed --browser chrome
+  npx cypress-rerun-failed --headed --retries 2
+`);
+  process.exit(0);
+}
+
+// --------------------
+// SUPPORTED FLAGS
+// --------------------
+const browser = getArg("--browser");
+const headed = args.includes("--headed");
+const retries = getArg("--retries");
+
+// --------------------
+// CONFIG
+// --------------------
+const REPORT_DIR = path.join(process.cwd(), "cypress", "results");
+
+try {
+  console.log("Searching for failed spec files...");
+
+  if (!fs.existsSync(REPORT_DIR)) {
+    throw new Error(`Report directory not found: ${REPORT_DIR}`);
+  }
+
+  const failedSpecs = getFailedSpecs(REPORT_DIR);
+
+  if (!failedSpecs.length) {
+    console.log("No failed spec files found");
+    process.exit(0);
+  }
+
+  console.log("Failed spec files:");
+  failedSpecs.forEach((spec) => console.log(` - ${spec}`));
+
+  const spawnArgs = [
+    "cypress",
+    "run",
+    "--spec",
+    failedSpecs.join(","),
+  ];
+
+  if (browser) spawnArgs.push("--browser", browser);
+  if (headed) spawnArgs.push("--headed");
+  if (retries) spawnArgs.push("--retries", retries);
+
+  console.log("Rerunning failed spec files...\n");
+
+  const result = spawnSync("npx", spawnArgs, {
+    stdio: "inherit",
+    shell: process.platform === "win32",
+  });
+
+  process.exit(result.status ?? 0);
+} catch (error) {
+  console.error("Error:", error.message);
+  process.exit(1);
+}

package/issues

@@ -0,0 +1 @@
+please tell me the issues or bug you find

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "cypress-rerun-failed-specs-sid-g",
+  "version": "1.0.7",
+  "description": "Rerun failed Cypress spec files from previous run",
+  "main": "src/index.js",
+  "types": "types/index.d.ts",
+  "bin": {
+    "cypress-rerun-failed": "bin/cli.js"
+  },
+  "keywords": [
+    "cypress",
+    "cypress-plugin",
+    "rerun",
+    "failed-specs",
+    "ci"
+  ],
+  "author": "Siddhant Arjun Gadakh",
+  "license": "MIT",
+  "engines": {
+    "node": ">=16"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SourceCode-code/sid-cypress-rerun-failed"
+  },
+  "bugs": {
+    "url": "https://github.com/SourceCode-code/sid-cypress-rerun-failed/issues"
+  },
+  "homepage": "https://github.com/SourceCode-code/sid-cypress-rerun-failed#readme"
+}

package/src/index.js

@@ -0,0 +1,89 @@
+const fs = require('fs');
+const path = require('path');
+
+function getFailedSpecs(reportDir) {
+  if (!fs.existsSync(reportDir)) {
+    throw new Error(`Report directory not found: ${reportDir}`);
+  }
+
+  const failedSpecs = new Set();
+  const files = fs.readdirSync(reportDir).filter(f => f.endsWith('.json'));
+
+  if (!files.length) {
+    throw new Error('No JSON report files found in report directory');
+  }
+
+  for (const file of files) {
+    const reportPath = path.join(reportDir, file);
+    let report;
+
+    try {
+      report = JSON.parse(fs.readFileSync(reportPath, 'utf8'));
+    } catch (err) {
+      console.warn(`Skipping invalid JSON report: ${file}`);
+      continue;
+    }
+
+    if (!report.results) continue;
+
+    for (const result of report.results) {
+      let hasFailure = false;
+
+      (function walkSuites(suites = []) {
+        for (const suite of suites) {
+          suite.tests?.forEach(test => {
+            if (test.state === 'failed') {
+              hasFailure = true;
+            }
+          });
+          walkSuites(suite.suites);
+        }
+      })(result.suites);
+
+      if (hasFailure && result.file) {
+        failedSpecs.add(result.file);
+      }
+    }
+  }
+
+  return Array.from(failedSpecs);
+}
+
+/**
+ * Cypress plugin entry point
+ */
+function cypressRerunFailed(on, config) {
+  console.log('cypress-rerun-failed initialized');
+
+  on('after:run', () => {
+    const reportDir = path.join(
+      config.projectRoot,
+      'cypress',
+      'results'
+    );
+
+    try {
+      const failedSpecs = getFailedSpecs(reportDir);
+
+      if (!failedSpecs.length) {
+        console.log('No failed specs found');
+        return;
+      }
+
+      const outputPath = path.join(
+        config.projectRoot,
+        'cypress',
+        'failed-specs.json'
+      );
+
+      fs.writeFileSync(outputPath, JSON.stringify(failedSpecs, null, 2));
+      console.log('Failed specs saved to:', outputPath);
+
+    } catch (err) {
+      console.warn('Failed spec detection skipped:', err.message);
+    }
+  });
+}
+
+module.exports = cypressRerunFailed;
+module.exports.getFailedSpecs = getFailedSpecs;

package/types/index.d.ts

@@ -0,0 +1,14 @@
+declare module "sid-cypress-rerun-failed" {
+  import { PluginEvents, PluginConfigOptions } from "cypress";
+
+  type CypressPlugin = (
+    on: PluginEvents,
+    config: PluginConfigOptions
+  ) => void;
+
+  const rerunFailed: CypressPlugin;
+
+  export function getFailedSpecs(reportDir: string): string[];
+
+  export default rerunFailed;
+}