find-cypress-specs 1.21.0 → 1.23.0

package/README.md

@@ -19,6 +19,20 @@ $ npx find-cypress-specs --branch main
 # prints only some specs, the ones that have changed against the "origin/main"
 ```
 
+## set GitHub Actions outputs
+
+If you add `--set-gh-outputs` command line switch, then the number of changed specs and the comma-separated file list will be set as GH Actions outputs `changedSpecsN` and `changedSpecs`. See [pr.yml](./.github/workflows/pr.yml) for example
+
+```yml
+- name: Print specs changed against the parent of this branch 🌳
+  # and set GitHub Actions output
+  id: step1
+  run: node ./bin/find --branch main --parent --set-gha-outputs
+
+- name: Print set outputs
+  run: echo ${{ steps.step1.outputs.changedSpecsN }} ${{ steps.step1.outputs.changedSpecs }}
+```
+
 ## against the parent commit
 
 When dealing with a long-term branch, you do not want to see the changed files in the main branch. Instead, you want to only consider the specs changed in the _current_ branch all the way to its parent commit. You can pass the flag `--parent` to only pick the modified and added specs.
@@ -47,6 +61,17 @@ $ npx find-cypress-specs --branch main --parent --trace-imports cypress
 
 **Note:** the argument is the subfolder name to limit the number of files to inspect when tracing the imports.
 
+You can time how long tracing takes by adding option `--time-trace` to the command line arguments. You can also saved traced dependencies using `--cache-trace` argument. Next time the dependencies will be loaded from the file without recomputing. This is convenient on CI to avoid recomputing them. For example, if you need the number of affected files and their filenames
+
+```
+# get the number of affected specs
+$ npx find-cypress-specs --branch main --parent --trace-imports cypress --cache-trace --count
+# quickly get the affected specs without recomputing the dependencies
+$ npx find-cypress-specs --branch main --parent --trace-imports cypress --cache-trace
+```
+
+The cached trace will be saved in file `deps.json`, you probably want to Git ignore it.
+
 ### number of changed files
 
 You can print just the number of changed specs

package/bin/find.js

@@ -12,6 +12,7 @@ const { getTestNames, countTags } = require('find-test-names')
 const consoleTable = require('console.table')
 const debug = require('debug')('find-cypress-specs')
 const { getDependsInFolder } = require('spec-change')
+const core = require('@actions/core')
 
 const args = arg({
   '--names': Boolean,
@@ -32,7 +33,13 @@ const args = arg({
   // and consider specs that import a changes source file changed to
   // The value of this argument is the subfolder with Cypress tests, like "cypress"
   '--trace-imports': String,
-
+  // when enabled, this code uses GitHub Actions Core package
+  // to set two named outputs, one for number of changed specs
+  // another for actual list of files
+  '--set-gha-outputs': Boolean,
+  // save a JSON file with traced dependencies to save time
+  '--cache-trace': Boolean,
+  '--time-trace': Boolean,
   // aliases
   '-n': '--names',
   '--name': '--names',
@@ -137,8 +144,32 @@ if (args['--names'] || args['--tags']) {
   debug('comparing against the specs %o', specs)
   if (args['--trace-imports']) {
     debug('tracing dependent changes in folder %s', args['--trace-imports'])
-    const absoluteFolder = path.join(process.cwd(), args['--trace-imports'])
-    const deps = getDependsInFolder(absoluteFolder)
+
+    const saveDependenciesFile = 'deps.json'
+    let deps
+    if (args['--cache-trace']) {
+      if (fs.existsSync(saveDependenciesFile)) {
+        debug(
+          'loading cached traced dependencies from file %s',
+          saveDependenciesFile,
+        )
+        deps = JSON.parse(fs.readFileSync(saveDependenciesFile, 'utf-8')).deps
+      }
+    }
+
+    if (!deps) {
+      const absoluteFolder = path.join(process.cwd(), args['--trace-imports'])
+      const depsOptions = { folder: absoluteFolder, time: args['--time-trace'] }
+      if (args['--cache-trace']) {
+        depsOptions.saveDepsFilename = saveDependenciesFile
+        debug(
+          'will save found dependencies into the file %s',
+          saveDependenciesFile,
+        )
+      }
+      debug('tracing options %o', depsOptions)
+      deps = getDependsInFolder(depsOptions)
+    }
     debug('traced dependencies via imports and require')
     debug(deps)
     Object.entries(deps).forEach(([filename, fileDependents]) => {
@@ -160,6 +191,11 @@ if (args['--names'] || args['--tags']) {
   }
   let changedSpecs = specs.filter((file) => changedFiles.includes(file))
   debug('changed %d specs %o', changedSpecs.length, changedSpecs)
+  if (args['--set-gha-outputs']) {
+    debug('setting GitHub Actions outputs changedSpecsN and changedSpecs')
+    core.setOutput('changedSpecsN', changedSpecs.length)
+    core.setOutput('changedSpecs', changedSpecs.join(','))
+  }
 
   if (args['--tagged']) {
     const splitTags = args['--tagged']

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "find-cypress-specs",
-  "version": "1.21.0",
+  "version": "1.23.0",
   "description": "Find Cypress spec files using the config settings",
   "main": "src",
   "files": [
@@ -26,7 +26,7 @@
     "count-changed-specs": "node ./bin/find --branch main --count",
     "semantic-release": "semantic-release",
     "deps": "spec-change --folder . --mask 'cypress/**/*.{js,ts}'",
-    "deps-changed": "DEBUG=find-cypress-specs node ./bin/find --branch main --parent --trace-imports cypress"
+    "deps-changed": "DEBUG=find-cypress-specs node ./bin/find --branch main --parent --trace-imports cypress --time-trace --cache-trace"
   },
   "repository": {
     "type": "git",
@@ -52,6 +52,7 @@
     "typescript": "^4.6.3"
   },
   "dependencies": {
+    "@actions/core": "^1.10.0",
     "arg": "^5.0.1",
     "console.table": "^0.10.0",
     "debug": "^4.3.3",
@@ -61,7 +62,7 @@
     "pluralize": "^8.0.0",
     "require-and-forget": "^1.0.0",
     "shelljs": "^0.8.5",
-    "spec-change": "^1.4.0",
+    "spec-change": "^1.6.0",
     "ts-node": "^10.9.1"
   }
 }