find-cypress-specs 1.14.0 → 1.15.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-9.5.1-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-9.5.3-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
 
@@ -17,6 +17,29 @@ $ npx find-cypress-specs --branch main
 # prints only some specs, the ones that have changed against the "origin/main"
 ```
 
+## 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.
+
+```bash
+$ npx find-cypress-specs --parent
+# same as
+# git diff --name-only --diff-filter=AMR HEAD^!
+```
+
+Note: in order to trace the commits back to the parent commit of the branch, fetch the entire repo or enough commits to have this information when checking out the repo. For example, in [pr.yml](./.github/workflows/pr.yml) we fetch the entire history
+
+```yml
+- name: Checkout 🛎
+  # https://github.com/actions/checkout
+  uses: actions/checkout@v3
+  # check out all the commits in the repo
+  # to make sure we detect the changed files in this branch
+  # against its parent commit
+  with:
+    fetch-depth: 0
+```
+
 ### number of changed files
 
 You can print just the number of changed specs
@@ -109,6 +132,7 @@ Author: Gleb Bahmutov <gleb.bahmutov@gmail.com> © 2022
 - [videos](https://www.youtube.com/glebbahmutov)
 - [presentations](https://slides.com/bahmutov)
 - [cypress.tips](https://cypress.tips)
+- [Cypress Tips&Tricks](https://cypresstips.substack.com/) newsletter
 
 License: MIT - do anything with the code, but don't blame me if it does not work.
 

package/bin/find.js

@@ -1,7 +1,12 @@
 #!/usr/bin/env node
 
 const arg = require('arg')
-const { getSpecs, collectResults, findChangedFiles } = require('../src')
+const {
+  getSpecs,
+  collectResults,
+  findChangedFiles,
+  findChangedFilesAgainstParent,
+} = require('../src')
 const { pickTaggedTestsFrom } = require('../src/tagged')
 const { addCounts } = require('../src/count')
 const { stringAllInfo } = require('../src/print')
@@ -18,6 +23,8 @@ const args = arg({
   '--json': Boolean,
   // find the specs that have changed against this Git branch
   '--branch': String,
+  // find the specs that have changed against the parent of this branch
+  '--parent': Boolean,
   '--count': Boolean,
   // filter all tests to those that have the given tag
   '--tagged': String,
@@ -119,6 +126,16 @@ if (args['--names'] || args['--tags']) {
   } else {
     console.log(changedSpecs.join(','))
   }
+} else if (args['--parent']) {
+  debug('determining specs changed against the parent of this branch')
+  const changedFiles = findChangedFilesAgainstParent()
+  debug('changed files %o', changedFiles)
+  const changedSpecs = specs.filter((file) => changedFiles.includes(file))
+  if (args['--count']) {
+    console.log(changedSpecs.length)
+  } else {
+    console.log(changedSpecs.join(','))
+  }
 } else {
   console.log(specs.join(','))
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "find-cypress-specs",
-  "version": "1.14.0",
+  "version": "1.15.0",
   "description": "Find Cypress spec files using the config settings",
   "main": "src",
   "files": [
@@ -40,7 +40,7 @@
   "homepage": "https://github.com/bahmutov/find-cypress-specs#readme",
   "devDependencies": {
     "ava": "^4.0.0",
-    "cypress": "9.5.1",
+    "cypress": "9.5.3",
     "execa-wrap": "^1.4.0",
     "prettier": "^2.5.1",
     "semantic-release": "19.0.2"
@@ -49,7 +49,7 @@
     "arg": "^5.0.1",
     "console.table": "^0.10.0",
     "debug": "^4.3.3",
-    "find-test-names": "^1.14.1",
+    "find-test-names": "^1.15.1",
     "globby": "^11.0.4",
     "minimatch": "^3.0.4",
     "pluralize": "^8.0.0",

package/src/index.js

@@ -115,10 +115,34 @@ function findChangedFiles(branch) {
     return []
   }
 
-  const result = shell.exec(
-    `git diff --name-only --diff-filter=AMR origin/${branch}`,
-    { silent: true },
-  )
+  // can we find updated and added files?
+  debug('finding changed files against %s', branch)
+  const command = `git diff --name-only --diff-filter=AMR origin/${branch}`
+  debug('command: %s', command)
+
+  const result = shell.exec(command, { silent: true })
+  if (result.code !== 0) {
+    debug('git diff failed with code %d', result.code)
+    return []
+  }
+
+  const filenames = result.stdout.split('\n').filter(Boolean)
+  return filenames
+}
+
+/**
+ * Finds files modified or added against the parent commit of the current branch.
+ * Returns a list of filenames. If there are no files, returns an empty list.
+ */
+function findChangedFilesAgainstParent() {
+  if (!shell.which('git')) {
+    shell.echo('Sorry, this script requires git')
+    return []
+  }
+
+  const result = shell.exec(`git diff --name-only --diff-filter=AMR HEAD^!`, {
+    silent: true,
+  })
   if (result.code !== 0) {
     debug('git diff failed with code %d', result.code)
     return []
@@ -135,4 +159,5 @@ module.exports = {
   findCypressSpecs,
   collectResults,
   findChangedFiles,
+  findChangedFilesAgainstParent,
 }