Skip to content

Commit 8922740

Browse files
committed
DOC: Autogenerate and update documentation
1 parent df5dda8 commit 8922740

1 file changed

Lines changed: 28 additions & 26 deletions

File tree

‎docs/helpers/Obscura.md‎

Lines changed: 28 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ process lifecycle, the same way Playwright manages its own browser process.
2727
2828
## Compatibility
2929

30-
| CodeceptJS | Recommended Obscura | Notes |
31-
| --- | --- | --- |
32-
| 4.2.x | 0.2.2 | Version used by the CodeceptJS Obscura CI workflow |
33-
| 4.2.x | 0.2.x | Supported; capabilities are detected at runtime |
34-
| 4.2.x | 0.1.x / `-no-render` | DOM-only mode; no layout, visibility assertions, or screenshots |
30+
| CodeceptJS | Recommended Obscura | Notes |
31+
| ---------- | -------------------- | --------------------------------------------------------------- |
32+
| 4.2.x | 0.2.2 | Version used by the CodeceptJS Obscura CI workflow |
33+
| 4.2.x | 0.2.x | Supported; capabilities are detected at runtime |
34+
| 4.2.x | 0.1.x / `-no-render` | DOM-only mode; no layout, visibility assertions, or screenshots |
3535

3636
## Modes
3737

@@ -50,16 +50,16 @@ process lifecycle, the same way Playwright manages its own browser process.
5050

5151
## Install
5252

53-
Download a release archive from [Obscura releases](https://github.com/h4ckf0r0day/obscura/releases).
53+
Download a release archive from [Obscura releases][2].
5454
CodeceptJS 4.2 is tested with Obscura 0.2.2. Rendering archives are available for:
5555

56-
| platform | archive |
57-
| --- | --- |
58-
| Linux x64 | `obscura-x86_64-linux.tar.gz` |
59-
| Linux ARM64 | `obscura-aarch64-linux.tar.gz` |
60-
| macOS Intel | `obscura-x86_64-macos.tar.gz` |
56+
| platform | archive |
57+
| ------------------- | ------------------------------ |
58+
| Linux x64 | `obscura-x86_64-linux.tar.gz` |
59+
| Linux ARM64 | `obscura-aarch64-linux.tar.gz` |
60+
| macOS Intel | `obscura-x86_64-macos.tar.gz` |
6161
| macOS Apple Silicon | `obscura-aarch64-macos.tar.gz` |
62-
| Windows x64 | `obscura-x86_64-windows.zip` |
62+
| Windows x64 | `obscura-x86_64-windows.zip` |
6363

6464
Extract the archive and put `obscura` (`obscura.exe` on Windows) on your `PATH`, or point
6565
`binaryPath`/`OBSCURA_PATH` at it. The helper then launches and tears it down automatically.
@@ -107,19 +107,19 @@ Set them explicitly in your own config to skip probing or to force a mode.
107107
This helper should be configured in codecept.conf.js. It accepts everything `CDPBrowser`
108108
accepts (see its config table), plus:
109109

110-
Type: [object][6]
110+
Type: [object][7]
111111

112112
### Properties
113113

114-
* `endpoint` **[string][4]?** explicit CDP endpoint. Setting this switches the helper to ATTACH
114+
* `endpoint` **[string][5]?** explicit CDP endpoint. Setting this switches the helper to ATTACH
115115
mode: it only connects, and never spawns or kills a process, no matter what else is configured.
116116
Leave it unset for SELF-MANAGED mode (see below).
117-
* `binaryPath` **[string][4]?** path to the `obscura` executable, used in SELF-MANAGED mode
117+
* `binaryPath` **[string][5]?** path to the `obscura` executable, used in SELF-MANAGED mode
118118
(`endpoint` unset). Checked before `OBSCURA_PATH` and `PATH`.
119-
* `port` **[number][3]?** port `obscura serve` listens on, in SELF-MANAGED mode. When unset, a
119+
* `port` **[number][4]?** port `obscura serve` listens on, in SELF-MANAGED mode. When unset, a
120120
free port is picked automatically, which is what makes `run-workers` collision-free — every
121121
worker gets its own instance on its own port with zero config.
122-
* `serverStartTimeout` **[number][3]?** milliseconds to wait for a spawned `obscura serve`
122+
* `serverStartTimeout` **[number][4]?** milliseconds to wait for a spawned `obscura serve`
123123
to answer `/json/version` before `_connect` gives up.
124124

125125

@@ -173,7 +173,7 @@ Picks a free TCP port on 127.0.0.1 by briefly listening on port 0 and reading ba
173173
port. Used as the SELF-LAUNCH default when `options.port` isn't explicitly set, so multiple
174174
`run-workers` workers never collide on the same port.
175175

176-
Returns **[Promise][2]<[number][3]>** a free port.
176+
Returns **[Promise][3]<[number][4]>** a free port.
177177

178178
### _finishTest
179179

@@ -193,9 +193,9 @@ Probes a `/json/version`-style URL with a short timeout, used for the COURTESY-A
193193

194194
#### Parameters
195195

196-
* `url` **[string][4]**&#x20;
196+
* `url` **[string][5]**&#x20;
197197

198-
Returns **[Promise][2]<[boolean][5]>** true if the URL answered.
198+
Returns **[Promise][3]<[boolean][6]>** true if the URL answered.
199199

200200
### _resolveBinary
201201

@@ -204,7 +204,7 @@ Resolves the `obscura` binary to spawn, in priority order: `options.binaryPath`,
204204
directories itself instead of shelling out to `which`, which does not exist on Windows: on
205205
Windows every `PATHEXT` suffix is tried, so an `obscura.exe` on `PATH` is found too.
206206

207-
Returns **([string][4] | null)** an absolute or relative path to the binary, or null if none resolved.
207+
Returns **([string][5] | null)** an absolute or relative path to the binary, or null if none resolved.
208208

209209
### _resolveSelfManaged
210210

@@ -223,12 +223,14 @@ is paid once per run and counts directly toward real-world startup latency.
223223

224224
[1]: https://github.com/h4ckf0r0day/obscura
225225

226-
[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
226+
[2]: https://github.com/h4ckf0r0day/obscura/releases
227227

228-
[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
228+
[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
229229

230-
[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
230+
[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
231231

232-
[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
232+
[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
233233

234-
[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
234+
[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
235+
236+
[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object

0 commit comments

Comments
 (0)