find-cypress-specs 1.0.2 → 1.1.1

package/README.md

@@ -8,6 +8,27 @@ $ npx find-cypress-specs
 cypress/e2e/spec.js,cypress/e2e/featureA/user.js
 ```
 
+## 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))
+
+```bash
+$ npx find-cypress-specs --names
+# prints something like
+
+cypress/e2e/spec.js
+└─ parent suite [@main]
+  ├─ works
+  └─ inner suite
+    └─ shows something [@user]
+
+cypress/e2e/featureA/user.js
+├─ works
+└⊙ needs to be written
+```
+
+Where the tags are listed inside `[ ... ]` (see [cypress-grep](https://github.com/cypress-io/cypress-grep)) and the [pending tests](https://glebbahmutov.com/blog/cypress-test-statuses/) are marked with `⊙` character.
+
 ## 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/bin/find.js

@@ -1,6 +1,33 @@
 #!/usr/bin/env node
 
+const arg = require('arg')
 const { getSpecs } = require('../src')
+const fs = require('fs')
+const { getTestNames, formatTestList } = require('find-test-names')
+
+const args = arg({
+  '--names': Boolean,
+
+  // aliases
+  '-n': '--names',
+})
 
 const specs = getSpecs()
-console.log(specs.join(','))
+if (args['--names']) {
+  if (!specs.length) {
+    console.log('no specs found')
+  } else {
+    console.log('')
+    specs.forEach((filename) => {
+      const source = fs.readFileSync(filename, 'utf8')
+      const result = getTestNames(source, true)
+      // enable if need to debug the parsed test
+      // console.dir(result.structure, { depth: null })
+      console.log(filename)
+      console.log(formatTestList(result.structure))
+      console.log('')
+    })
+  }
+} else {
+  console.log(specs.join(','))
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "find-cypress-specs",
-  "version": "1.0.2",
+  "version": "1.1.1",
   "description": "Find Cypress spec files using the config settings",
   "main": "src",
   "files": [
@@ -14,6 +14,7 @@
     "test": "ava",
     "cy:run": "DEBUG=cypress:cli,cypress:server:specs cypress run",
     "demo": "DEBUG=find-cypress-specs node ./bin/find",
+    "demo-names": "node ./bin/find --names",
     "semantic-release": "semantic-release"
   },
   "repository": {
@@ -36,7 +37,9 @@
     "semantic-release": "^18.0.1"
   },
   "dependencies": {
+    "arg": "^5.0.1",
     "debug": "^4.3.3",
+    "find-test-names": "^1.9.2",
     "globby": "^11.0.4",
     "minimatch": "^3.0.4"
   }

package/src/index.js

@@ -43,6 +43,8 @@ function findCypressSpecs(opts = {}) {
 
   // 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
@@ -51,13 +53,14 @@ function findCypressSpecs(opts = {}) {
     // 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 options.ignoreTestFiles.every((pattern) => {
+    return ignorePatterns.every((pattern) => {
       return !minimatch(file, pattern, MINIMATCH_OPTIONS)
     })
   }
 
   const filtered = files.filter(doesNotMatchAllIgnoredPatterns)
-  debug('filtered specs %o', filtered)
+  debug('filtered %d specs', filtered.length)
+  debug(filtered.join('\n'))
 
   // return spec files with the added integration folder prefix
   return filtered.map((file) => path.join(options.integrationFolder, file))