find-cypress-specs 1.15.1 → 1.18.0

package/README.md

@@ -1,4 +1,4 @@
-# find-cypress-specs [![renovate-app badge][renovate-badge]][renovate-app] ![cypress version](https://img.shields.io/badge/cypress-9.5.3-brightgreen) [![ci](https://github.com/bahmutov/find-cypress-specs/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/bahmutov/find-cypress-specs/actions/workflows/ci.yml)
+# find-cypress-specs [![renovate-app badge][renovate-badge]][renovate-app] ![cypress version](https://img.shields.io/badge/cypress-10.3.0-brightgreen) [![ci](https://github.com/bahmutov/find-cypress-specs/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/bahmutov/find-cypress-specs/actions/workflows/ci.yml)
 
 > Find Cypress spec files using the config settings
 
@@ -8,6 +8,8 @@ $ npx find-cypress-specs
 cypress/e2e/spec.js,cypress/e2e/featureA/user.js
 ```
 
+Supports JS and TS specs
+
 ## against branch
 
 By default, this module simply prints all spec filenames. You can add `--branch` parameter to only print the specs changed against that `origin/branch`.
@@ -45,6 +47,16 @@ $ npx find-cypress-specs --branch main --count
 5
 ```
 
+### filter by a tag
+
+You can filter all changed specs and only report (and count) the specs that have changed AND include the given tag(s)
+
+```bash
+$ npx find-cypress-specs --branch main --tagged @user,@preview
+# prints only some specs, the ones that have changed against the "origin/main"
+# and that have any tests or suites inside tagged "@user" or "@preview"
+```
+
 ## Test names
 
 You can print each spec file with the suite and test names inside of it (found using [find-test-names](https://github.com/bahmutov/find-test-names))

package/bin/find.js

@@ -115,7 +115,29 @@ if (args['--names'] || args['--tags']) {
   debug('determining specs changed against branch %s', args['--branch'])
   const changedFiles = findChangedFiles(args['--branch'], args['--parent'])
   debug('changed files %o', changedFiles)
-  const changedSpecs = specs.filter((file) => changedFiles.includes(file))
+  debug('comparing against the specs %o', specs)
+  let changedSpecs = specs.filter((file) => changedFiles.includes(file))
+  debug('changed specs %o', changedSpecs)
+
+  if (args['--tagged']) {
+    const splitTags = args['--tagged']
+      .split(',')
+      .map((s) => s.trim())
+      .filter(Boolean)
+    debug('filtering changed specs by tags %o', splitTags)
+    changedSpecs = changedSpecs.filter((file) => {
+      const source = fs.readFileSync(file, 'utf8')
+      const result = getTestNames(source, true)
+      const specTagCounts = countTags(result.structure)
+      const specHasTags = Object.keys(specTagCounts).some((tag) =>
+        splitTags.includes(tag),
+      )
+      debug('spec %s has tags? %o', file, specHasTags)
+
+      return specHasTags
+    })
+  }
+
   if (args['--count']) {
     console.log(changedSpecs.length)
   } else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "find-cypress-specs",
-  "version": "1.15.1",
+  "version": "1.18.0",
   "description": "Find Cypress spec files using the config settings",
   "main": "src",
   "files": [
@@ -40,10 +40,13 @@
   "homepage": "https://github.com/bahmutov/find-cypress-specs#readme",
   "devDependencies": {
     "ava": "^4.0.0",
-    "cypress": "9.5.3",
+    "cypress": "10.3.0",
     "execa-wrap": "^1.4.0",
     "prettier": "^2.5.1",
-    "semantic-release": "19.0.2"
+    "really-need": "^1.9.2",
+    "semantic-release": "19.0.3",
+    "sinon": "^13.0.1",
+    "typescript": "^4.6.3"
   },
   "dependencies": {
     "arg": "^5.0.1",
@@ -53,6 +56,7 @@
     "globby": "^11.0.4",
     "minimatch": "^3.0.4",
     "pluralize": "^8.0.0",
+    "require-and-forget": "^1.0.0",
     "shelljs": "^0.8.5"
   }
 }

package/src/index.js

@@ -4,13 +4,15 @@ const path = require('path')
 const globby = require('globby')
 const minimatch = require('minimatch')
 const shell = require('shelljs')
+const pluralize = require('pluralize')
+const requireEveryTime = require('require-and-forget')
 
 const MINIMATCH_OPTIONS = { dot: true, matchBase: true }
 
 /**
- * Reads the cypress config file and returns the relevant properties
+ * Reads the Cypress config JSON file (Cypress v9) and returns the relevant properties
  */
-function getConfig(filename = 'cypress.json') {
+function getConfigJson(filename = 'cypress.json') {
   const s = fs.readFileSync(filename, 'utf8')
   const config = JSON.parse(s)
   const options = {
@@ -22,10 +24,24 @@ function getConfig(filename = 'cypress.json') {
   return options
 }
 
-function findCypressSpecs(opts = {}) {
+function getConfigJs(filename) {
+  const jsFile = path.join(process.cwd(), filename)
+  debug('loading Cypress config from %s', jsFile)
+  const definedConfig = requireEveryTime(jsFile)
+  return definedConfig
+}
+
+function getConfig(filename = './cypress.config.js') {
+  if (filename.endsWith('.json')) {
+    return getConfigJson(filename)
+  }
+  return getConfigJs(filename)
+}
+
+function findCypressSpecsV9(opts = {}) {
   const defaults = {
     integrationFolder: 'cypress/integration',
-    testFiles: '**/*.js',
+    testFiles: '**/*.{js,ts}',
     ignoreTestFiles: [],
   }
   const options = {
@@ -67,9 +83,64 @@ function findCypressSpecs(opts = {}) {
   return filtered.map((file) => path.join(options.integrationFolder, file))
 }
 
+function findCypressSpecsV10(opts = {}) {
+  if (!('e2e' in opts)) {
+    throw new Error('Missing e2e in the config object')
+  }
+  const defaults = {
+    specPattern: 'cypress/e2e/**/*.cy.{js,jsx,ts,tsx}',
+    excludeSpecPattern: [],
+  }
+  const options = {
+    specPattern: opts.e2e.specPattern || defaults.specPattern,
+    excludeSpecPattern:
+      opts.e2e.excludeSpecPattern || defaults.excludeSpecPattern,
+  }
+  debug('options v10 %o', options)
+
+  const files = globby.sync(options.specPattern, {
+    sort: true,
+    ignore: options.excludeSpecPattern,
+  })
+  debug('found %d file(s) %o', files.length, files)
+
+  // go through the files again and eliminate files that match
+  // the ignore patterns
+  const ignorePatterns = [].concat(options.excludeSpecPattern)
+  debug('ignore patterns %o', ignorePatterns)
+
+  // a function which returns true if the file does NOT match
+  // all of our ignored patterns
+  const doesNotMatchAllIgnoredPatterns = (file) => {
+    // using {dot: true} here so that folders with a '.' in them are matched
+    // as regular characters without needing an '.' in the
+    // using {matchBase: true} here so that patterns without a globstar **
+    // match against the basename of the file
+    const MINIMATCH_OPTIONS = { dot: true, matchBase: true }
+    return ignorePatterns.every((pattern) => {
+      return !minimatch(file, pattern, MINIMATCH_OPTIONS)
+    })
+  }
+
+  const filtered = files.filter(doesNotMatchAllIgnoredPatterns)
+  debug('filtered %d specs', filtered.length)
+  debug(filtered.join('\n'))
+
+  return filtered
+}
+
 function getSpecs() {
   const options = getConfig()
-  const specs = findCypressSpecs(options)
+  return findCypressSpecs(options)
+}
+
+function findCypressSpecs(options) {
+  if (options.e2e) {
+    const specs = findCypressSpecsV10(options)
+    return specs
+  }
+
+  const specs = findCypressSpecsV9(options)
   return specs
 }
 
@@ -139,7 +210,10 @@ function findChangedFiles(branch, useParent) {
       return []
     }
 
-    const filenames = result.stdout.split('\n').filter(Boolean)
+    const filenames = result.stdout
+      .split('\n')
+      .filter(Boolean)
+      .map((s) => s.trim())
     return filenames
   } else {
     const command = `git diff --name-only --diff-filter=AMR origin/${branch}`
@@ -151,7 +225,15 @@ function findChangedFiles(branch, useParent) {
       return []
     }
 
-    const filenames = result.stdout.split('\n').filter(Boolean)
+    const filenames = result.stdout
+      .split('\n')
+      .filter(Boolean)
+      .map((s) => s.trim())
+    debug(
+      'found %d changed %s',
+      filenames.length,
+      pluralize('file', filenames.length),
+    )
     return filenames
   }
 }