feat: allow cypress.config.js to be a default config file

packages/desktop-gui/src/lib/config-file-formatted.jsx

@@ -6,8 +6,8 @@ const configFileFormatted = (configFile) => {
     return <><code>cypress.json</code> file (currently disabled by <code>--config-file false</code>)</>
   }
 
-  if (isUndefined(configFile) || configFile === 'cypress.json') {
-    return <><code>cypress.json</code> file</>
+  if (isUndefined(configFile) || ['cypress.json', 'cypress.config.js'].includes(configFile)) {
+    return <><code>{configFile}</code> file</>
   }
 
   return <>custom config file <code>{configFile}</code></>

packages/server/lib/config.ts

@@ -9,7 +9,7 @@ import scaffold from './scaffold'
 import { fs } from './util/fs'
 import keys from './util/keys'
 import origin from './util/origin'
-import settings from './util/settings'
+import * as settings from './util/settings'
 import Debug from 'debug'
 import pathHelpers from './util/path_helpers'
 import findSystemNode from './util/find_system_node'

packages/server/lib/configFiles.ts

@@ -0,0 +1,2 @@
+// the first file is the default created file
+export const CYPRESS_CONFIG_FILES = ['cypress.json', 'cypress.config.js']

packages/server/lib/errors.js

@@ -694,6 +694,19 @@ const getMsgByType = function (type, arg1 = {}, arg2, arg3) {
         ${chalk.yellow(arg1.error)}
 
         Learn more at https://on.cypress.io/reporters`
+      // TODO: update with vetted cypress language
+    case 'NO_DEFAULT_CONFIG_FILE_FOUND':
+      return stripIndent`\
+        Could not find a Cypress configuration file, exiting.
+
+        We looked but did not find a default config file in this folder: ${chalk.blue(arg1)}`
+      // TODO: update with vetted cypress language
+    case 'CONFIG_FILES_LANGUAGE_CONFLICT':
+      return stripIndent`
+          There is both a \`${arg2}\` and a \`${arg3}\` at the location below:
+          ${arg1}
+          Cypress does not know which one to read for config. Please remove one of the two and try again.
+          `
     case 'CONFIG_FILE_NOT_FOUND':
       return stripIndent`\
         Could not find a Cypress configuration file, exiting.

packages/server/lib/gui/events.js

@@ -1,5 +1,6 @@
 /* eslint-disable no-case-declarations */
 const _ = require('lodash')
+const path = require('path')
 const ipc = require('electron').ipcMain
 const { clipboard } = require('electron')
 const debug = require('debug')('cypress:server:events')
@@ -323,6 +324,20 @@ const handleEvent = function (options, bus, event, id, type, arg) {
           onWarning,
         })
       }).call('getConfig')
+      .then((config) => {
+        if (config.configFile && path.isAbsolute(config.configFile)) {
+          config.configFile = path.relative(arg, config.configFile)
+        }
+
+        // those two values make no sense to display in
+        // the GUI
+        if (config.resolved) {
+          config.resolved.configFile = undefined
+          config.resolved.testingType = undefined
+        }
+
+        return config
+      })
       .then(send)
       .catch(sendErr)
 

packages/server/lib/modes/run.js

@@ -11,7 +11,6 @@ const logSymbols = require('log-symbols')
 
 const recordMode = require('./record')
 const errors = require('../errors')
-const ProjectStatic = require('../project_static')
 const Reporter = require('../reporter')
 const browserUtils = require('../browsers')
 const { openProject } = require('../open_project')
@@ -609,22 +608,21 @@ const openProjectCreate = (projectRoot, socketId, args) => {
   return openProject.create(projectRoot, args, options)
 }
 
-const createAndOpenProject = function (socketId, options) {
+const createAndOpenProject = async function (socketId, options) {
   const { projectRoot, projectId } = options
 
-  return ProjectStatic.ensureExists(projectRoot, options)
-  .then(() => {
-    // open this project without
-    // adding it to the global cache
-    return openProjectCreate(projectRoot, socketId, options)
-  })
-  .call('getProject')
+  return openProjectCreate(projectRoot, socketId, options)
+  .then((open_project) => open_project.getProject())
   .then((project) => {
-    return Promise.props({
+    return Promise.all([
       project,
-      config: project.getConfig(),
-      projectId: getProjectId(project, projectId),
-    })
+      project.getConfig(),
+      getProjectId(project, projectId),
+    ]).then(([project, config, projectId]) => ({
+      project,
+      config,
+      projectId,
+    }))
   })
 }
 

packages/server/lib/open_project.ts

@@ -37,7 +37,7 @@ export interface LaunchArgs {
   _: [string] // Cypress App binary location
   config: Record<string, unknown>
   cwd: string
-  browser: Browser
+  browser?: Browser['name']
   configFile?: string
   project: string // projectRoot
   projectRoot: string // same as above
@@ -456,7 +456,7 @@ export class OpenProject {
     try {
       await this.openProject.initializeConfig()
       await this.openProject.open()
-    } catch (err) {
+    } catch (err: any) {
       if (err.isCypressErr && err.portInUse) {
         errors.throw(err.type, err.port)
       } else {

packages/server/lib/project-base.ts

@@ -23,14 +23,14 @@ import system from './util/system'
 import user from './user'
 import { ensureProp } from './util/class-helpers'
 import { fs } from './util/fs'
-import settings from './util/settings'
+import * as settings from './util/settings'
 import plugins from './plugins'
 import specsUtil from './util/specs'
 import Watchers from './watchers'
 import devServer from './plugins/dev-server'
 import preprocessor from './plugins/preprocessor'
 import { SpecsStore } from './specs-store'
-import { checkSupportFile } from './project_utils'
+import { checkSupportFile, getDefaultConfigFilePath } from './project_utils'
 import type { LaunchArgs } from './open_project'
 
 // Cannot just use RuntimeConfigOptions as is because some types are not complete.
@@ -690,6 +690,12 @@ export class ProjectBase<TServer extends ServerE2E | ServerCt> extends EE {
   }
 
   async initializeConfig (): Promise<Cfg> {
+    // set default for "configFile" if undefined
+    if (this.options.configFile === undefined
+  || this.options.configFile === null) {
+      this.options.configFile = await getDefaultConfigFilePath(this.projectRoot, !this.options.isTextTerminal)
+    }
+
     let theCfg: Cfg = await config.get(this.projectRoot, this.options)
 
     if (theCfg.browsers) {

packages/server/lib/project_static.ts

@@ -7,8 +7,9 @@ import api from './api'
 import cache from './cache'
 import user from './user'
 import keys from './util/keys'
-import settings from './util/settings'
+import * as settings from './util/settings'
 import { ProjectBase } from './project-base'
+import { getDefaultConfigFilePath } from './project_utils'
 
 const debug = Debug('cypress:server:project_static')
 
@@ -60,7 +61,7 @@ export async function _getProject (clientProject, authToken) {
     debug('got project from api')
 
     return _mergeDetails(clientProject, project)
-  } catch (err) {
+  } catch (err: any) {
     debug('failed to get project from api', err.statusCode)
     switch (err.statusCode) {
       case 404:
@@ -153,13 +154,10 @@ export async function add (path, options) {
   }
 }
 
-export function getId (path) {
-  return new ProjectBase({ projectRoot: path, testingType: 'e2e', options: {} }).getProjectId()
-}
+export async function getId (path) {
+  const configFile = await getDefaultConfigFilePath(path)
 
-export function ensureExists (path, options) {
-  // is there a configFile? is the root writable?
-  return settings.exists(path, options)
+  return new ProjectBase({ projectRoot: path, testingType: 'e2e', options: { configFile } }).getProjectId()
 }
 
 export async function writeProjectId (id: string, projectRoot: string) {

packages/server/lib/project_utils.ts

@@ -1,10 +1,11 @@
 import Debug from 'debug'
 import path from 'path'
 
-import settings from './util/settings'
+import * as settings from './util/settings'
 import errors from './errors'
 import { fs } from './util/fs'
 import { escapeFilenameInUrl } from './util/escape_filename'
+import { CYPRESS_CONFIG_FILES } from './configFiles'
 
 const debug = Debug('cypress:server:project_utils')
 
@@ -131,3 +132,26 @@ export const checkSupportFile = async ({
 
   return
 }
+
+export async function getDefaultConfigFilePath (projectRoot: string, returnDefaultValueIfNotFound: boolean = true): Promise<string | undefined> {
+  const filesInProjectDir = await fs.readdir(projectRoot)
+
+  const foundConfigFiles = CYPRESS_CONFIG_FILES.filter((file) => filesInProjectDir.includes(file))
+
+  // if we only found one default file, it is the one
+  if (foundConfigFiles.length === 1) {
+    return foundConfigFiles[0]
+  }
+
+  // if we found more than one, throw a language conflict
+  if (foundConfigFiles.length > 1) {
+    throw errors.throw('CONFIG_FILES_LANGUAGE_CONFLICT', projectRoot, ...foundConfigFiles)
+  }
+
+  if (returnDefaultValueIfNotFound) {
+    // Default is to create a new `cypress.json` file if one does not exist.
+    return CYPRESS_CONFIG_FILES[0]
+  }
+
+  throw errors.get('NO_DEFAULT_CONFIG_FILE_FOUND', projectRoot)
+}

packages/server/lib/util/require_async.ts

@@ -14,10 +14,6 @@ let requireProcess: cp.ChildProcess | null
 interface RequireAsyncOptions{
   projectRoot: string
   loadErrorCode: string
-  /**
-   * members of the object returned that are functions and will need to be wrapped
-   */
-  functionNames: string[]
 }
 
 interface ChildOptions{