Merge pull request #12 from dennisbergevin/dennis/fix-format

chore: Fix formatting and add new workflow job

Author: dennisbergevin

Diff for: .github/workflows/main.yml

@@ -7,7 +7,7 @@ on:
   workflow_dispatch:
 
 jobs:
-  node-script:
+  default-test-results:
     runs-on: ubuntu-22.04
     steps:
       - name: Checkout 📦
@@ -19,10 +19,31 @@ jobs:
         if: always()
         run: |
           cat ./test-results/last-run.json
-      - name: Custom tests 🧪
+      - name: Run failed tests from default directory 🧪
         if: always()
         uses: cypress-io/github-action@v6
         with:
           # environment variable used for CI/CD tests in this repo
           command: npx cypress-plugin-last-failed run --env shouldPass=true
           working-directory: ${{ github.workspace }}
+  custom-test-results:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout 📦
+        uses: actions/checkout@v4
+      - name: Cypress run - store failed tests in custom directory 👟
+        uses: cypress-io/github-action@v6
+        with:
+          command: npm run custom-dir-run
+          working-directory: ${{ github.workspace }}
+        continue-on-error: true
+      - name: Output the file contents 📝
+        if: always()
+        run: |
+          cat ./cypress/config/test-results/last-run.json
+      - name: Run failed tests from custom directory 🧪
+        if: always()
+        uses: cypress-io/github-action@v6
+        with:
+          command: npm run custom-dir-last-failed
+          working-directory: ${{ github.workspace }}

Diff for: README.md

@@ -19,9 +19,10 @@ A companion Cypress plugin for <code>cy-grep</code> that re-runs the last failed
 #### Table of Contents
 
 - [Features](#features)
-    - [Table of Contents](#table-of-contents)
+  - [Table of Contents](#table-of-contents)
 - [📦 Installation](#-installation)
 - [👟 Run mode](#-run-mode)
+  - [Specify a custom test-results directory](#specify-a-custom-test-results-directory)
   - [Add rule to gitignore](#add-rule-to-gitignore)
   - [📃 Setting up a `npm` script](#-setting-up-a-npm-script)
 - [⌛ Open mode](#-open-mode)
@@ -45,9 +46,9 @@ npm install --save-dev cypress-plugin-last-failed
 2. In `cypress/support/e2e.js` (For E2E tests) and/or `cypress/support/component.js` (For Component tests),
 
 ```js
-import { failedTestToggle } from "cypress-plugin-last-failed";
+import { failedTestToggle } from 'cypress-plugin-last-failed';
 
-const registerCypressGrep = require("@bahmutov/cy-grep");
+const registerCypressGrep = require('@bahmutov/cy-grep');
 registerCypressGrep();
 
 failedTestToggle();
@@ -56,8 +57,8 @@ failedTestToggle();
 3. In `cypress.config`, include the following within `setupNodeEvents` for `e2e` and/or `component` testing:
 
 ```js
-const { defineConfig } = require("cypress");
-const { collectFailingTests } = require("cypress-plugin-last-failed");
+const { defineConfig } = require('cypress');
+const { collectFailingTests } = require('cypress-plugin-last-failed');
 
 module.exports = defineConfig({
   screenshotOnRunFailure: false,
@@ -69,15 +70,15 @@ module.exports = defineConfig({
     setupNodeEvents(on, config) {
       collectFailingTests(on, config);
 
-      require("@bahmutov/cy-grep/src/plugin")(config);
+      require('@bahmutov/cy-grep/src/plugin')(config);
       return config;
     },
   },
   component: {
     setupNodeEvents(on, config) {
       collectFailingTests(on, config);
 
-      require("@bahmutov/cy-grep/src/plugin")(config);
+      require('@bahmutov/cy-grep/src/plugin')(config);
       return config;
     },
   },
@@ -108,6 +109,8 @@ You can also include more cli arguments similar to `cypress run`, as the command
 npx cypress-plugin-last-failed run --e2e --browser chrome
 ```
 
+### Specify a custom test-results directory
+
 There will be a folder called test-results created in the directory of the cypress.config. If you would like to specify a different folder for test results, use the LAST_FAILED_RESULTS_PATH environment variable:
 
 ```bash
@@ -171,7 +174,7 @@ Normally, any Cypress test or suite of tests marked with a `.skip` will be shown
 Since this plugin uses `@bahmutov/cy-grep` plugin, we can instead designate skipped tests using a **required tag**:
 
 ```js
-it("deletes an item", { requiredTags: "@skip" }, () => {
+it('deletes an item', { requiredTags: '@skip' }, () => {
   expect(1).to.equal(2);
 });
 ```
@@ -195,7 +198,7 @@ name: test-last-failed-node-script
 on:
   push:
     branches:
-      - "main"
+      - 'main'
   pull_request:
   workflow_dispatch:
 

Diff for: cypress/config/cypress.config.js

@@ -1,5 +1,5 @@
-const { defineConfig } = require("cypress");
-const { collectFailingTests } = require("../../src/index");
+const { defineConfig } = require('cypress');
+const { collectFailingTests } = require('../../src/index');
 
 module.exports = defineConfig({
   env: {
@@ -9,15 +9,15 @@ module.exports = defineConfig({
   screenshotOnRunFailure: false,
   e2e: {
     setupNodeEvents(on, config) {
-      require("@bahmutov/cy-grep/src/plugin")(config);
+      require('@bahmutov/cy-grep/src/plugin')(config);
       collectFailingTests(on, config);
 
       return config;
     },
   },
   component: {
     setupNodeEvents(on, config) {
-      require("@bahmutov/cy-grep/src/plugin")(config);
+      require('@bahmutov/cy-grep/src/plugin')(config);
       collectFailingTests(on, config);
 
       return config;

Diff for: package-lock.json

@@ -1,11 +1,13 @@
 {
   "name": "cypress-plugin-last-failed",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "Cypress plugin to rerun last failed tests in cypress run and open mode",
   "main": "./src/index.js",
   "types": "./src/index.d.ts",
   "scripts": {
-    "last-failed": "npx cypress-plugin-last-failed run --e2e --browser electron"
+    "last-failed": "npx cypress-plugin-last-failed run --e2e --browser electron",
+    "custom-dir-run": "LAST_FAILED_RESULTS_PATH=cypress/config npx cypress run",
+    "custom-dir-last-failed": "LAST_FAILED_RESULTS_PATH=cypress/config npx cypress-plugin-last-failed run --env shouldPass=true"
   },
   "bin": {
     "cypress-plugin-last-failed": "runFailed.js"

Diff for: package.json

@@ -1,9 +1,9 @@
 #!/usr/bin/env node
 
-const cypress = require("cypress");
-const fs = require("fs");
-const path = require("path");
-const appDir = process.env.INIT_CWD ? process.env.INIT_CWD : path.resolve(".");
+const cypress = require('cypress');
+const fs = require('fs');
+const path = require('path');
+const appDir = process.env.INIT_CWD ? process.env.INIT_CWD : path.resolve('.');
 
 async function runLastFailed() {
   const noFailedTestsMessage = `No previous failed tests detected
@@ -14,14 +14,14 @@ Try running tests again with cypress run`;
     ? path.join(
         appDir,
         process.env.LAST_FAILED_RESULTS_PATH,
-        "test-results",
-        "last-run.json"
+        'test-results',
+        'last-run.json'
       )
-    : path.join(appDir, "test-results", "last-run.json");
+    : path.join(appDir, 'test-results', 'last-run.json');
 
   if (fs.existsSync(failedTestFilePath)) {
     // Retrieve the failedTests from the file
-    const failedTests = await fs.promises.readFile(failedTestFilePath, "utf8");
+    const failedTests = await fs.promises.readFile(failedTestFilePath, 'utf8');
 
     // Retrieve the parent suite and tests in the results from test-results/last-run
     const parentAndTest = JSON.parse(failedTests).map(({ parent, test }) => ({
@@ -31,13 +31,13 @@ Try running tests again with cypress run`;
     // Combine parent suite and test together
     const resultSet = new Set(
       Object.values(parentAndTest).flatMap(
-        (parent) => parent.parent + "," + parent.test + ";"
+        (parent) => parent.parent + ',' + parent.test + ';'
       )
     );
     // Format string for use in grep functionality
     const stringedTests = Array.from(resultSet)
       .toString()
-      .replaceAll(",", " ")
+      .replaceAll(',', ' ')
       .slice(0, -1);
 
     if (stringedTests.length > 0) {

Diff for: runFailed.js

@@ -1,5 +1,5 @@
 // index.d.ts
-declare module "cypress-plugin-last-failed" {
+declare module 'cypress-plugin-last-failed' {
   /**
    * Collects failed tests from the most recent Cypress test run.
    *

Diff for: src/index.d.ts

@@ -1,6 +1,6 @@
-const fs = require("fs");
-const path = require("path");
-const failedTestToggle = require("./toggle");
+const fs = require('fs');
+const path = require('path');
+const failedTestToggle = require('./toggle');
 
 /**
  * Collects failed tests from the most recent Cypress test run
@@ -15,13 +15,13 @@ const failedTestToggle = require("./toggle");
  * @returns
  */
 const collectFailingTests = (on, config) => {
-  on("after:run", async (results) => {
+  on('after:run', async (results) => {
     let failedTests = [];
 
     for (const run of results.runs) {
       if (run.tests && run.spec) {
         const tests = run.tests
-          .filter((test) => test.state === "failed")
+          .filter((test) => test.state === 'failed')
           .map((test) => test.title);
 
         const spec = run.spec.relative;
@@ -35,13 +35,13 @@ const collectFailingTests = (on, config) => {
       ? path.join(
           process.env.INIT_CWD,
           process.env.LAST_FAILED_RESULTS_PATH,
-          "test-results"
+          'test-results'
         )
       : `${path.dirname(config.configFile)}/test-results/`;
 
     // Create the directory and last-run file where failed tests will be written to
     await fs.promises.mkdir(failedTestFilePath, { recursive: true });
-    const lastRunReportFile = path.join(failedTestFilePath, "last-run.json");
+    const lastRunReportFile = path.join(failedTestFilePath, 'last-run.json');
     await fs.promises.writeFile(lastRunReportFile, JSON.stringify(failedTests));
   });