find-cypress-specs 1.15.0 → 1.17.0

package/README.md

@@ -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`.
@@ -22,22 +24,17 @@ $ npx find-cypress-specs --branch main
 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
+$ npx find-cypress-specs --branch main --parent
 # same as
-# git diff --name-only --diff-filter=AMR HEAD^!
+# git diff --name-only --diff-filter=AMR $(git merge-base origin/main 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
+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
@@ -50,6 +47,16 @@ $ npx find-cypress-specs --branch main --count
 5
 ```
 
+### filter by a tag
+
+You can filter all changed specs and only report (and count) the specs that have changed AND include the given tag(s)
+
+```bash
+$ npx find-cypress-specs --branch main --tagged @user,@preview
+# prints only some specs, the ones that have changed against the "origin/main"
+# and that have any tests or suites inside tagged "@user" or "@preview"
+```
+
 ## Test names
 
 You can print each spec file with the suite and test names inside of it (found using [find-test-names](https://github.com/bahmutov/find-test-names))
@@ -122,6 +129,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

package/bin/find.js

@@ -1,12 +1,7 @@
 #!/usr/bin/env node
 
 const arg = require('arg')
-const {
-  getSpecs,
-  collectResults,
-  findChangedFiles,
-  findChangedFilesAgainstParent,
-} = require('../src')
+const { getSpecs, collectResults, findChangedFiles } = require('../src')
 const { pickTaggedTestsFrom } = require('../src/tagged')
 const { addCounts } = require('../src/count')
 const { stringAllInfo } = require('../src/print')
@@ -23,7 +18,7 @@ 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
+  // 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
@@ -118,19 +113,31 @@ 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']) {
-    console.log(changedSpecs.length)
-  } else {
-    console.log(changedSpecs.join(','))
+  debug('comparing against the specs %o', specs)
+  let changedSpecs = specs.filter((file) => changedFiles.includes(file))
+  debug('changed specs %o', changedSpecs)
+
+  if (args['--tagged']) {
+    const splitTags = args['--tagged']
+      .split(',')
+      .map((s) => s.trim())
+      .filter(Boolean)
+    debug('filtering changed specs by tags %o', splitTags)
+    changedSpecs = changedSpecs.filter((file) => {
+      const source = fs.readFileSync(file, 'utf8')
+      const result = getTestNames(source, true)
+      const specTagCounts = countTags(result.structure)
+      const specHasTags = Object.keys(specTagCounts).some((tag) =>
+        splitTags.includes(tag),
+      )
+      debug('spec %s has tags? %o', file, specHasTags)
+
+      return specHasTags
+    })
   }
-} 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 {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "find-cypress-specs",
-  "version": "1.15.0",
+  "version": "1.17.0",
   "description": "Find Cypress spec files using the config settings",
   "main": "src",
   "files": [
@@ -43,7 +43,10 @@
     "cypress": "9.5.3",
     "execa-wrap": "^1.4.0",
     "prettier": "^2.5.1",
-    "semantic-release": "19.0.2"
+    "really-need": "^1.9.2",
+    "semantic-release": "19.0.2",
+    "sinon": "^13.0.1",
+    "typescript": "^4.6.3"
   },
   "dependencies": {
     "arg": "^5.0.1",

package/src/index.js

@@ -4,6 +4,7 @@ const path = require('path')
 const globby = require('globby')
 const minimatch = require('minimatch')
 const shell = require('shelljs')
+const pluralize = require('pluralize')
 
 const MINIMATCH_OPTIONS = { dot: true, matchBase: true }
 
@@ -25,7 +26,7 @@ function getConfig(filename = 'cypress.json') {
 function findCypressSpecs(opts = {}) {
   const defaults = {
     integrationFolder: 'cypress/integration',
-    testFiles: '**/*.js',
+    testFiles: '**/*.{js,ts}',
     ignoreTestFiles: [],
   }
   const options = {
@@ -104,8 +105,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')
   }
@@ -117,39 +119,53 @@ function findChangedFiles(branch) {
 
   // 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)
+  debug('using parent?', useParent)
 
-  const result = shell.exec(command, { silent: true })
-  if (result.code !== 0) {
-    debug('git diff failed with code %d', result.code)
-    return []
-  }
+  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 filenames = result.stdout.split('\n').filter(Boolean)
-  return filenames
-}
+    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 []
+    }
 
-/**
- * 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 filenames = result.stdout
+      .split('\n')
+      .filter(Boolean)
+      .map((s) => s.trim())
+    return filenames
+  } else {
+    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 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 []
+    const filenames = result.stdout
+      .split('\n')
+      .filter(Boolean)
+      .map((s) => s.trim())
+    debug(
+      'found %d changed %s',
+      filenames.length,
+      pluralize('file', filenames.length),
+    )
+    return filenames
   }
-
-  const filenames = result.stdout.split('\n').filter(Boolean)
-  return filenames
 }
 
 module.exports = {
@@ -159,5 +175,4 @@ module.exports = {
   findCypressSpecs,
   collectResults,
   findChangedFiles,
-  findChangedFilesAgainstParent,
 }