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

docs: revise Cucumber format option #3024

Closed
wants to merge 4 commits into from
Closed

docs: revise Cucumber format option #3024

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
66ead35
docs: revise Cucumber format option
tianfeng92 Nov 25, 2024
5fa88be
no please Σ(ﾟ口ﾟ;)//
tianfeng92 Nov 25, 2024
2efabf7
revise docs
tianfeng92 Nov 25, 2024
8686a86
simplify docs
tianfeng92 Nov 26, 2024
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
17 changes: 12 additions & 5 deletions docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -423,7 +423,7 @@ npm:
auth: base64SecretToken
username: myUsername
password: myPassword
email: myEmail
email: myEmail
```

---
Expand Down Expand Up @@ -743,7 +743,7 @@ artifacts:
<p><small>| OPTIONAL | OBJECT |</small></p>

Define directories to archive and retain as a test asset at the end of a test run. Archived test assets can
be downloaded automatically using the `download` configuration, via the
be downloaded automatically using the `download` configuration, via the
[REST API](/dev/api/jobs/#get-a-job-asset-file), or through the test details page.

```yaml
Expand Down Expand Up @@ -1125,7 +1125,7 @@ suites:
require:
- "features/support/*.js"
format:
- "json:my-cucumber.json"
- '"json":"my-cucumber.json"'
```

---
Expand Down Expand Up @@ -1259,14 +1259,21 @@ suites:

<p><small>| OPTIONAL | ARRAY |</small></p>

Name/path and (optionally) output file path of each formatter to use. See the [Cucumber.js Formatters documentation](https://github.com/cucumber/cucumber-js/blob/main/docs/formatters.md) for more information.
Specifies the name or path of each formatter to use, along with an optional output file path. If no output file path is specified, the output defaults to stdout.
The name or path, as well as the optional output file path, must be enclosed in quotes. See the [Cucumber.js Formatters documentation](https://github.com/cucumber/cucumber-js/blob/main/docs/formatters.md) for more information.

:::warning
Cucumber deprecated the previous `format` configuration without quotes in version **9.6.0** and will remove it in **11.0.0** or later.
If you're still using a `format` setting without quotes, migrate to the latest pattern.
For more details, see the [Cucumber.js Deprecations documentation](https://github.com/cucumber/cucumber-js/blob/main/docs/deprecations.md#ambiguous-colons-in-formats).
:::

```yaml
suites:
- name: My Cucumber Test
options:
format:
- "json:my-cucumber.json"
- '"json":"my-cucumber.json"'
```

---
Expand Down