Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Add typing for specType field on spec method #8256

Merged
merged 11 commits into from
Aug 27, 2020
Merged

fix: Add typing for specType field on spec method #8256

Changes from 7 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
82dea35
Add typing for specType field on spec method
NickBolles Aug 12, 2020
f9f574d
Update cypress.d.ts
NickBolles Aug 12, 2020
40989e9
docs: add jsdoc to CypressSpecType
NickBolles Aug 25, 2020
709caae
fix: fix typings linting issue
NickBolles Aug 25, 2020
5d54606
Merge branch 'develop' into NickBolles-add-specType-typings
NickBolles Aug 25, 2020
2434675
fix: make specType optional
NickBolles Aug 25, 2020
7600e85
Merge branch 'NickBolles-add-specType-typings' of https://github.com/…
NickBolles Aug 25, 2020
7ee7a97
Update cli/types/cypress.d.ts
jennifer-shehane Aug 26, 2020
e818036
Update cli/types/cypress.d.ts
jennifer-shehane Aug 27, 2020
eb4168a
Update cli/types/cypress.d.ts
jennifer-shehane Aug 27, 2020
a787044
Update cli/types/cypress.d.ts
jennifer-shehane Aug 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions cli/types/cypress.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,14 @@ declare namespace Cypress {
fromAutWindow: WindowPosition & { x: number, y: number }
}

/**
* Spec type for the given test. "integration" is the default, but
* test run with the experimentalComponentTesting tests will be "component"
*
* @see https://docs.cypress.io/guides/references/experiments.html#Component-Testing
*/
jennifer-shehane marked this conversation as resolved.
Show resolved Hide resolved
type CypressSpecType = "integration" | "component"

/**
* Window type for Application Under Test(AUT)
*/
Expand Down Expand Up @@ -221,6 +229,7 @@ declare namespace Cypress {
// name: "config_passing_spec.coffee",
// relative: "cypress/integration/config_passing_spec.coffee",
// absolute: "/users/smith/projects/web/cypress/integration/config_passing_spec.coffee"
// specType: "integration"
// }
```
*/
Expand All @@ -229,6 +238,7 @@ declare namespace Cypress {
relative: string // "cypress/integration/config_passing_spec.coffee" or "__all" if clicked all specs button
absolute: string
specFilter?: string // optional spec filter used by the user
specType?: CypressSpecType
jennifer-shehane marked this conversation as resolved.
Show resolved Hide resolved
}

/**
Expand Down