find-cypress-specs 1.17.0 → 1.19.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.8.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
 
@@ -115,6 +115,12 @@ $ npx find-cypress-specs --names --tagged <tag1>,<tag2>,<tag3>,...
 # tagged with tag1 or tag2 or tag3 or ...
 ```
 
+## cypress.config.ts
+
+If the project uses TypeScript and `cypress.config.ts` then this module uses [ts-node/register](https://github.com/TypeStrong/ts-node) to load the config and fetch the spec pattern.
+
+**Tip:** read my blog post [Convert Cypress Specs from JavaScript to TypeScript](https://glebbahmutov.com/blog/cypress-js-to-ts/).
+
 ## Details
 
 Cypress uses the resolved [configuration values](https://on.cypress.io/configuration) to find the spec files to run. It searches the `integrationFolder` for all patterns listed in `testFiles` and removes any files matching the `ignoreTestFiles` patterns.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "find-cypress-specs",
-  "version": "1.17.0",
+  "version": "1.19.0",
   "description": "Find Cypress spec files using the config settings",
   "main": "src",
   "files": [
@@ -40,11 +40,11 @@
   "homepage": "https://github.com/bahmutov/find-cypress-specs#readme",
   "devDependencies": {
     "ava": "^4.0.0",
-    "cypress": "9.5.3",
+    "cypress": "10.8.0",
     "execa-wrap": "^1.4.0",
     "prettier": "^2.5.1",
     "really-need": "^1.9.2",
-    "semantic-release": "19.0.2",
+    "semantic-release": "19.0.5",
     "sinon": "^13.0.1",
     "typescript": "^4.6.3"
   },
@@ -56,6 +56,8 @@
     "globby": "^11.0.4",
     "minimatch": "^3.0.4",
     "pluralize": "^8.0.0",
-    "shelljs": "^0.8.5"
+    "require-and-forget": "^1.0.0",
+    "shelljs": "^0.8.5",
+    "ts-node": "^10.9.1"
   }
 }

package/src/index.js

@@ -5,13 +5,14 @@ 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 = {
@@ -23,7 +24,41 @@ 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 getConfigTs(filename) {
+  require('ts-node/register')
+  const jsFile = path.join(process.cwd(), filename)
+  debug('loading Cypress config from %s', jsFile)
+  const definedConfig = requireEveryTime(jsFile)
+  return definedConfig
+}
+
+function getConfig() {
+  if (fs.existsSync('./cypress.config.js')) {
+    debug('found file cypress.config.js')
+    return getConfigJs('./cypress.config.js')
+  }
+
+  if (fs.existsSync('./cypress.config.ts')) {
+    debug('found file cypress.config.ts')
+    return getConfigTs('./cypress.config.ts')
+  }
+
+  if (fs.existsSync('./cypress.json')) {
+    debug('found file cypress.json')
+    return getConfigJson('./cypress.config.js')
+  }
+
+  throw new Error('Do not know how to find and load Cypress config file')
+}
+
+function findCypressSpecsV9(opts = {}) {
   const defaults = {
     integrationFolder: 'cypress/integration',
     testFiles: '**/*.{js,ts}',
@@ -68,9 +103,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
 }