find-cypress-specs 1.0.0 → 1.0.4

package/README.md

@@ -2,9 +2,17 @@
 
 > Find Cypress spec files using the config settings
 
+```bash
+$ npx find-cypress-specs
+# prints all spec files separated by a comma
+cypress/e2e/spec.js,cypress/e2e/featureA/user.js
+```
+
+## 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.
 
-You can see how Cypress finds the specs using `DEBUG=cypress:cli,cypress:server:specs` environment variable to see verbose logs.
+You can see how Cypress finds the specs using `DEBUG=cypress:cli,cypress:server:specs` environment variable to see verbose logs. The logic should be in the file `packages/server/lib/util/specs.ts` in the repo [cypress-io/cypress](https://github.com/cypress-io/cypress)
 
 ## Debugging
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "find-cypress-specs",
-  "version": "1.0.0",
+  "version": "1.0.4",
   "description": "Find Cypress spec files using the config settings",
   "main": "src",
   "files": [
@@ -37,6 +37,7 @@
   },
   "dependencies": {
     "debug": "^4.3.3",
-    "globby": "^11.0.4"
+    "globby": "^11.0.4",
+    "minimatch": "^3.0.4"
   }
 }

package/src/index.js

@@ -2,6 +2,9 @@ const debug = require('debug')('find-cypress-specs')
 const fs = require('fs')
 const path = require('path')
 const globby = require('globby')
+const minimatch = require('minimatch')
+
+const MINIMATCH_OPTIONS = { dot: true, matchBase: true }
 
 /**
  * Reads the cypress config file and returns the relevant properties
@@ -25,19 +28,42 @@ function findCypressSpecs(opts = {}) {
     ignoreTestFiles: [],
   }
   const options = {
-    ...defaults,
-    ...opts,
+    integrationFolder: opts.integrationFolder || defaults.integrationFolder,
+    testFiles: opts.testFiles || defaults.testFiles,
+    ignoreTestFiles: opts.ignoreTestFiles || defaults.ignoreTestFiles,
   }
   debug('options %o', options)
 
   const files = globby.sync(options.testFiles, {
+    sort: true,
     cwd: options.integrationFolder,
     ignore: options.ignoreTestFiles,
   })
   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.ignoreTestFiles)
+  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
+    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 spec files with the added integration folder prefix
-  return files.map((file) => path.join(options.integrationFolder, file))
+  return filtered.map((file) => path.join(options.integrationFolder, file))
 }
 
 function getSpecs() {