find-cypress-specs 1.19.4 → 1.20.0

package/README.md

@@ -115,6 +115,21 @@ $ npx find-cypress-specs --names --tagged <tag1>,<tag2>,<tag3>,...
 # tagged with tag1 or tag2 or tag3 or ...
 ```
 
+## Show only the pending tests
+
+You can show only the tests marked with "it.skip" which are called "pending" according to Mocha / Cypress [terminology](https://glebbahmutov.com/blog/cypress-test-statuses/).
+
+```bash
+$ npx find-cypress-specs --names --pending
+# --skipped is an alias to --pending
+$ npx find-cypress-specs --names --skipped
+# prints and counts only the pending tests
+cypress/e2e/featureA/user.cy.ts (1 test, 1 pending)
+└⊙ needs to be written [@alpha]
+
+found 1 spec (1 test, 1 pending)
+```
+
 ## 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.

package/bin/find.js

@@ -2,7 +2,7 @@
 
 const arg = require('arg')
 const { getSpecs, collectResults, findChangedFiles } = require('../src')
-const { pickTaggedTestsFrom } = require('../src/tagged')
+const { pickTaggedTestsFrom, leavePendingTestsOnly } = require('../src/tagged')
 const { addCounts } = require('../src/count')
 const { stringAllInfo } = require('../src/print')
 
@@ -23,6 +23,8 @@ const args = arg({
   '--count': Boolean,
   // filter all tests to those that have the given tag
   '--tagged': String,
+  // print only the "it.only" tests
+  '--skipped': Boolean,
 
   // aliases
   '-n': '--names',
@@ -31,6 +33,10 @@ const args = arg({
   '--tag': '--tags',
   '-j': '--json',
   '-b': '--branch',
+  // Cypress test status (just like Mocha)
+  // calls "it.skip" pending tests
+  // https://glebbahmutov.com/blog/cypress-test-statuses/
+  '--pending': '--skipped',
 })
 
 debug('arguments %o', args)
@@ -84,6 +90,11 @@ if (args['--names'] || args['--tags']) {
         pickTaggedTestsFrom(jsonResults, splitTags)
         // recompute the number of tests
         addCounts(jsonResults)
+      } else if (args['--skipped']) {
+        debug('leaving only skipped (pending) tests')
+        leavePendingTestsOnly(jsonResults)
+        // recompute the number of tests
+        addCounts(jsonResults)
       }
 
       if (args['--json']) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "find-cypress-specs",
-  "version": "1.19.4",
+  "version": "1.20.0",
   "description": "Find Cypress spec files using the config settings",
   "main": "src",
   "files": [
@@ -15,6 +15,7 @@
     "cy:run": "DEBUG=cypress:cli,cypress:server:specs cypress run",
     "demo": "DEBUG=find-cypress-specs node ./bin/find",
     "demo-names": "node ./bin/find --names",
+    "demo-skipped-tests": "node ./bin/find --names --skipped",
     "demo-tags": "node ./bin/find --tags",
     "demo-tags-json": "node ./bin/find --tags --json",
     "demo-names-and-tags": "node ./bin/find --names --tags",

package/src/tagged.js

@@ -38,6 +38,25 @@ function pickTaggedTests(tests, tag) {
   return filteredTests.length > 0
 }
 
+// note: modifies the tests in place
+function leavePendingTests(tests) {
+  if (!Array.isArray(tests)) {
+    return false
+  }
+  const filteredTests = tests.filter((test) => {
+    if (test.type === 'test') {
+      return test.pending === true
+    } else if (test.type === 'suite') {
+      // maybe there is some test inside this suite
+      // with the tag? Filter all other tests
+      return leavePendingTests(test.tests) || leavePendingTests(test.suites)
+    }
+  })
+  tests.length = 0
+  tests.push(...filteredTests)
+  return filteredTests.length > 0
+}
+
 function removeEmptyNodes(json) {
   Object.keys(json).forEach((filename) => {
     const fileTests = json[filename].tests
@@ -64,9 +83,26 @@ function pickTaggedTestsFrom(json, tag) {
   return result
 }
 
+/**
+ * Takes an object of tests collected from all files,
+ * and leaves only the pending tests.
+ * Modifies the given object in place.
+ */
+function leavePendingTestsOnly(json) {
+  Object.keys(json).forEach((filename) => {
+    const fileTests = json[filename].tests
+    leavePendingTests(fileTests)
+  })
+
+  const result = removeEmptyNodes(json)
+  addCounts(result)
+  return result
+}
+
 module.exports = {
   arraysOverlap,
   pickTaggedTestsFrom,
   removeEmptyNodes,
   pickTaggedTests,
+  leavePendingTestsOnly,
 }