feat: make cypress.config.js available

circle.yml

@@ -8,6 +8,8 @@ macBuildFilters: &macBuildFilters
     branches:
       only:
         - develop
+        - issue-17944-remove-source-files
+        - feat/allow-cypress-js
         - tgriesser/chore/fix-release
 
 defaults: &defaults
@@ -42,6 +44,8 @@ onlyMainBranches: &onlyMainBranches
     branches:
       only:
         - develop
+        - issue-17944-remove-source-files
+        - feat/allow-cypress-js
         - tgriesser/chore/fix-release
   requires:
     - create-build-artifacts
@@ -1346,10 +1350,6 @@ jobs:
           name: Run component tests
           command: yarn test:ci:ct
           working_directory: npm/vue
-      - run:
-          name: Run e2e tests
-          command: yarn test:ci:e2e
-          working_directory: npm/vue
       - store_test_results:
           path: npm/vue/test_results
       - store_artifacts:
@@ -2129,6 +2129,8 @@ linux-workflow: &linux-workflow
           branches:
             only:
               - develop
+              - issue-17944-remove-source-files
+              - feat/allow-cypress-js
               - tgriesser/chore/fix-release
         requires:
           - build
@@ -2141,6 +2143,8 @@ linux-workflow: &linux-workflow
           branches:
             only:
               - develop
+              - issue-17944-remove-source-files
+              - feat/allow-cypress-js
               - tgriesser/chore/fix-release
         requires:
           - build
@@ -2191,6 +2195,8 @@ linux-workflow: &linux-workflow
           branches:
             only:
               - develop
+              - issue-17944-remove-source-files
+              - feat/allow-cypress-js
               - tgriesser/chore/fix-release
         requires:
           - create-build-artifacts
@@ -2199,6 +2205,8 @@ linux-workflow: &linux-workflow
           branches:
             only:
               - develop
+              - issue-17944-remove-source-files
+              - feat/allow-cypress-js
               - tgriesser/chore/fix-release
         requires:
           - create-build-artifacts
@@ -2208,6 +2216,8 @@ linux-workflow: &linux-workflow
           branches:
             only:
               - develop
+              - issue-17944-remove-source-files
+              - feat/allow-cypress-js
               - tgriesser/chore/fix-release
         requires:
           - create-build-artifacts
@@ -2233,6 +2243,8 @@ linux-workflow: &linux-workflow
           branches:
             only:
               - develop
+              - issue-17944-remove-source-files
+              - feat/allow-cypress-js
               - tgriesser/chore/fix-release
         requires:
           - create-build-artifacts
@@ -2305,6 +2317,8 @@ mac-workflow: &mac-workflow
           branches:
             only:
               - develop
+              - issue-17944-remove-source-files
+              - feat/allow-cypress-js
               - tgriesser/chore/fix-release
         requires:
           - darwin-create-build-artifacts
@@ -2317,6 +2331,8 @@ mac-workflow: &mac-workflow
           branches:
             only:
               - develop
+              - issue-17944-remove-source-files
+              - feat/allow-cypress-js
               - tgriesser/chore/fix-release
         requires:
           - darwin-create-build-artifacts

cli/lib/cypress.js

@@ -68,6 +68,19 @@ const cypressModuleApi = {
       return cli.parseRunCommand(args)
     },
   },
+
+  /**
+   * This function should not be used in pure JavaScript
+   * By the type of its argument it allows autocompletion and
+   * type checking of the configuration given by users.
+   *
+   * @see ../types/cypress-npm-api.d.ts
+   * @param {Cypress.ConfigOptions} config
+   * @returns {Cypress.ConfigOptions} the configuration passed in parameter
+   */
+  defineConfig (config) {
+    return config
+  },
 }
 
 module.exports = cypressModuleApi

cli/types/cypress-npm-api.d.ts

@@ -138,7 +138,7 @@ declare namespace CypressCommandLine {
     /**
      * Specify configuration
      */
-    config: Cypress.ConfigOptions
+    config: Cypress.ConfigOptionsMergedWithTestingTypes
     /**
      * Path to the config file to be used.
      *
@@ -335,8 +335,7 @@ declare namespace CypressCommandLine {
   }
 }
 
-declare module 'cypress' {
-  /**
+/**
    * Cypress NPM module interface.
    * @see https://on.cypress.io/module-api
    * @example
@@ -345,41 +344,46 @@ declare module 'cypress' {
     cypress.run().then(results => ...)
     ```
   */
-  interface CypressNpmApi {
-    /**
-     * Execute a headless Cypress test run.
-     * @see https://on.cypress.io/module-api#cypress-run
-     * @example
-     ```
-     const cypress = require('cypress')
-     // runs all spec files matching a wildcard
-     cypress.run({
-       spec: 'cypress/integration/admin*-spec.js'
-     }).then(results => {
-       if (results.status === 'failed') {
-          // Cypress could not run
-        } else {
-          // inspect results object
-       }
-     })
-     ```
-     */
-    run(options?: Partial<CypressCommandLine.CypressRunOptions>): Promise<CypressCommandLine.CypressRunResult | CypressCommandLine.CypressFailedRunResult>
-    /**
-     * Opens Cypress GUI. Resolves with void when the
-     * GUI is closed.
-     * @see https://on.cypress.io/module-api#cypress-open
-     */
-    open(options?: Partial<CypressCommandLine.CypressOpenOptions>): Promise<void>
+declare module 'cypress' {
+  /**
+   * Execute a headless Cypress test run.
+   * @see https://on.cypress.io/module-api#cypress-run
+   * @example
+   ```
+    const cypress = require('cypress')
+    // runs all spec files matching a wildcard
+    cypress.run({
+      spec: 'cypress/integration/admin*-spec.js'
+    }).then(results => {
+      if (results.status === 'failed') {
+        // Cypress could not run
+      } else {
+        // inspect results object
+      }
+    })
+    ```
+    */
+  function run(options?: Partial<CypressCommandLine.CypressRunOptions>): Promise<CypressCommandLine.CypressRunResult | CypressCommandLine.CypressFailedRunResult>
+  /**
+   * Opens Cypress GUI. Resolves with void when the
+   * GUI is closed.
+   * @see https://on.cypress.io/module-api#cypress-open
+   */
+  function open(options?: Partial<CypressCommandLine.CypressOpenOptions>): Promise<void>
 
-    /**
-     * Utility functions for parsing CLI arguments the same way
-     * Cypress does
-     */
-    cli: CypressCommandLine.CypressCliParser
-  }
+  /**
+   * Utility functions for parsing CLI arguments the same way
+   * Cypress does
+   */
+  const cli: CypressCommandLine.CypressCliParser
 
-  // export Cypress NPM module interface
-  const cypress: CypressNpmApi
-  export = cypress
+  /**
+   * Type helper to make writing `cypress.config.ts` easier
+   */
+  function defineConfig(config: Cypress.ConfigOptions): Cypress.ConfigOptions
+
+  /**
+   * Types for configuring cypress in cypress.config.ts
+   */
+  type ConfigOptions = Cypress.ConfigOptions
 }