find-cypress-specs 1.23.0 → 1.25.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-12.2.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-specs [![renovate-app badge][renovate-badge]][renovate-app] ![cypress version](https://img.shields.io/badge/cypress-12.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
 
@@ -72,6 +72,8 @@ $ npx find-cypress-specs --branch main --parent --trace-imports cypress --cache-
 
 The cached trace will be saved in file `deps.json`, you probably want to Git ignore it.
 
+You can limit the number of added traced files using the `--max-added-traced-specs <N>` parameter. This avoids ALL specs added when you change some common utility that many specs import.
+
 ### number of changed files
 
 You can print just the number of changed specs
@@ -165,6 +167,24 @@ cypress/e2e/featureA/user.cy.ts (1 test, 1 pending)
 found 1 spec (1 test, 1 pending)
 ```
 
+## Print skipped tests
+
+```
+$ npx find-cypress-specs --names --skipped
+```
+
+Prints each spec that has skipped tests.
+
+## Count skipped tests
+
+Prints the single number with the count of skipped tests
+
+```
+$ npx find-cypress-specs --names --skipped --count
+
+5
+```
+
 ## 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.
@@ -210,8 +230,22 @@ Run the utility with environment variable `DEBUG=find-cypress-specs` to see the
 
 ## Examples
 
+- 📝 blog post [Run Changed Traced Specs On GitHub Actions](https://glebbahmutov.com/blog/trace-changed-specs/)
 - [chat.io](https://github.com/bahmutov/chat.io) as described in the blog post [Get Faster Feedback From Your Cypress Tests Running On CircleCI](https://glebbahmutov.com/blog/faster-ci-feedback-on-circleci/)
 
+## NPM module
+
+You can use this module via its NPM module API.
+
+```js
+const { getSpecs } = require('find-cypress-specs')
+// somewhere in the cypress.config.js
+setupNodeEvents(on, config) {
+  const specs = getSpecs(config)
+  // specs is a list of filenames
+}
+```
+
 ## Small print
 
 Author: Gleb Bahmutov &lt;gleb.bahmutov@gmail.com&gt; &copy; 2022

package/bin/find.js

@@ -40,6 +40,8 @@ const args = arg({
   // save a JSON file with traced dependencies to save time
   '--cache-trace': Boolean,
   '--time-trace': Boolean,
+  // do not add more than this number of extra specs after tracing
+  '--max-added-traced-specs': Number,
   // aliases
   '-n': '--names',
   '--name': '--names',
@@ -112,13 +114,22 @@ if (args['--names'] || args['--tags']) {
         addCounts(jsonResults)
       }
 
-      if (args['--json']) {
-        console.log(JSON.stringify(jsonResults, null, 2))
+      if (args['--count']) {
+        let n = 0
+        Object.keys(jsonResults).forEach((filename) => {
+          const skippedCount = jsonResults[filename].counts.pending
+          n += skippedCount
+        })
+        console.log(n)
       } else {
-        const str = stringAllInfo(jsonResults)
-        console.log(str)
+        if (args['--json']) {
+          console.log(JSON.stringify(jsonResults, null, 2))
+        } else {
+          const str = stringAllInfo(jsonResults)
+          console.log(str)
+        }
+        console.log('')
       }
-      console.log('')
     }
 
     if (args['--tags']) {
@@ -172,6 +183,13 @@ if (args['--names'] || args['--tags']) {
     }
     debug('traced dependencies via imports and require')
     debug(deps)
+
+    // add a sensible limit to the number of extra specs to add
+    // when we trace the dependencies in the changed source files
+    const addedTracedFiles = []
+    const maxAddTracedFiles = args['--max-added-traced-specs'] || 1000
+    debug('maximum traced files to add %d', maxAddTracedFiles)
+
     Object.entries(deps).forEach(([filename, fileDependents]) => {
       const f = path.join(args['--trace-imports'], filename)
       if (changedFiles.includes(f)) {
@@ -183,12 +201,17 @@ if (args['--names'] || args['--tags']) {
         fileDependents.forEach((name) => {
           const nameInCypressFolder = path.join(args['--trace-imports'], name)
           if (!changedFiles.includes(nameInCypressFolder)) {
-            changedFiles.push(nameInCypressFolder)
+            if (addedTracedFiles.length < maxAddTracedFiles) {
+              changedFiles.push(nameInCypressFolder)
+              addedTracedFiles.push(nameInCypressFolder)
+            }
           }
         })
       }
     })
+    debug('added %d traced specs %o', addedTracedFiles.length, addedTracedFiles)
   }
+
   let changedSpecs = specs.filter((file) => changedFiles.includes(file))
   debug('changed %d specs %o', changedSpecs.length, changedSpecs)
   if (args['--set-gha-outputs']) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "find-cypress-specs",
-  "version": "1.23.0",
+  "version": "1.25.0",
   "description": "Find Cypress spec files using the config settings",
   "main": "src",
   "files": [
@@ -16,6 +16,7 @@
     "demo": "DEBUG=find-cypress-specs node ./bin/find",
     "demo-names": "node ./bin/find --names",
     "demo-skipped-tests": "node ./bin/find --names --skipped",
+    "demo-count-skipped-tests": "node ./bin/find --names --skipped --count",
     "demo-tags": "node ./bin/find --tags",
     "demo-tags-json": "node ./bin/find --tags --json",
     "demo-names-and-tags": "node ./bin/find --names --tags",
@@ -43,11 +44,11 @@
   "homepage": "https://github.com/bahmutov/find-cypress-specs#readme",
   "devDependencies": {
     "ava": "^4.0.0",
-    "cypress": "12.2.0",
+    "cypress": "12.3.0",
     "execa-wrap": "^1.4.0",
     "prettier": "^2.5.1",
     "really-need": "^1.9.2",
-    "semantic-release": "19.0.5",
+    "semantic-release": "20.0.2",
     "sinon": "^13.0.1",
     "typescript": "^4.6.3"
   },