find-cypress-specs 1.35.2 → 1.36.0

package/README.md

@@ -300,6 +300,14 @@ If you want to use a custom Cypress config, pass it via the environment variable
 $ CYPRESS_CONFIG_FILE=path/to/cypress.config.js npx find-cypres-specs ...
 ```
 
+## Absolute spec filenames
+
+You can return absolute filenames to the found specs
+
+```js
+getSpecs(config, 'e2e|component', true)
+```
+
 ## Details
 
 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.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "find-cypress-specs",
-  "version": "1.35.2",
+  "version": "1.36.0",
   "description": "Find Cypress spec files using the config settings",
   "main": "src",
   "files": [

package/src/files.js

@@ -0,0 +1,14 @@
+// @ts-check
+const { relative } = require('path')
+
+/**
+ * Converts a list of absolute filenames to the list of relative filenames
+ * @param {string[]} filenames List of absolute filenames
+ * @returns {string[]} List of relative filenames to the current working directory
+ */
+function toRelative(filenames) {
+  const cwd = process.cwd()
+  return filenames.map((filename) => relative(cwd, filename))
+}
+
+module.exports = { toRelative }

package/src/index.js

@@ -54,16 +54,18 @@ function getConfig() {
   if (typeof process.env.CYPRESS_CONFIG_FILE !== 'undefined') {
     const configFile = process.env.CYPRESS_CONFIG_FILE
     if (configFile.endsWith('.js')) {
-      debug(`found file ${configFile}`);
+      debug(`found file ${configFile}`)
       return getConfigJs(`./${configFile}`)
     } else if (configFile.endsWith('.ts')) {
-      debug(`found file ${configFile}`);
+      debug(`found file ${configFile}`)
       return getConfigTs(`./${configFile}`)
     } else if (configFile.endsWith('.json')) {
-      debug(`found file ${configFile}`);
+      debug(`found file ${configFile}`)
       return getConfigJson(`./${configFile}`)
-    } 
-    throw new Error('Config file should be .ts, .js or .json file even when using CYPRESS_CONFIG_FILE env var')
+    }
+    throw new Error(
+      'Config file should be .ts, .js or .json file even when using CYPRESS_CONFIG_FILE env var',
+    )
   }
 
   if (fs.existsSync('./cypress.config.js')) {
@@ -129,7 +131,7 @@ function findCypressSpecsV9(opts = {}) {
   return filtered.map((file) => path.join(options.integrationFolder, file))
 }
 
-function findCypressSpecsV10(opts = {}, type = 'e2e') {
+function findCypressSpecsV10(opts = {}, type = 'e2e', returnAbsolute = false) {
   debug('findCypressSpecsV10')
   if (type !== 'e2e' && type !== 'component') {
     throw new Error(`Unknown spec type ${type}`)
@@ -170,6 +172,7 @@ function findCypressSpecsV10(opts = {}, type = 'e2e') {
   const globbyOptions = {
     sort: true,
     ignore,
+    absolute: returnAbsolute,
   }
   debug('globby options %s %o', options.specPattern, globbyOptions)
 
@@ -210,7 +213,7 @@ function findCypressSpecsV10(opts = {}, type = 'e2e') {
   return filtered
 }
 
-function getSpecs(options, type) {
+function getSpecs(options, type, returnAbsolute = false) {
   if (typeof options === 'undefined') {
     options = getConfig()
     if (typeof type === 'undefined') {
@@ -231,10 +234,15 @@ function getSpecs(options, type) {
     }
   }
 
-  return findCypressSpecs(options, type)
+  return findCypressSpecs(options, type, returnAbsolute)
 }
 
-function findCypressSpecs(options, type = 'e2e') {
+/**
+ * Finds Cypress specs.
+ * @param {boolean} returnAbsolute Return the list of absolute spec filenames
+ * @returns {string[]} List of filenames
+ */
+function findCypressSpecs(options, type = 'e2e', returnAbsolute = false) {
   debug('finding specs of type %s', type)
   if (options.version) {
     debug('Cypress version %s', options.version)
@@ -254,7 +262,7 @@ function findCypressSpecs(options, type = 'e2e') {
   if (type === 'e2e') {
     if (major >= 10) {
       debug('config has "e2e" property, treating as Cypress v10+')
-      const specs = findCypressSpecsV10(options, type)
+      const specs = findCypressSpecsV10(options, type, returnAbsolute)
       return specs
     }
 
@@ -263,7 +271,7 @@ function findCypressSpecs(options, type = 'e2e') {
     return specs
   } else if (type === 'component') {
     debug('finding component specs')
-    const specs = findCypressSpecsV10(options, type)
+    const specs = findCypressSpecsV10(options, type, returnAbsolute)
     return specs
   } else {
     console.error('Do not know how to find specs of type "%s"', type)