find-cypress-specs 1.41.4 → 1.43.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-13.6.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-specs [![renovate-app badge][renovate-badge]][renovate-app] ![cypress version](https://img.shields.io/badge/cypress-13.6.4-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
 
@@ -38,6 +38,16 @@ $ npx find-cypress-specs --branch main
 # prints only some specs, the ones that have changed against the "origin/main"
 ```
 
+## find number of machines
+
+If we find all the changed specs to run, we might need to decide how many machines we need. We can do a rough job by specifying the number of specs per machine plus the max number.
+
+```
+$ npx find-cypress-specs --branch main --specs-per-machine 4 --max-machines 5
+```
+
+For now, it is only useful when setting the GHA outputs.
+
 ## set GitHub Actions outputs
 
 If you add `--set-gha-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
@@ -52,6 +62,8 @@ If you add `--set-gha-outputs` command line switch, then the number of changed s
   run: echo ${{ steps.step1.outputs.changedSpecsN }} ${{ steps.step1.outputs.changedSpecs }}
 ```
 
+If you set the number of machines, it will set the output `machinesNeeded`
+
 ## Write GitHub Actions job summary
 
 You can output changes specs by using the parameter `--gha-summary`
@@ -290,7 +302,7 @@ $ npx find-cypress-specs --names --skipped --count
 
 ## 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.
+If the project uses TypeScript and `cypress.config.ts` then this module uses [tsx](https://github.com/privatenumber/tsx) to load the config and fetch the spec pattern.
 
 If you are using `import` keyword in your `cypress.config.ts` you might get an error like this:
 

package/bin/find.js

@@ -53,6 +53,9 @@ const args = arg({
   '--update-badge': Boolean,
   // output the list in Markdown format
   '--markdown': Boolean,
+  // optional: output the number of machines needed to run the tests
+  '--specs-per-machine': Number,
+  '--max-machines': Number,
   //
   // aliases
   '-n': '--names',
@@ -188,13 +191,35 @@ if (args['--test-counts']) {
       })
     }
 
+    let machinesNeeded
+    if (args['--specs-per-machine'] > 0 && args['--max-machines'] > 0) {
+      const specsPerMachine = args['--specs-per-machine']
+      const maxMachines = args['--max-machines']
+      machinesNeeded = Math.min(
+        Math.ceil(changedSpecs.length / specsPerMachine),
+        maxMachines,
+      )
+      debug(
+        'specs per machine %d with max %d machines',
+        specsPerMachine,
+        maxMachines,
+      )
+      debug(
+        'from %d specs, set %d output machinesNeeded',
+        changedSpecs.length,
+        machinesNeeded,
+      )
+    }
+
     if (args['--set-gha-outputs']) {
       debug('setting GitHub Actions outputs changedSpecsN and changedSpecs')
       debug('changedSpecsN %d', changedSpecs.length)
       debug('plus changedSpecs')
       core.setOutput('changedSpecsN', changedSpecs.length)
       core.setOutput('changedSpecs', changedSpecs.join(','))
+      core.setOutput('machinesNeeded', machinesNeeded)
     }
+
     if (args['--gha-summary']) {
       debug('writing GitHub Actions summary')
       const summary = changedSpecs.length

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "find-cypress-specs",
-  "version": "1.41.4",
+  "version": "1.43.0",
   "description": "Find Cypress spec files using the config settings",
   "main": "src",
   "files": [
@@ -55,12 +55,12 @@
   "homepage": "https://github.com/bahmutov/find-cypress-specs#readme",
   "devDependencies": {
     "ava": "^4.0.0",
-    "cypress": "13.6.3",
+    "cypress": "13.6.4",
     "dependency-version-badge": "^1.11.0",
     "execa-wrap": "^1.4.0",
     "prettier": "^2.5.1",
     "really-need": "^1.9.2",
-    "semantic-release": "23.0.0",
+    "semantic-release": "23.0.2",
     "sinon": "^13.0.1",
     "typescript": "^4.6.3"
   },
@@ -76,6 +76,6 @@
     "require-and-forget": "^1.0.1",
     "shelljs": "^0.8.5",
     "spec-change": "^1.10.0",
-    "ts-node": "^10.9.1"
+    "tsx": "^4.7.1"
   }
 }

package/src/index.js

@@ -12,6 +12,12 @@ const shell = require('shelljs')
 const pluralize = require('pluralize')
 const requireEveryTime = require('require-and-forget')
 
+// Require CJS loader to resolve:
+// https://github.com/bahmutov/find-cypress-specs/issues/228
+// https://github.com/bahmutov/find-cypress-specs/issues/222
+// https://github.com/privatenumber/tsx
+require('tsx/cjs')
+
 const MINIMATCH_OPTIONS = { dot: true, matchBase: true }
 
 /**
@@ -37,15 +43,6 @@ function getConfigJs(filename) {
 }
 
 function getConfigTs(filename) {
-  // handle ts modules without "type: module"
-  // https://github.com/bahmutov/find-cypress-specs/issues/222
-  const tsNode = require('ts-node')
-  tsNode.register({
-    transpileOnly: true,
-    compilerOptions: {
-      module: 'commonjs',
-    },
-  })
   const configFilename = path.join(process.cwd(), filename)
   debug('loading Cypress config from %s', configFilename)
   const definedConfig = requireEveryTime(configFilename)
@@ -146,8 +143,13 @@ function findCypressSpecsV10(opts = {}, type = 'e2e', returnAbsolute = false) {
   if (type !== 'e2e' && type !== 'component') {
     throw new Error(`Unknown spec type ${type}`)
   }
+  // handle the interoperability loading of default export
+  if (Object.keys(opts).length === 1 && Object.keys(opts)[0] === 'default') {
+    opts = opts.default
+  }
 
   if (!(type in opts)) {
+    debug('options %o', opts)
     throw new Error(`Missing "${type}" object in the Cypress config object`)
   }
   const e2eDefaults = {