Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hdorgeval/cucumber7-ts-starter
Starter project to write and debug cucumber-js features in TypeScript language
https://github.com/hdorgeval/cucumber7-ts-starter
bdd cucumber cucumber-js gherkin starter-template typescript visual-studio-code vscode
Last synced: 3 months ago
JSON representation
Starter project to write and debug cucumber-js features in TypeScript language
- Host: GitHub
- URL: https://github.com/hdorgeval/cucumber7-ts-starter
- Owner: hdorgeval
- License: mit
- Created: 2021-01-06T19:25:29.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-12-27T02:26:09.000Z (about 2 years ago)
- Last Synced: 2024-09-28T11:41:21.792Z (3 months ago)
- Topics: bdd, cucumber, cucumber-js, gherkin, starter-template, typescript, visual-studio-code, vscode
- Language: TypeScript
- Homepage:
- Size: 259 KB
- Stars: 46
- Watchers: 1
- Forks: 21
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# cucumber7-ts-starter
[](https://travis-ci.org/hdorgeval/cucumber7-ts-starter)
[](https://ci.appveyor.com/project/hdorgeval/cucumber7-ts-starter)
Starter project to write and debug cucumber-js v7 features in TypeScript language
## After cloning the repo
- run the command `npm install`.
## To execute the tests locally
- run the command `npm test`.
## To choose a reporter
The last reporter/formatter found on the cucumber-js command-line wins:
```text
--format summary --format @cucumber/pretty-formatter --format cucumber-console-formatter
```
In [package.json](package.json) file, modify the `cucumber` script to keep only your preferred formatter.
## To debug a scenario in Visual Studio Code
- tag the scenario with `@debug`
- set the breakpoints in the typescript code
- Start debugging
## To run only specific scenarios
- tag the scenario(s) with `@only`
- run the command `npm run only`.
## To ignore a scenario
- tag the scenario with `@ignore`
## To check for typescript, linting and gherkin errors
- run the command `npm run build`.
## To view the steps usage
- run the command `npm run steps-usage`.
## To view the html report of the last run
- run the command `npm run report`.
## To create a new step
- first write the Given/When/Then sentence:
```gherkin
Given I push "foo" on "bar"
```
- run the npm script:
```sh
npm run snippets
```
- the script will report the missing step(s): you just need to copy and paste them in the step definitions file:
```sh
Given('I push {string} on {string}', async function (string, string2) {
// Write code here that turns the phrase above into concrete actions
return 'pending';
});
```
## To use a custom option on the CLI
With cucumber-js v7, you cannot have anymore custom options on the CLI.
This is a breaking change with cucumber-js v6.
You must instead use environment variables.
When running your tests localy, you can setup environment variables by customizing the file [set-environment-variables.ts](env/set-environment-variables.ts).
When running on a CI, you should setup your jobs with the expected environment variables.
## To use a custom World Objet
- cutomize the given Custom World Object : [custom-world](world/custom-world.ts)