find-cypress-specs 1.14.2 → 1.16.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.2-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
 
@@ -8,6 +8,8 @@ $ npx find-cypress-specs
 cypress/e2e/spec.js,cypress/e2e/featureA/user.js
 ```
 
+Supports JS and TS specs
+
 ## against branch
 
 By default, this module simply prints all spec filenames. You can add `--branch` parameter to only print the specs changed against that `origin/branch`.
@@ -17,6 +19,24 @@ $ 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 --branch main --parent
+# same as
+# git diff --name-only --diff-filter=AMR $(git merge-base origin/main HEAD)..
+```
+
+Note: to get the changed files, we need to fetch the repo, see [pr.yml](./.github/workflows/pr.yml)
+
+```
+$ checkout
+$ git fetch
+$ npx find-cypress-specs --branch main --parent
+```
+
 ### number of changed files
 
 You can print just the number of changed specs
@@ -99,6 +119,10 @@ Run the utility with environment variable `DEBUG=find-cypress-specs` to see the
 
 - [Use Ava Snapshots And Execa-wrap To Write End-to-End Tests For CLI Utilities](https://youtu.be/rsw17RqP0G0)
 
+## Examples
+
+- [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/)
+
 ## Small print
 
 Author: Gleb Bahmutov <gleb.bahmutov@gmail.com> © 2022
@@ -109,6 +133,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

@@ -18,6 +18,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 the branch
+  '--parent': Boolean,
   '--count': Boolean,
   // filter all tests to those that have the given tag
   '--tagged': String,
@@ -111,7 +113,7 @@ if (args['--names'] || args['--tags']) {
   }
 } else if (args['--branch']) {
   debug('determining specs changed against branch %s', args['--branch'])
-  const changedFiles = findChangedFiles(args['--branch'])
+  const changedFiles = findChangedFiles(args['--branch'], args['--parent'])
   debug('changed files %o', changedFiles)
   const changedSpecs = specs.filter((file) => changedFiles.includes(file))
   if (args['--count']) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "find-cypress-specs",
-  "version": "1.14.2",
+  "version": "1.16.0",
   "description": "Find Cypress spec files using the config settings",
   "main": "src",
   "files": [
@@ -40,10 +40,11 @@
   "homepage": "https://github.com/bahmutov/find-cypress-specs#readme",
   "devDependencies": {
     "ava": "^4.0.0",
-    "cypress": "9.5.2",
+    "cypress": "9.5.3",
     "execa-wrap": "^1.4.0",
     "prettier": "^2.5.1",
-    "semantic-release": "19.0.2"
+    "semantic-release": "19.0.2",
+    "typescript": "^4.6.3"
   },
   "dependencies": {
     "arg": "^5.0.1",

package/src/index.js

@@ -25,7 +25,7 @@ function getConfig(filename = 'cypress.json') {
 function findCypressSpecs(opts = {}) {
   const defaults = {
     integrationFolder: 'cypress/integration',
-    testFiles: '**/*.js',
+    testFiles: '**/*.{js,ts}',
     ignoreTestFiles: [],
   }
   const options = {
@@ -104,8 +104,9 @@ function collectResults(structure, results) {
  * Finds files changed or added in the current branch when compared to the "origin/branch".
  * Returns a list of filenames. If there are no files, returns an empty list.
  * @param {string} branch The branch to compare against.
+ * @param {boolean} useParent Determine the changes only against the parent commit.
  */
-function findChangedFiles(branch) {
+function findChangedFiles(branch, useParent) {
   if (!branch) {
     throw new Error('branch is required')
   }
@@ -115,17 +116,44 @@ function findChangedFiles(branch) {
     return []
   }
 
-  const result = shell.exec(
-    `git diff --name-only --diff-filter=AMR origin/${branch}`,
-    { silent: true },
-  )
-  if (result.code !== 0) {
-    debug('git diff failed with code %d', result.code)
-    return []
-  }
+  // can we find updated and added files?
+  debug('finding changed files against %s', branch)
+  debug('using parent?', useParent)
+
+  if (useParent) {
+    let result = shell.exec(`git merge-base origin/${branch} HEAD`, {
+      silent: true,
+    })
+    if (result.code !== 0) {
+      debug('git failed to find merge base with the branch %s', branch)
+      return []
+    }
+
+    const commit = result.stdout.trim()
+    debug('merge commit with branch "%s" is %s', branch, commit)
+    result = shell.exec(`git diff --name-only --diff-filter=AMR ${commit}..`, {
+      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
+  } else {
+    const command = `git diff --name-only --diff-filter=AMR origin/${branch}`
+    debug('command: %s', command)
 
-  const filenames = result.stdout.split('\n').filter(Boolean)
-  return filenames
+    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
+  }
 }
 
 module.exports = {