find-cypress-specs 1.0.0

package/README.md

@@ -0,0 +1,52 @@
+# find-cypress-specs ![cypress version](https://img.shields.io/badge/cypress-9.2.0-brightgreen)
+
+> Find Cypress spec files using the config settings
+
+Cypress uses the resolved [configuration values](https://on.cypress.io/configuration) to find the spec files to run. It searches the `integrationFolder` for all patterns listed in `testFiles` and removes any files matching the `ignoreTestFiles` patterns.
+
+You can see how Cypress finds the specs using `DEBUG=cypress:cli,cypress:server:specs` environment variable to see verbose logs.
+
+## Debugging
+
+Run the utility with environment variable `DEBUG=find-cypress-specs` to see the verbose logs
+
+## Small print
+
+Author: Gleb Bahmutov <gleb.bahmutov@gmail.com> © 2022
+
+- [@bahmutov](https://twitter.com/bahmutov)
+- [glebbahmutov.com](https://glebbahmutov.com)
+- [blog](https://glebbahmutov.com/blog)
+- [videos](https://www.youtube.com/glebbahmutov)
+- [presentations](https://slides.com/bahmutov)
+- [cypress.tips](https://cypress.tips)
+
+License: MIT - do anything with the code, but don't blame me if it does not work.
+
+Support: if you find any problems with this module, email / tweet /
+[open issue](https://github.com/bahmutov/find-cypress-specs/issues) on Github
+
+## MIT License
+
+Copyright (c) 2022 Gleb Bahmutov <gleb.bahmutov@gmail.com>
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

package/bin/find.js

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+
+const { getSpecs } = require('../src')
+
+const specs = getSpecs()
+console.log(specs.join(','))

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "find-cypress-specs",
+  "version": "1.0.0",
+  "description": "Find Cypress spec files using the config settings",
+  "main": "src",
+  "files": [
+    "bin",
+    "src"
+  ],
+  "bin": {
+    "find-cypress-specs": "bin/find.js"
+  },
+  "scripts": {
+    "test": "ava",
+    "cy:run": "DEBUG=cypress:cli,cypress:server:specs cypress run",
+    "demo": "DEBUG=find-cypress-specs node ./bin/find",
+    "semantic-release": "semantic-release"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bahmutov/find-cypress-specs.git"
+  },
+  "keywords": [
+    "cypress-plugin"
+  ],
+  "author": "Gleb Bahmutov <gleb.bahmutov@mail.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/bahmutov/find-cypress-specs/issues"
+  },
+  "homepage": "https://github.com/bahmutov/find-cypress-specs#readme",
+  "devDependencies": {
+    "ava": "^4.0.0",
+    "cypress": "^9.2.0",
+    "prettier": "^2.5.1",
+    "semantic-release": "^18.0.1"
+  },
+  "dependencies": {
+    "debug": "^4.3.3",
+    "globby": "^11.0.4"
+  }
+}

package/src/index.js

@@ -0,0 +1,54 @@
+const debug = require('debug')('find-cypress-specs')
+const fs = require('fs')
+const path = require('path')
+const globby = require('globby')
+
+/**
+ * Reads the cypress config file and returns the relevant properties
+ */
+function getConfig(filename = 'cypress.json') {
+  const s = fs.readFileSync(filename, 'utf8')
+  const config = JSON.parse(s)
+  const options = {
+    integrationFolder: config.integrationFolder,
+    testFiles: config.testFiles,
+    ignoreTestFiles: config.ignoreTestFiles,
+  }
+  debug('got config options %o', options)
+  return options
+}
+
+function findCypressSpecs(opts = {}) {
+  const defaults = {
+    integrationFolder: 'cypress/integration',
+    testFiles: '**/*.js',
+    ignoreTestFiles: [],
+  }
+  const options = {
+    ...defaults,
+    ...opts,
+  }
+  debug('options %o', options)
+
+  const files = globby.sync(options.testFiles, {
+    cwd: options.integrationFolder,
+    ignore: options.ignoreTestFiles,
+  })
+  debug('found %d file(s) %o', files.length, files)
+
+  // return spec files with the added integration folder prefix
+  return files.map((file) => path.join(options.integrationFolder, file))
+}
+
+function getSpecs() {
+  const options = getConfig()
+  const specs = findCypressSpecs(options)
+  return specs
+}
+
+module.exports = {
+  getSpecs,
+  // individual utilities
+  getConfig,
+  findCypressSpecs,
+}