Merge pull request #2 from dennisbergevin/dennis/fix-failedtestdir

fix: Refactoring logic for `failedTestDirectory` and updating README

Author: dennisbergevin

Diff for: .github/workflows/main.yml

@@ -24,5 +24,5 @@ jobs:
         uses: cypress-io/github-action@v6
         with:
           # environment variable used for CI/CD tests in this repo
-          command: npx cypress-last-failed run --env shouldPass=true
+          command: npx cypress-plugin-last-failed run --env shouldPass=true
           working-directory: ${{ github.workspace }}

Diff for: README.md

@@ -20,7 +20,6 @@ A companion Cypress plugin for <code>cy-grep</code> that re-runs the last failed
 
 - [Installation](#-installation)
 - [Run mode](#-run-mode)
-  - [Optional custom `failedTestDirectory`](#optional-custom-failedtestdirectory)
   - [Add rule to gitignore](#add-rule-to-gitignore)
   - [Setting up a `npm` script](#-setting-up-a-npm-script)
 - [Open mode](#-open-mode)
@@ -54,10 +53,12 @@ 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');
+
 module.exports = defineConfig({
   screenshotOnRunFailure: false,
   env: {
-    failedTestDirectory: './',
     grepOmitFiltered: true,
     grepFilterSpecs: true,
   },
@@ -94,34 +95,17 @@ npx cypress run
 2. If there are failed tests, run the following command from the **directory of the project's `cypress.config`**:
 
 ```bash
-npx cypress-last-failed run
+npx cypress-plugin-last-failed run
 ```
 
 You can also include more cli arguments similar to `cypress run`, as the command harnesses the power of [Cypress module API](https://docs.cypress.io/guides/guides/module-api):
 
 ```bash
 # Example
-npx cypress-last-failed run --e2e --browser chrome
+npx cypress-plugin-last-failed run --e2e --browser chrome
 ```
 
-### Optional custom `failedTestDirectory`
-
-By default, there will be a folder called `test-results` created in the directory of the `cypress.config`.
-
-- To customize where the `test-results` folder should be stored, add the `failedTestDirectory` environment variable:
-
-```js
-// Example using a fixtures folder path relative to the cypress.config
-
-module.exports = defineConfig({
-  env: {
-    failedTestDirectory: './cypress/fixtures',
-  },
-  e2e: {
-    setupNodeEvents(on, config) {},
-  },
-});
-```
+There will be a folder called `test-results` created in the directory of the `cypress.config`.
 
 ### Add rule to gitignore
 
@@ -141,7 +125,7 @@ For convenience, you may desire to house the `npx` command within an npm script
 
 ```json
   "scripts": {
-    "last-failed": "npx cypress-run-last-failed run --e2e --browser electron"
+    "last-failed": "npx cypress-plugin-last-failed run --e2e --browser electron"
   }
 ```
 
@@ -198,7 +182,7 @@ jobs:
         if: always()
         uses: cypress-io/github-action@v6
         with:
-          command: npx cypress-last-failed run
+          command: npx cypress-plugin-last-failed run
           working-directory: ${{ github.workspace }}
 ```
 

Diff for: assets/cypress-last-failed.png

@@ -3,7 +3,6 @@ const { collectFailingTests } = require('./src/index');
 
 module.exports = defineConfig({
   env: {
-    failedTestDirectory: './',
     grepOmitFiltered: true,
     grepFilterSpecs: true,
   },

Diff for: cypress.config.js

@@ -1,13 +1,13 @@
 {
   "name": "cypress-plugin-last-failed",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Cypress plugin to rerun last failed tests in cypress run and open mode",
   "main": "./src/index.js",
   "scripts": {
-    "last-failed": "node runFailed.js run --e2e --browser electron"
+    "last-failed": "npx cypress-plugin-last-failed run --e2e --browser electron"
   },
   "bin": {
-    "cypress-last-failed": "runFailed.js"
+    "cypress-plugin-last-failed": "runFailed.js"
   },
   "keywords": [
     "cypress",

Diff for: package-lock.json

@@ -4,18 +4,13 @@ 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 cypressConfig = require(`${appDir}/cypress.config`);
 
 async function runLastFailed() {
-  const noFailedTestsMessage =
-    'No previous failed tests detected\nTry running tests again with cypress run';
-
-  // Use the cypress environment variable failedTestDirectory for where to store failed tests
-  // If not set then use the directory of the project's cypress.config where the test-results defaults to
-  const failedTestFilePath =
-    cypressConfig.env?.failedTestDirectory === undefined
-      ? `${appDir}/test-results/last-run.txt`
-      : `${cypressConfig.env.failedTestDirectory}/test-results/last-run.txt`;
+  const noFailedTestsMessage = `No previous failed tests detected
+Ensure you are in the directory of your cypress config
+Try running tests again with cypress run`;
+
+  const failedTestFilePath = `${appDir}/test-results/last-run.txt`;
 
   if (fs.existsSync(failedTestFilePath)) {
     // Retrieve the failedTests from the file

Diff for: package.json

@@ -6,9 +6,7 @@ const path = require('path');
  *
  * After each run, a file will store failed test titles within a test-results directory
  *
- * Environment variable `failedTestDirectory` can be used to set a specific directory to store test-results
- *
- * If failedTestDirectory env var is unset, test-results will be stored in cypress.config directory
+ * The test-results directory will be stored in cypress.config directory
  *
  * Subsequent test runs containing failed tests will overwrite this file
  * @param {*} on
@@ -17,7 +15,6 @@ const path = require('path');
  */
 
 const collectFailingTests = (on, config) => {
-  // Check for environment variable `collectFailingTests` to be true
   on('after:run', async (results) => {
     let failedTests = [];
     // Grab every failed test's title
@@ -36,13 +33,12 @@ const collectFailingTests = (on, config) => {
     // Prepare a string that can be read from cy-grep
     const greppedTestFormat = stringedTests.replaceAll(',', '; ');
 
-    // Use the cypress.config environment variable for failedTestDirectory
-    // If not set then use the cypress.config directory
-    const failedTestFileDirectory =
-      config.env.failedTestDirectory === undefined
-        ? `${path.dirname(config.configFile)}/test-results/`
-        : `${config.env.failedTestDirectory}/test-results/`;
+    // Use the cypress.config directory for path for storing test-results
+    const failedTestFileDirectory = `${path.dirname(
+      config.configFile
+    )}/test-results/`;
 
+    // Create the directory and last-run file where failed tests will be written to
     await fs.promises.mkdir(`${failedTestFileDirectory}`, {
       recursive: true,
     });