mirror/cypress
1
0
Fork 0
mirror of https://github.com/cypress-io/cypress.git synced 2026-02-05 14:50:00 -06:00
Code Issues Packages Projects Releases Wiki Activity

add TS types for partial config options (#7239)

Browse Source
This commit is contained in:
Gleb Bahmutov
2020-05-07 10:39:31 -04:00
committed by GitHub
parent 157d704270
commit 627c9deb08
3 changed files with 25 additions and 208 deletions
Download Patch File Download Diff File Expand all files Collapse all files

205
cli/types/cypress-npm-api.d.ts vendored
View File

@@ -7,203 +7,6 @@
// but for now describe it as an ambient module
declare module 'cypress' {
/**
* Cypress configuration object.
* @see https://on.cypress.io/configuration
*/
interface CypressConfiguration {
//
// global options
//
/**
* Url used as prefix for `cy.visit()` or `cy.request()` command’s url
*/
baseUrl: string,
/**
* Any values to be set as environment variables
*/
env: object,
/**
* A String or Array of glob patterns used to ignore test files
* that would otherwise be shown in your list of tests.
*/
ignoreTestFiles: string | string[],
/**
* The number of tests for which snapshots and command data are kept in memory.
* Reduce this number if you are experiencing high memory consumption in your browser during a test run.
*/
numTestsKeptInMemory: number,
/**
* Port used to host Cypress. Normally this is a randomly generated port
*/
port: number,
/**
* The reporter used during the `cypress run`. Default is "spec"
*/
reporter: string,
/**
* A String or Array of string glob pattern of the test files to load.
*/
testFiles: string | string[]
//
// timeouts
//
/**
* Time, in milliseconds, to wait until most DOM based commands
* are considered timed out.
*/
defaultCommandTimeout: number,
/**
* Time, in milliseconds, to wait for a system command to
* finish executing during a `cy.exec()` command.
*/
execTimeout: number,
/**
* Time, in milliseconds, to wait for a task to finish executing
* during a `cy.task()` command.
*/
taskTimeout: number,
/**
* Time, in milliseconds, to wait for page transition events or
* `cy.visit()`, `cy.go()`, `cy.reload()` commands to fire
* their page load events.
*/
pageLoadTimeout: number,
/**
* Time, in milliseconds, to wait for an XHR request to go out
* in a `cy.wait()` command.
*/
requestTimeout: number,
/**
* Time, in milliseconds, to wait until a response in a
* `cy.request()`, `cy.wait()`, `cy.fixture()`, `cy.getCookie()`,
* `cy.getCookies()`, `cy.setCookie()`, `cy.clearCookie()`,
* `cy.clearCookies()`, and `cy.screenshot()` commands.
*/
responseTimeout: number,
//
// folders and files
//
/**
* Path to folder where application files will attempt to be served from.
*/
fileServerFolder: string,
/**
* Path to folder containing fixture files (Pass `false` to disable).
*/
fixturesFolder: string | false,
/**
* Path to folder containing integration test files.
*/
integrationFolder: string,
/**
* Path to plugins file. (Pass `false` to disable)
*/
pluginsFile: string | false,
/**
* Path to folder where screenshots will be saved from `cy.screenshot()`
* command or after a test fails during cypress run.
*/
screenshotsFolder: string,
/**
* Path to file to load before test files load.
* This file is compiled and bundled. (Pass `false` to disable).
*/
supportFile: string | false,
/**
* Path to folder where videos will be saved during `cypress run`
*/
videosFolder: string,
//
// screenshots
//
/**
* Whether Cypress will trash assets within the `screenshotsFolder` and
* `videosFolder` before tests run with cypress run. Default is `true`.
*/
trashAssetsBeforeRuns: boolean,
//
// videos
//
/**
* The quality setting for the video compression, in Constant Rate Factor (CRF).
* The value can be false to disable compression or a value between 0 and 51,
* where a lower value results in better quality
* (at the expense of a higher file size).
*/
videoCompression: number | false,
/**
* Whether Cypress will capture a video of the tests run with `cypress run`.
*/
video: boolean,
/**
* Whether Cypress will upload the video to the Dashboard even if
* all tests are passing. This applies only when recording your runs
* to the Dashboard. Turn this off if you’d like the video uploaded
* only when there are failing tests.
*/
videoUploadOnPasses: boolean,
//
// browser
//
/**
* Whether Chrome Web Security for `same-origin` policy and
* `insecure mixed content` is enabled.
*/
chromeWebSecurity: boolean,
/**
* Enables you to override the default user agent the
* browser sends in all request headers.
*/
userAgent: string,
/**
* A String or Array of hosts that you wish to block traffic for.
*/
blacklistHosts: string | string[],
/**
* Whether Cypress will search for and replace obstructive JS code
* in `.js` or `.html` files.
*/
modifyObstructiveCode: boolean,
//
// viewport
//
/**
* Default height in pixels for the application under tests’ viewport
* (Override with `cy.viewport()` command)
*/
viewportHeight: number,
/**
* Default width in pixels for the application under tests’ viewport.
* (Override with `cy.viewport()` command)
*/
viewportWidth: number
//
// animations
//
/**
* The distance in pixels an element must exceed over
* time to be considered animating.
*/
animationDistanceThreshold: number
/**
* Whether to wait for elements to finish animating before executing commands.
*/
waitForAnimations: boolean
}
/**
* All options that one can pass to "cypress.run"
* @see https://on.cypress.io/module-api#cypress-run
@@ -324,7 +127,7 @@ declare module 'cypress' {
/**
* Specify configuration
*/
config: Partial<CypressConfiguration>
config: Partial<Cypress.ResolvedConfigOptions>
/**
* Path to the config file to be used.
*
@@ -334,7 +137,8 @@ declare module 'cypress' {
*/
configFile: string | false
/**
* Specify environment variables
* Specify environment variables.
* TODO: isn't this duplicate of config.env?!
*/
env: object
/**
@@ -477,8 +281,7 @@ declare module 'cypress' {
osName: string
osVersion: string
cypressVersion: string
// TODO add resolved object to the configuration
config: CypressConfiguration
config: Cypress.ResolvedConfigOptions
}
/**

19
cli/types/index.d.ts vendored
View File

@@ -57,7 +57,7 @@ declare namespace Cypress {
type RequestBody = string | object
type ViewportOrientation = "portrait" | "landscape"
type PrevSubject = "optional" | "element" | "document" | "window"
type PluginConfig = (on: PluginEvents, config: PluginConfigOptions) => void | Partial<ConfigOptions> | Promise<Partial<ConfigOptions>>
type PluginConfig = (on: PluginEvents, config: PluginConfigOptions) => void | ConfigOptions | Promise<ConfigOptions>
interface CommandOptions {
prevSubject: boolean | PrevSubject | PrevSubject[]
@@ -294,7 +294,7 @@ declare namespace Cypress {
// {defaultCommandTimeout: 10000, pageLoadTimeout: 30000, ...}
```
*/
config(): ConfigOptions
config(): ResolvedConfigOptions
/**
* Returns one configuration value.
* @see https://on.cypress.io/config
@@ -304,7 +304,7 @@ declare namespace Cypress {
// 60000
```
*/
config<K extends keyof ConfigOptions>(key: K): ConfigOptions[K]
config<K extends keyof ConfigOptions>(key: K): ResolvedConfigOptions[K]
/**
* Sets one configuration value.
* @see https://on.cypress.io/config
@@ -313,7 +313,7 @@ declare namespace Cypress {
Cypress.config('viewportWidth', 800)
```
*/
config<K extends keyof ConfigOptions>(key: K, value: ConfigOptions[K]): void
config<K extends keyof ConfigOptions>(key: K, value: ResolvedConfigOptions[K]): void
/**
* Sets multiple configuration values at once.
* @see https://on.cypress.io/config
@@ -325,7 +325,7 @@ declare namespace Cypress {
})
```
*/
config(Object: Partial<ConfigOptions>): void
config(Object: ConfigOptions): void
// no real way to type without generics
/**
@@ -2287,7 +2287,7 @@ declare namespace Cypress {
multiple: boolean
}
interface ConfigOptions {
interface ResolvedConfigOptions {
/**
* Url used as prefix for [cy.visit()](https://on.cypress.io/visit) or [cy.request()](https://on.cypress.io/request) command’s url
* @default null
@@ -2458,7 +2458,12 @@ declare namespace Cypress {
experimentalGetCookiesSameSite: boolean
}
interface PluginConfigOptions extends ConfigOptions {
/**
* All configuration items are optional.
*/
type ConfigOptions = Partial<ResolvedConfigOptions>
interface PluginConfigOptions extends ResolvedConfigOptions {
/**
* Absolute path to the config file (default: <projectRoot>/cypress.json) or false
*/

9
cli/types/tests/cypress-npm-api-test.ts
View File

@@ -29,3 +29,12 @@ cypress.open({
cypress.run({
configFile: "abc123"
})
// provide only some config options
const runConfig: Cypress.ConfigOptions = {
baseUrl: 'http://localhost:8080',
env: {
login: false
},
}
cypress.run({ config: runConfig })