@bahmutov/cy-grep 1.4.3 → 1.5.1

package/README.md

@@ -1,4 +1,4 @@
-# @bahmutov/cy-grep ![cypress version](https://img.shields.io/badge/cypress-12.5.0-brightgreen)
+# @bahmutov/cy-grep ![cypress version](https://img.shields.io/badge/cypress-12.7.0-brightgreen)
 
 > Filter tests using substring or tag
 
@@ -41,6 +41,7 @@ Watch the video [intro to cypress-grep plugin](https://www.youtube.com/watch?v=H
   - [Install](#install)
     - [Support file](#support-file)
     - [Config file](#config-file)
+    - [Install in Cypress versions before 10](#install-in-cypress-versions-before-10)
   - [Usage Overview](#usage-overview)
   - [Filter by test title](#filter-by-test-title)
     - [OR substring matching](#or-substring-matching)
@@ -84,7 +85,7 @@ npm i -D @bahmutov/cy-grep
 yarn add -D @bahmutov/cy-grep
 ```
 
-**Note**: @bahmutov/cy-grep only works with Cypress version >= 10.
+**Note**: @bahmutov/cy-grep should work with all Cypress versions, but I mostly test it on the newest versions.
 
 ### Support file
 
@@ -140,6 +141,37 @@ module.exports = defineConfig({
 })
 ```
 
+### Install in Cypress versions before 10
+
+See [test-cy-v9](./test-cy-v9/) for example
+
+```js
+// cypress/plugins/index.js
+module.exports = (on, config) => {
+  // `on` is used to hook into various events Cypress emits
+  // `config` is the resolved Cypress config
+  require('@bahmutov/cy-grep/src/plugin')(config)
+  // IMPORTANT: return the config object
+  return config
+}
+```
+
+```js
+// cypress/support/index.js
+require('@bahmutov/cy-grep')()
+```
+
+Put the common settings into `cypress.json`
+
+```json
+{
+  "env": {
+    "grepOmitFiltered": true,
+    "grepFilterSpecs": true
+  }
+}
+```
+
 ## Usage Overview
 
 You can filter tests to run using part of their title via `grep`, and via explicit tags via `grepTags` Cypress environment variables.

package/package.json

@@ -1,17 +1,19 @@
 {
   "name": "@bahmutov/cy-grep",
-  "version": "1.4.3",
+  "version": "1.5.1",
   "description": "Filter Cypress tests using title or tags",
   "main": "src/support.js",
   "scripts": {
     "cy:run": "cypress run --config specPattern='**/unit.js'",
     "cy:open": "cypress open --e2e -b electron --config specPattern='**/unit.js'",
     "badges": "npx -p dependency-version-badge update-badge cypress",
-    "semantic-release": "semantic-release"
+    "semantic-release": "semantic-release",
+    "deps": "npm audit --report --omit dev"
   },
   "dependencies": {
     "cypress-plugin-config": "^1.2.0",
     "debug": "^4.3.2",
+    "find-cypress-specs": "^1.29.4",
     "find-test-names": "1.28.1",
     "globby": "^11.0.4"
   },
@@ -24,7 +26,7 @@
     "typescript": "^4.7.4"
   },
   "peerDependencies": {
-    "cypress": ">=10"
+    "cypress": ">=8"
   },
   "files": [
     "src"

package/src/plugin.js

@@ -1,27 +1,19 @@
+// @ts-check
 const debug = require('debug')('cy-grep')
 const globby = require('globby')
+
+const { getSpecs } = require('find-cypress-specs')
 const { getTestNames, findEffectiveTestTags } = require('find-test-names')
 const fs = require('fs')
+const path = require('path')
 const { version } = require('../package.json')
 const { parseGrep, shouldTestRun } = require('./utils')
 
-/**
- * Prints the cy-grep environment values if any.
- * @param {Cypress.ConfigOptions} config
- */
-function cypressGrepPlugin(config) {
-  if (!config || !config.env) {
-    return config
-  }
+const isCypressV9 = (config) => !('specPattern' in config)
 
+function getGrepSettings(config) {
   const { env } = config
 
-  if (!config.specPattern) {
-    throw new Error(
-      'Incompatible versions detected, cy-grep requires Cypress 10.0.0+',
-    )
-  }
-
   debug('cy-grep plugin version %s', version)
   debug('Cypress config env object: %o', env)
 
@@ -58,20 +50,24 @@ function cypressGrepPlugin(config) {
     console.log('cy-grep: will omit filtered tests')
   }
 
-  const { specPattern, excludeSpecPattern } = config
-  const integrationFolder = env.grepIntegrationFolder || process.cwd()
-
   const grepFilterSpecs = env.grepFilterSpecs === true
 
+  return { grep, grepTags, grepFilterSpecs }
+}
+
+/**
+ * Prints the cy-grep environment values if any.
+ * @param {Cypress.ConfigOptions} config
+ */
+function cypressGrepPlugin(config) {
+  if (!config || !config.env) {
+    return config
+  }
+
+  const { grep, grepTags, grepFilterSpecs } = getGrepSettings(config)
+
   if (grepFilterSpecs) {
-    debug('specPattern', specPattern)
-    debug('excludeSpecPattern', excludeSpecPattern)
-    debug('integrationFolder', integrationFolder)
-    const specFiles = globby.sync(specPattern, {
-      cwd: integrationFolder,
-      ignore: excludeSpecPattern,
-      absolute: true,
-    })
+    const specFiles = getSpecs(config)
 
     debug('found %d spec files', specFiles.length)
     debug('%o', specFiles)
@@ -86,7 +82,7 @@ function cypressGrepPlugin(config) {
         const text = fs.readFileSync(specFile, { encoding: 'utf8' })
 
         try {
-          const names = getTestNames(text)
+          const names = getTestNames(text, false)
           const testAndSuiteNames = names.suiteNames.concat(names.testNames)
 
           debug('spec file %s', specFile)
@@ -127,7 +123,7 @@ function cypressGrepPlugin(config) {
             const requiredTags = testTags[testTitle].requiredTags
             return shouldTestRun(
               parsedGrep,
-              null,
+              undefined,
               effectiveTags,
               false,
               requiredTags,
@@ -173,7 +169,25 @@ function cypressGrepPlugin(config) {
     }
 
     if (greppedSpecs.length) {
-      config.specPattern = greppedSpecs
+      if (isCypressV9(config)) {
+        debug('setting selected %d specs (< v10)', greppedSpecs.length)
+        // @ts-ignore
+        const integrationFolder = config.integrationFolder
+        const relativeNames = greppedSpecs.map((filename) =>
+          path.relative(integrationFolder, filename),
+        )
+        debug(
+          'specs in the integration folder %s %s',
+          integrationFolder,
+          relativeNames.join(', '),
+        )
+        // @ts-ignore
+        config.testFiles = relativeNames.join(',')
+      } else {
+        debug('setting selected %d specs (>= v10)', greppedSpecs.length)
+        // @ts-ignore
+        config.specPattern = greppedSpecs
+      }
     } else {
       // hmm, we filtered out all specs, probably something is wrong
       console.warn('grep and/or grepTags has eliminated all specs')