find-cypress-specs 1.26.0 → 1.27.1

package/README.md

@@ -10,6 +10,14 @@ cypress/e2e/spec.js,cypress/e2e/featureA/user.js
 
 Supports JS and TS specs
 
+## Component specs
+
+By default, it finds the E2E specs and tests. You can find component specs using `--component` CLI option
+
+```
+$ npx find-cypress-specs --component
+```
+
 ## 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`.

package/bin/find.js

@@ -40,6 +40,8 @@ const args = arg({
   '--time-trace': Boolean,
   // do not add more than this number of extra specs after tracing
   '--max-added-traced-specs': Number,
+  // find component specs
+  '--component': Boolean,
   // aliases
   '-n': '--names',
   '--name': '--names',
@@ -55,8 +57,10 @@ const args = arg({
 })
 
 debug('arguments %o', args)
+const specType = args['--component'] ? 'component' : 'e2e'
+
+const specs = getSpecs(undefined, specType)
 
-const specs = getSpecs()
 if (args['--names'] || args['--tags']) {
   // counts the number of tests for each tag across all specs
   const { jsonResults, tagTestCounts } = getTests(specs, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "find-cypress-specs",
-  "version": "1.26.0",
+  "version": "1.27.1",
   "description": "Find Cypress spec files using the config settings",
   "main": "src",
   "files": [
@@ -27,7 +27,8 @@
     "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 --time-trace --cache-trace"
+    "deps-changed": "DEBUG=find-cypress-specs node ./bin/find --branch main --parent --trace-imports cypress --time-trace --cache-trace",
+    "demo-component": "DEBUG=find-cypress-specs node ./bin/find --component --names"
   },
   "repository": {
     "type": "git",

package/src/index.js

@@ -113,19 +113,36 @@ function findCypressSpecsV9(opts = {}) {
   return filtered.map((file) => path.join(options.integrationFolder, file))
 }
 
-function findCypressSpecsV10(opts = {}) {
-  if (!('e2e' in opts)) {
-    throw new Error('Missing e2e in the config object')
+function findCypressSpecsV10(opts = {}, type = 'e2e') {
+  if (type !== 'e2e' && type !== 'component') {
+    throw new Error(`Unknown spec type ${type}`)
   }
-  const defaults = {
+
+  if (!(type in opts)) {
+    throw new Error(`Missing "${type}" object in the Cypress config object`)
+  }
+  const e2eDefaults = {
     specPattern: 'cypress/e2e/**/*.cy.{js,jsx,ts,tsx}',
     excludeSpecPattern: [],
   }
-  const options = {
-    specPattern: opts.e2e.specPattern || defaults.specPattern,
-    excludeSpecPattern:
-      opts.e2e.excludeSpecPattern || defaults.excludeSpecPattern,
+  const componentDefaults = {
+    specPattern: '**/*.cy.{js,jsx,ts,tsx}',
+    excludeSpecPattern: ['/snapshots/*', '/image_snapshots/*'],
+  }
+  // https://on.cypress.io/configuration
+  const options = {}
+
+  if (type === 'e2e') {
+    options.specPattern = opts.e2e.specPattern || e2eDefaults.specPattern
+    options.excludeSpecPattern =
+      opts.e2e.excludeSpecPattern || e2eDefaults.excludeSpecPattern
+  } else if (type === 'component') {
+    options.specPattern =
+      opts.component.specPattern || componentDefaults.specPattern
+    options.excludeSpecPattern =
+      opts.component.excludeSpecPattern || componentDefaults.excludeSpecPattern
   }
+
   debug('options v10 %o', options)
 
   const files = globby.sync(options.specPattern, {
@@ -137,6 +154,13 @@ function findCypressSpecsV10(opts = {}) {
   // go through the files again and eliminate files that match
   // the ignore patterns
   const ignorePatterns = [].concat(options.excludeSpecPattern)
+
+  // when using component spec pattern, ignore all E2E specs
+  if (type === 'component') {
+    const e2eIgnorePattern = options.e2e?.specPattern || e2eDefaults.specPattern
+    ignorePatterns.push(e2eIgnorePattern)
+  }
+
   debug('ignore patterns %o', ignorePatterns)
 
   // a function which returns true if the file does NOT match
@@ -159,23 +183,51 @@ function findCypressSpecsV10(opts = {}) {
   return filtered
 }
 
-function getSpecs(options) {
+function getSpecs(options, type) {
   if (typeof options === 'undefined') {
     options = getConfig()
+    if (typeof type === 'undefined') {
+      type = 'e2e'
+    }
+  } else {
+    // we might have resolved config object
+    // passed from the "setupNode..." callback
+    if ('testingType' in options) {
+      type = options.testingType
+      options = {
+        [type]: {
+          specPattern: options.specPattern,
+          excludeSpecPattern: options.excludeSpecPattern,
+        },
+      }
+    }
   }
-  return findCypressSpecs(options)
+
+  return findCypressSpecs(options, type)
 }
 
-function findCypressSpecs(options) {
-  if (options.e2e) {
-    debug('config has "e2e" property, treating as Cypress v10+')
-    const specs = findCypressSpecsV10(options)
+function findCypressSpecs(options, type = 'e2e') {
+  debug('finding specs of type %s', type)
+
+  if (type === 'e2e') {
+    if (options.e2e) {
+      debug('config has "e2e" property, treating as Cypress v10+')
+      const specs = findCypressSpecsV10(options, type)
+      return specs
+    }
+
+    debug('reading Cypress config < v10')
+    const specs = findCypressSpecsV9(options)
+    return specs
+  } else if (type === 'component') {
+    debug('finding component specs')
+    const specs = findCypressSpecsV10(options, type)
     return specs
+  } else {
+    console.error('Do not know how to find specs of type "%s"', type)
+    console.error('returning an empty list')
+    return []
   }
-
-  debug('reading Cypress config < v10')
-  const specs = findCypressSpecsV9(options)
-  return specs
 }
 
 function collectResults(structure, results) {