find-cypress-specs 1.25.3 → 1.27.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-12.5.0-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-12.7.0-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
 
@@ -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`.
@@ -224,6 +232,8 @@ You can see how Cypress finds the specs using `DEBUG=cypress:cli,cypress:server:
 
 Run the utility with environment variable `DEBUG=find-cypress-specs` to see the verbose logs
 
+![Debug output](./images/debug.png)
+
 ## Videos
 
 - [Use Ava Snapshots And Execa-wrap To Write End-to-End Tests For CLI Utilities](https://youtu.be/rsw17RqP0G0)
@@ -237,6 +247,8 @@ Run the utility with environment variable `DEBUG=find-cypress-specs` to see the
 
 You can use this module via its NPM module API.
 
+### getSpecs
+
 ```js
 const { getSpecs } = require('find-cypress-specs')
 // somewhere in the cypress.config.js
@@ -246,6 +258,30 @@ setupNodeEvents(on, config) {
 }
 ```
 
+You can pass the `config` object to the `getSpecs` method. If there is no `config` parameter, it will read the config file automatically.
+
+```js
+const specs = getSpecs({
+  e2e: {
+    specPattern: '*/e2e/featureA/*.cy.ts',
+  },
+})
+// ['cypress/e2e/featureA/spec.cy.ts']
+```
+
+### getTests
+
+Returns an object with individual test information
+
+```js
+const { getTests } = require('find-cypress-specs')
+const { jsonResults, tagTestCounts } = getTests()
+// jsonResults is an object
+// with an entry per spec file
+```
+
+See [get-tests.js](./test/npm/get-tests.js) for details and examples.
+
 ## Small print
 
 Author: Gleb Bahmutov <gleb.bahmutov@gmail.com> © 2022

package/bin/find.js

@@ -1,9 +1,7 @@
 #!/usr/bin/env node
 
 const arg = require('arg')
-const { getSpecs, collectResults, findChangedFiles } = require('../src')
-const { pickTaggedTestsFrom, leavePendingTestsOnly } = require('../src/tagged')
-const { addCounts } = require('../src/count')
+const { getSpecs, findChangedFiles, getTests } = require('../src')
 const { stringAllInfo } = require('../src/print')
 
 const fs = require('fs')
@@ -42,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',
@@ -57,95 +57,50 @@ const args = arg({
 })
 
 debug('arguments %o', args)
+const specType = args['--component'] ? 'component' : 'e2e'
 
-const specs = getSpecs()
-if (args['--names'] || args['--tags']) {
-  if (!specs.length) {
-    console.log('no specs found')
-  } else {
-    console.log('')
-    // counts the number of tests for each tag across all specs
-    const tagTestCounts = {}
-    const jsonResults = {}
-
-    specs.forEach((filename) => {
-      jsonResults[filename] = {
-        counts: {
-          tests: 0,
-          pending: 0,
-        },
-        tests: [],
-      }
-      const source = fs.readFileSync(filename, 'utf8')
-      const result = getTestNames(source, true)
-      // enable if need to debug the parsed test
-      // console.dir(result.structure, { depth: null })
-      collectResults(result.structure, jsonResults[filename].tests)
-
-      if (args['--tags']) {
-        const specTagCounts = countTags(result.structure)
-        Object.keys(specTagCounts).forEach((tag) => {
-          if (!(tag in tagTestCounts)) {
-            tagTestCounts[tag] = specTagCounts[tag]
-          } else {
-            tagTestCounts[tag] += specTagCounts[tag]
-          }
-        })
-      }
-    })
-
-    addCounts(jsonResults)
-
-    if (args['--names']) {
-      if (args['--tagged']) {
-        // filter all collected tests to those that have the given tag(s)
-        const splitTags = args['--tagged']
-          .split(',')
-          .map((s) => s.trim())
-          .filter(Boolean)
-        debug('filtering all tests by tag "%o"', splitTags)
-        pickTaggedTestsFrom(jsonResults, splitTags)
-        // recompute the number of tests
-        addCounts(jsonResults)
-      } else if (args['--skipped']) {
-        debug('leaving only skipped (pending) tests')
-        leavePendingTestsOnly(jsonResults)
-        // recompute the number of tests
-        addCounts(jsonResults)
-      }
+const specs = getSpecs(undefined, specType)
 
-      if (args['--count']) {
-        let n = 0
-        Object.keys(jsonResults).forEach((filename) => {
-          const skippedCount = jsonResults[filename].counts.pending
-          n += skippedCount
-        })
-        console.log(n)
-      } else {
-        if (args['--json']) {
-          console.log(JSON.stringify(jsonResults, null, 2))
-        } else {
-          const str = stringAllInfo(jsonResults)
-          console.log(str)
-        }
-        console.log('')
-      }
-    }
-
-    if (args['--tags']) {
-      const tagEntries = Object.entries(tagTestCounts)
-      const sortedTagEntries = tagEntries.sort((a, b) => {
-        // every entry is [tag, count], so compare the tags
-        return a[0].localeCompare(b[0])
+if (args['--names'] || args['--tags']) {
+  // counts the number of tests for each tag across all specs
+  const { jsonResults, tagTestCounts } = getTests(specs, {
+    tags: args['--tags'],
+    tagged: args['--tagged'],
+    skipped: args['--skipped'],
+  })
+
+  if (args['--names']) {
+    if (args['--count']) {
+      let n = 0
+      Object.keys(jsonResults).forEach((filename) => {
+        const skippedCount = jsonResults[filename].counts.pending
+        n += skippedCount
       })
+      console.log(n)
+    } else {
       if (args['--json']) {
-        // assemble a json object with the tag counts
-        const tagResults = Object.fromEntries(sortedTagEntries)
-        console.log(JSON.stringify(tagResults, null, 2))
+        console.log(JSON.stringify(jsonResults, null, 2))
       } else {
-        const table = consoleTable.getTable(['Tag', 'Tests'], sortedTagEntries)
-        console.log(table)
+        const str = stringAllInfo(jsonResults)
+        console.log(str)
       }
+      console.log('')
+    }
+  }
+
+  if (args['--tags']) {
+    const tagEntries = Object.entries(tagTestCounts)
+    const sortedTagEntries = tagEntries.sort((a, b) => {
+      // every entry is [tag, count], so compare the tags
+      return a[0].localeCompare(b[0])
+    })
+    if (args['--json']) {
+      // assemble a json object with the tag counts
+      const tagResults = Object.fromEntries(sortedTagEntries)
+      console.log(JSON.stringify(tagResults, null, 2))
+    } else {
+      const table = consoleTable.getTable(['Tag', 'Tests'], sortedTagEntries)
+      console.log(table)
     }
   }
 } else if (args['--branch']) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "find-cypress-specs",
-  "version": "1.25.3",
+  "version": "1.27.0",
   "description": "Find Cypress spec files using the config settings",
   "main": "src",
   "files": [
@@ -14,9 +14,9 @@
     "test": "ava",
     "cy:run": "DEBUG=cypress:cli,cypress:server:specs cypress run",
     "demo": "DEBUG=find-cypress-specs node ./bin/find",
-    "demo-names": "node ./bin/find --names",
-    "demo-skipped-tests": "node ./bin/find --names --skipped",
-    "demo-count-skipped-tests": "node ./bin/find --names --skipped --count",
+    "demo-names": "DEBUG=find-cypress-specs node ./bin/find --names",
+    "demo-skipped-tests": "DEBUG=find-cypress-specs node ./bin/find --names --skipped",
+    "demo-count-skipped-tests": "DEBUG=find-cypress-specs node ./bin/find --names --skipped --count",
     "demo-tags": "node ./bin/find --tags",
     "demo-tags-json": "node ./bin/find --tags --json",
     "demo-names-and-tags": "node ./bin/find --names --tags",
@@ -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",
@@ -44,7 +45,7 @@
   "homepage": "https://github.com/bahmutov/find-cypress-specs#readme",
   "devDependencies": {
     "ava": "^4.0.0",
-    "cypress": "12.5.0",
+    "cypress": "12.7.0",
     "execa-wrap": "^1.4.0",
     "prettier": "^2.5.1",
     "really-need": "^1.9.2",

package/src/index.js

@@ -1,3 +1,7 @@
+const { addCounts } = require('../src/count')
+const { getTestNames, countTags } = require('find-test-names')
+const { pickTaggedTestsFrom, leavePendingTestsOnly } = require('../src/tagged')
+
 const debug = require('debug')('find-cypress-specs')
 const fs = require('fs')
 const path = require('path')
@@ -109,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, {
@@ -133,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
@@ -155,21 +183,35 @@ function findCypressSpecsV10(opts = {}) {
   return filtered
 }
 
-function getSpecs() {
-  const options = getConfig()
-  return findCypressSpecs(options)
+function getSpecs(options, type = 'e2e') {
+  if (typeof options === 'undefined') {
+    options = getConfig()
+  }
+  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) {
@@ -266,6 +308,68 @@ function findChangedFiles(branch, useParent) {
   }
 }
 
+/**
+ * Collects all specs and for each finds all suits and tests with their tags.
+ */
+function getTests(specs, options = {}) {
+  if (!specs) {
+    specs = getSpecs()
+  }
+
+  const { tags, tagged, skipped } = options
+
+  // counts the number of tests for each tag across all specs
+  const tagTestCounts = {}
+  const jsonResults = {}
+
+  specs.forEach((filename) => {
+    jsonResults[filename] = {
+      counts: {
+        tests: 0,
+        pending: 0,
+      },
+      tests: [],
+    }
+    const source = fs.readFileSync(filename, 'utf8')
+    const result = getTestNames(source, true)
+    // enable if need to debug the parsed test
+    // console.dir(result.structure, { depth: null })
+    collectResults(result.structure, jsonResults[filename].tests)
+
+    if (tags) {
+      const specTagCounts = countTags(result.structure)
+      Object.keys(specTagCounts).forEach((tag) => {
+        if (!(tag in tagTestCounts)) {
+          tagTestCounts[tag] = specTagCounts[tag]
+        } else {
+          tagTestCounts[tag] += specTagCounts[tag]
+        }
+      })
+    }
+  })
+
+  addCounts(jsonResults)
+
+  if (tagged) {
+    // filter all collected tests to those that have the given tag(s)
+    const splitTags = tagged
+      .split(',')
+      .map((s) => s.trim())
+      .filter(Boolean)
+    debug('filtering all tests by tag "%o"', splitTags)
+    pickTaggedTestsFrom(jsonResults, splitTags)
+    // recompute the number of tests
+    addCounts(jsonResults)
+  } else if (skipped) {
+    debug('leaving only skipped (pending) tests')
+    leavePendingTestsOnly(jsonResults)
+    // recompute the number of tests
+    addCounts(jsonResults)
+  }
+
+  return { jsonResults, tagTestCounts }
+}
+
 module.exports = {
   getSpecs,
   // individual utilities
@@ -273,4 +377,5 @@ module.exports = {
   findCypressSpecs,
   collectResults,
   findChangedFiles,
+  getTests,
 }