Skip to content

Latest commit

 

History

History
71 lines (51 loc) · 12.2 KB

README.md

File metadata and controls

71 lines (51 loc) · 12.2 KB

vscode-cy-helper

SWUbanner

Cypress extension for vs code. (Forked due to publish issues with original repository)

Gitter License Visual Studio Marketplace Installs

Available functionality

Custom commands

Other

Gherkin (cucumber)

Alias

Task

Fixtures

Configuration

setting description default
cypressHelper.commandForOpen command used for opening cypress npx cypress open
cypressHelper.commandForRun command used for running cypress npx cypress run
cypressHelper.customCommandsFolder path to folder with custom commands cypress/support
cypressHelper.typeDefinitionFile file to save generated custom commands cypress/support/customCommands.d.ts
cypressHelper.typeDefinitionExcludePatterns array of glob patterns that should be excluded from types generation [**/*.ts]
cypressHelper.includeAnnotationForCommands include comments before custom command to type definition file false
cypressHelper.typeDefinitionOnSave generate type definitions file for custom commands on save false
cypressHelper.menuItems display menu items or lenses for commands {
"OpenCypress": true,
"RunCypress": false,
"ItOnly": true,
"ItSkip": false,
"GenerateCustomCommandTypes": true,
"GoToCustomCommand": true,
"FindCustomCommandReferences": true,
"FindStepDefinitionReferences": true
"SchemaGenerator": true
}
cypressHelper.jqueryLocators configuration for jquery locators autocomplete {
"enabled": true,
"commandsForAutocompletion": ["get", "find", "filter"],
"includePatterns": [],
"excludePatterns": [],
"customAttributes": [],
}
cypressHelper.fixtureAutocompletionCommands cypress commands that accept fixture path as argument to add fixture path autocompletion ["fixture"]
cypressHelper.aliasAutocompletionForCurrentFile To enable alias autocompletion just for current file false (aliases will be searched in current folder)
cypressHelper.cucumberFixtureAutocompleteOnQuotes If you want fixture autocompletion in cucumber scenarios (using fixtures as parameters) you can enable it by setting true false
cypressHelper.enableCommandReferenceProvider In case you have type definitions, native Find all References will return duplicates for commands. To avoid it set this parameter to false true
cypressHelper.cucumberTagsAutocomplete Set enable: true for cucumber feature autocomplete on @. Array of tags could be specified. Option to add cypress-allure-plugin tags. {
"enable": false,
"tags": ["focus"],
"allurePlugin": false
}
cypressHelper.reuseTerminalInstance By default executes commandForOpen in same terminal instance. To spawn new instance for each cypress opening set it to false true
cypressHelper.cypressCodeLensePattern To enable code lenses (Cypress Open, Cypress Run, Set 'only') just for specific glob pattern, useful when project has other types of tests all files with .js, .ts, .feature extension inside cypress folder

License

Copyright 2022 Oleksandr Shevtsov. This project is licensed under the Apache 2.0 License.