test: test auto docs

gemini-testing · Aug 15, 2024 · fbb4be7 · fbb4be7
1 parent cdece15
commit fbb4be7
Show file tree

Hide file tree

Showing 120 changed files with 1,201 additions and 25,041 deletions.
diff --git a/clone-testplane.js b/clone-testplane.js
@@ -14,8 +14,8 @@ if (fs.existsSync(tempDir)) {
 
 if (LOCAL) {
     // Create a symlink to the local repo
-    fs.symlinkSync(LOCAL_REPO_DIR, tempDir, 'dir');
-    console.log(`Linked local testplane repo from ${LOCAL_REPO_DIR} to ${tempDir}`);
+    execSync(`cp -r ${LOCAL_REPO_DIR}/. ${tempDir}`);
+    console.log(`Copied local testplane repo from ${LOCAL_REPO_DIR} to ${tempDir}`);
 } else {
     fs.mkdirSync(tempDir);
 

diff --git a/docs/api-reference/README.mdx b/docs/api-reference/README.mdx
@@ -59,7 +59,6 @@
 | [TestResult](interfaces/TestResult.mdx) | - |
 | [TestResultWithRetries](interfaces/TestResultWithRetries.mdx) | - |
 | [TestplaneCtx](interfaces/TestplaneCtx.mdx) | - |
-| [WdioBrowser](interfaces/WdioBrowser.mdx) | - |
 
 ## Type Aliases
 
@@ -73,9 +72,3 @@
 | [MasterEventHandler](type-aliases/MasterEventHandler.mdx) | - |
 | [SyncSessionEventCallback](type-aliases/SyncSessionEventCallback.mdx) | - |
 | [WorkerEventHandler](type-aliases/WorkerEventHandler.mdx) | - |
-
-## Variables
-
-| Variable | Description |
-| ------ | ------ |
-| [Key](variables/Key.mdx) | - |
diff --git a/docs/api-reference/classes/AbortOnReconnectError.mdx b/docs/api-reference/classes/AbortOnReconnectError.mdx
@@ -24,43 +24,12 @@ new AbortOnReconnectError(): AbortOnReconnectError
 
 #### Defined in
 
-testplane-docs/.testplane/src/errors/abort-on-reconnect-error.ts:2
+[.testplane/src/errors/abort-on-reconnect-error.ts:2](https://github.com/gemini-testing/testplane/blob/57d0b182c37e21d8bdf52acbb137a028841767af/src/errors/abort-on-reconnect-error.ts#L2)
 
 ## Properties
 
-| Property | Modifier | Type | Description | Inherited from | Defined in |
-| ------ | ------ | ------ | ------ | ------ | ------ |
-| `message` | `public` | `string` | - | `Error.message` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 |
-| `name` | `public` | `string` | - | `Error.name` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 |
-| `stack?` | `public` | `string` | - | `Error.stack` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 |
-| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` | Optional override for formatting stack traces **See** https://v8.dev/docs/stack-trace-api#customizing-stack-traces | `Error.prepareStackTrace` | testplane/node\_modules/@types/node/globals.d.ts:27 |
-| `stackTraceLimit` | `static` | `number` | - | `Error.stackTraceLimit` | testplane/node\_modules/@types/node/globals.d.ts:29 |
-
-## Methods
-
-### captureStackTrace()
-
-```ts
-static captureStackTrace(targetObject, constructorOpt?): void
-```
-
-Create .stack property on a target object
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `targetObject` | `object` |
-| `constructorOpt`? | `Function` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`Error.captureStackTrace`
-
-#### Defined in
-
-testplane/node\_modules/@types/node/globals.d.ts:20
+| Property | Type | Inherited from | Defined in |
+| ------ | ------ | ------ | ------ |
+| `message` | `string` | `Error.message` | node\_modules/typescript/lib/lib.es5.d.ts:1077 |
+| `name` | `string` | `Error.name` | node\_modules/typescript/lib/lib.es5.d.ts:1076 |
+| `stack?` | `string` | `Error.stack` | node\_modules/typescript/lib/lib.es5.d.ts:1078 |
diff --git a/docs/api-reference/classes/AssertViewError.mdx b/docs/api-reference/classes/AssertViewError.mdx
@@ -30,43 +30,12 @@ new AssertViewError(message): AssertViewError
 
 #### Defined in
 
-testplane-docs/.testplane/src/browser/commands/assert-view/errors/assert-view-error.ts:2
+[.testplane/src/browser/commands/assert-view/errors/assert-view-error.ts:2](https://github.com/gemini-testing/testplane/blob/57d0b182c37e21d8bdf52acbb137a028841767af/src/browser/commands/assert-view/errors/assert-view-error.ts#L2)
 
 ## Properties
 
-| Property | Modifier | Type | Default value | Description | Inherited from | Defined in |
-| ------ | ------ | ------ | ------ | ------ | ------ | ------ |
-| `message` | `public` | `string` | `"image comparison failed"` | - | `Error.message` | testplane-docs/.testplane/src/browser/commands/assert-view/errors/assert-view-error.ts:2 |
-| `name` | `public` | `string` | `undefined` | - | `Error.name` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 |
-| `stack?` | `public` | `string` | `undefined` | - | `Error.stack` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 |
-| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` | `undefined` | Optional override for formatting stack traces **See** https://v8.dev/docs/stack-trace-api#customizing-stack-traces | `Error.prepareStackTrace` | testplane/node\_modules/@types/node/globals.d.ts:27 |
-| `stackTraceLimit` | `static` | `number` | `undefined` | - | `Error.stackTraceLimit` | testplane/node\_modules/@types/node/globals.d.ts:29 |
-
-## Methods
-
-### captureStackTrace()
-
-```ts
-static captureStackTrace(targetObject, constructorOpt?): void
-```
-
-Create .stack property on a target object
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `targetObject` | `object` |
-| `constructorOpt`? | `Function` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`Error.captureStackTrace`
-
-#### Defined in
-
-testplane/node\_modules/@types/node/globals.d.ts:20
+| Property | Modifier | Type | Default value | Inherited from | Defined in |
+| ------ | ------ | ------ | ------ | ------ | ------ |
+| `message` | `public` | `string` | `"image comparison failed"` | `Error.message` | [.testplane/src/browser/commands/assert-view/errors/assert-view-error.ts:2](https://github.com/gemini-testing/testplane/blob/57d0b182c37e21d8bdf52acbb137a028841767af/src/browser/commands/assert-view/errors/assert-view-error.ts#L2) |
+| `name` | `public` | `string` | `undefined` | `Error.name` | node\_modules/typescript/lib/lib.es5.d.ts:1076 |
+| `stack?` | `public` | `string` | `undefined` | `Error.stack` | node\_modules/typescript/lib/lib.es5.d.ts:1078 |
diff --git a/docs/api-reference/classes/CancelledError.mdx b/docs/api-reference/classes/CancelledError.mdx
@@ -24,43 +24,12 @@ new CancelledError(): CancelledError
 
 #### Defined in
 
-testplane-docs/.testplane/src/browser-pool/cancelled-error.ts:5
+[.testplane/src/browser-pool/cancelled-error.ts:5](https://github.com/gemini-testing/testplane/blob/57d0b182c37e21d8bdf52acbb137a028841767af/src/browser-pool/cancelled-error.ts#L5)
 
 ## Properties
 
-| Property | Modifier | Type | Default value | Description | Overrides | Inherited from | Defined in |
-| ------ | ------ | ------ | ------ | ------ | ------ | ------ | ------ |
-| `message` | `public` | `string` | `"Browser request was cancelled"` | - | `Error.message` | - | testplane-docs/.testplane/src/browser-pool/cancelled-error.ts:3 |
-| `name` | `public` | `string` | `"CancelledError"` | - | `Error.name` | - | testplane-docs/.testplane/src/browser-pool/cancelled-error.ts:2 |
-| `stack?` | `public` | `string` | `undefined` | - | - | `Error.stack` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 |
-| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` | `undefined` | Optional override for formatting stack traces **See** https://v8.dev/docs/stack-trace-api#customizing-stack-traces | - | `Error.prepareStackTrace` | testplane/node\_modules/@types/node/globals.d.ts:27 |
-| `stackTraceLimit` | `static` | `number` | `undefined` | - | - | `Error.stackTraceLimit` | testplane/node\_modules/@types/node/globals.d.ts:29 |
-
-## Methods
-
-### captureStackTrace()
-
-```ts
-static captureStackTrace(targetObject, constructorOpt?): void
-```
-
-Create .stack property on a target object
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `targetObject` | `object` |
-| `constructorOpt`? | `Function` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`Error.captureStackTrace`
-
-#### Defined in
-
-testplane/node\_modules/@types/node/globals.d.ts:20
+| Property | Type | Default value | Overrides | Inherited from | Defined in |
+| ------ | ------ | ------ | ------ | ------ | ------ |
+| `message` | `string` | `"Browser request was cancelled"` | `Error.message` | - | [.testplane/src/browser-pool/cancelled-error.ts:3](https://github.com/gemini-testing/testplane/blob/57d0b182c37e21d8bdf52acbb137a028841767af/src/browser-pool/cancelled-error.ts#L3) |
+| `name` | `string` | `"CancelledError"` | `Error.name` | - | [.testplane/src/browser-pool/cancelled-error.ts:2](https://github.com/gemini-testing/testplane/blob/57d0b182c37e21d8bdf52acbb137a028841767af/src/browser-pool/cancelled-error.ts#L2) |
+| `stack?` | `string` | `undefined` | - | `Error.stack` | node\_modules/typescript/lib/lib.es5.d.ts:1078 |
diff --git a/docs/api-reference/classes/ClientBridgeError.mdx b/docs/api-reference/classes/ClientBridgeError.mdx
@@ -30,43 +30,12 @@ new ClientBridgeError(message): ClientBridgeError
 
 #### Defined in
 
-testplane-docs/.testplane/src/browser/client-bridge/error.ts:2
+[.testplane/src/browser/client-bridge/error.ts:2](https://github.com/gemini-testing/testplane/blob/57d0b182c37e21d8bdf52acbb137a028841767af/src/browser/client-bridge/error.ts#L2)
 
 ## Properties
 
-| Property | Modifier | Type | Description | Inherited from | Defined in |
-| ------ | ------ | ------ | ------ | ------ | ------ |
-| `message` | `public` | `string` | - | `Error.message` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1077 |
-| `name` | `public` | `string` | - | `Error.name` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1076 |
-| `stack?` | `public` | `string` | - | `Error.stack` | testplane-docs/node\_modules/typescript/lib/lib.es5.d.ts:1078 |
-| `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` | Optional override for formatting stack traces **See** https://v8.dev/docs/stack-trace-api#customizing-stack-traces | `Error.prepareStackTrace` | testplane/node\_modules/@types/node/globals.d.ts:27 |
-| `stackTraceLimit` | `static` | `number` | - | `Error.stackTraceLimit` | testplane/node\_modules/@types/node/globals.d.ts:29 |
-
-## Methods
-
-### captureStackTrace()
-
-```ts
-static captureStackTrace(targetObject, constructorOpt?): void
-```
-
-Create .stack property on a target object
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `targetObject` | `object` |
-| `constructorOpt`? | `Function` |
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-`Error.captureStackTrace`
-
-#### Defined in
-
-testplane/node\_modules/@types/node/globals.d.ts:20
+| Property | Type | Inherited from | Defined in |
+| ------ | ------ | ------ | ------ |
+| `message` | `string` | `Error.message` | node\_modules/typescript/lib/lib.es5.d.ts:1077 |
+| `name` | `string` | `Error.name` | node\_modules/typescript/lib/lib.es5.d.ts:1076 |
+| `stack?` | `string` | `Error.stack` | node\_modules/typescript/lib/lib.es5.d.ts:1078 |