From 90673e348f73cb96fff2d166191d6057647c73c8 Mon Sep 17 00:00:00 2001 From: Yaroslav Serhieiev Date: Mon, 18 Dec 2023 11:07:34 +0200 Subject: [PATCH] docs: remove outdated docs --- docs/docs/api/01-descriptions.mdx | 2 +- docs/docs/api/02-steps.mdx | 2 +- docs/docs/api/03-attachments.mdx | 2 +- docs/docs/api/04-parameters.mdx | 2 +- docs/docs/api/05-people.mdx | 2 +- docs/docs/api/06-severity.mdx | 2 +- docs/docs/api/07-links.mdx | 2 +- docs/docs/api/08-labels.mdx | 2 +- docs/docs/config/01-grouping/01-by-suite.mdx | 2 +- docs/docs/config/01-grouping/02-by-story.mdx | 2 +- .../docs/config/01-grouping/03-by-package.mdx | 2 +- .../config/01-grouping/04-by-category.mdx | 2 +- docs/docs/config/01-grouping/index.mdx | 4 +- docs/docs/config/02-statuses.mdx | 2 +- docs/docs/config/04-environment.mdx | 2 +- docs/docs/config/05-executor.mdx | 2 +- docs/docs/config/06-history.mdx | 2 +- docs/docs/config/07-errors.mdx | 2 +- docs/docs/config/index.mdx | 2 +- docs/docs/introduction/01-installation.mdx | 2 +- docs/docs/introduction/02-usage.mdx | 2 +- docs/docs/introduction/index.mdx | 3 +- docs/reference/_category_.yml | 1 - docs/reference/classes/_category_.yml | 2 - ...ironment_node.AllureNodeJestEnvironment.md | 130 -------- .../classes/index.JestAllure2Reporter.md | 284 ------------------ docs/reference/index.md | 87 ------ docs/reference/modules.md | 14 - docs/reference/modules/_category_.yml | 2 - docs/reference/modules/annotations.md | 189 ------------ docs/reference/modules/environment_node.md | 17 -- docs/reference/modules/index.md | 57 ---- website/docusaurus.config.js | 12 +- website/sidebars.js | 12 +- 34 files changed, 31 insertions(+), 823 deletions(-) delete mode 100644 docs/reference/_category_.yml delete mode 100644 docs/reference/classes/_category_.yml delete mode 100644 docs/reference/classes/environment_node.AllureNodeJestEnvironment.md delete mode 100644 docs/reference/classes/index.JestAllure2Reporter.md delete mode 100644 docs/reference/index.md delete mode 100644 docs/reference/modules.md delete mode 100644 docs/reference/modules/_category_.yml delete mode 100644 docs/reference/modules/annotations.md delete mode 100644 docs/reference/modules/environment_node.md delete mode 100644 docs/reference/modules/index.md diff --git a/docs/docs/api/01-descriptions.mdx b/docs/docs/api/01-descriptions.mdx index 782a2f7..4d6abe8 100644 --- a/docs/docs/api/01-descriptions.mdx +++ b/docs/docs/api/01-descriptions.mdx @@ -9,7 +9,7 @@ import TabItem from '@theme/TabItem'; :::caution -This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-alpha.*` release. +This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-beta.3` release. Please use GitHub docs for the latest stable version, `1.x.x`. ::: diff --git a/docs/docs/api/02-steps.mdx b/docs/docs/api/02-steps.mdx index a7770d8..e180de1 100644 --- a/docs/docs/api/02-steps.mdx +++ b/docs/docs/api/02-steps.mdx @@ -9,7 +9,7 @@ import TabItem from '@theme/TabItem'; :::caution -This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-alpha.*` release. +This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-beta.3` release. Please use GitHub docs for the latest stable version, `1.x.x`. ::: diff --git a/docs/docs/api/03-attachments.mdx b/docs/docs/api/03-attachments.mdx index bdd9bd5..40b67fb 100644 --- a/docs/docs/api/03-attachments.mdx +++ b/docs/docs/api/03-attachments.mdx @@ -9,7 +9,7 @@ import TabItem from '@theme/TabItem'; :::caution -This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-alpha.*` release. +This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-beta.3` release. Please use GitHub docs for the latest stable version, `1.x.x`. ::: diff --git a/docs/docs/api/04-parameters.mdx b/docs/docs/api/04-parameters.mdx index 46aed1e..d0de097 100644 --- a/docs/docs/api/04-parameters.mdx +++ b/docs/docs/api/04-parameters.mdx @@ -6,7 +6,7 @@ description: Parametrize your tests and steps :::caution -This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-alpha.*` release. +This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-beta.3` release. Please use GitHub docs for the latest stable version, `1.x.x`. ::: diff --git a/docs/docs/api/05-people.mdx b/docs/docs/api/05-people.mdx index 5c4a977..85835b1 100644 --- a/docs/docs/api/05-people.mdx +++ b/docs/docs/api/05-people.mdx @@ -9,7 +9,7 @@ import TabItem from '@theme/TabItem'; :::caution -This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-alpha.*` release. +This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-beta.3` release. Please use GitHub docs for the latest stable version, `1.x.x`. ::: diff --git a/docs/docs/api/06-severity.mdx b/docs/docs/api/06-severity.mdx index 3bb29b8..f2d6ed6 100644 --- a/docs/docs/api/06-severity.mdx +++ b/docs/docs/api/06-severity.mdx @@ -9,7 +9,7 @@ import TabItem from '@theme/TabItem'; :::caution -This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-alpha.*` release. +This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-beta.3` release. Please use GitHub docs for the latest stable version, `1.x.x`. ::: diff --git a/docs/docs/api/07-links.mdx b/docs/docs/api/07-links.mdx index ba5ed43..57d5369 100644 --- a/docs/docs/api/07-links.mdx +++ b/docs/docs/api/07-links.mdx @@ -9,7 +9,7 @@ import TabItem from '@theme/TabItem'; :::caution -This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-alpha.*` release. +This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-beta.3` release. Please use GitHub docs for the latest stable version, `1.x.x`. ::: diff --git a/docs/docs/api/08-labels.mdx b/docs/docs/api/08-labels.mdx index 40b6be0..2975e82 100644 --- a/docs/docs/api/08-labels.mdx +++ b/docs/docs/api/08-labels.mdx @@ -6,7 +6,7 @@ description: Tag your tests to provide additional context and detail. :::caution -This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-alpha.*` release. +This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-beta.3` release. Please use GitHub docs for the latest stable version, `1.x.x`. ::: diff --git a/docs/docs/config/01-grouping/01-by-suite.mdx b/docs/docs/config/01-grouping/01-by-suite.mdx index 2e1610d..322222c 100644 --- a/docs/docs/config/01-grouping/01-by-suite.mdx +++ b/docs/docs/config/01-grouping/01-by-suite.mdx @@ -9,7 +9,7 @@ import TabItem from '@theme/TabItem'; :::caution -This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-alpha.*` release. +This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-beta.3` release. Please use GitHub docs for the latest stable version, `1.x.x`. ::: diff --git a/docs/docs/config/01-grouping/02-by-story.mdx b/docs/docs/config/01-grouping/02-by-story.mdx index 12aa59a..c2a76dc 100644 --- a/docs/docs/config/01-grouping/02-by-story.mdx +++ b/docs/docs/config/01-grouping/02-by-story.mdx @@ -9,7 +9,7 @@ import TabItem from '@theme/TabItem'; :::caution -This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-alpha.*` release. +This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-beta.3` release. Please use GitHub docs for the latest stable version, `1.x.x`. ::: diff --git a/docs/docs/config/01-grouping/03-by-package.mdx b/docs/docs/config/01-grouping/03-by-package.mdx index 8ca4cc4..26f20fd 100644 --- a/docs/docs/config/01-grouping/03-by-package.mdx +++ b/docs/docs/config/01-grouping/03-by-package.mdx @@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem'; :::caution -This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-alpha.*` release. +This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-beta.3` release. Please use GitHub docs for the latest stable version, `1.x.x`. ::: diff --git a/docs/docs/config/01-grouping/04-by-category.mdx b/docs/docs/config/01-grouping/04-by-category.mdx index 699fca0..a5d885b 100644 --- a/docs/docs/config/01-grouping/04-by-category.mdx +++ b/docs/docs/config/01-grouping/04-by-category.mdx @@ -9,7 +9,7 @@ import TabItem from '@theme/TabItem'; :::caution -This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-alpha.*` release. +This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-beta.3` release. Please use GitHub docs for the latest stable version, `1.x.x`. ::: diff --git a/docs/docs/config/01-grouping/index.mdx b/docs/docs/config/01-grouping/index.mdx index 6dfff29..457de3e 100644 --- a/docs/docs/config/01-grouping/index.mdx +++ b/docs/docs/config/01-grouping/index.mdx @@ -4,7 +4,7 @@ import DocCardList from '@theme/DocCardList'; :::caution -This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-alpha.*` release. +This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-beta.3` release. Please use GitHub docs for the latest stable version, `1.x.x`. ::: @@ -24,4 +24,4 @@ Grouping can significantly enhance the organization and analysis of test results [1]: 01-by-suite.mdx [2]: 02-by-story.mdx [3]: 03-by-package.mdx -[4]: 04-by-defect.mdx +[4]: 04-by-category.mdx diff --git a/docs/docs/config/02-statuses.mdx b/docs/docs/config/02-statuses.mdx index 6f48706..af5b28d 100644 --- a/docs/docs/config/02-statuses.mdx +++ b/docs/docs/config/02-statuses.mdx @@ -9,7 +9,7 @@ import TabItem from '@theme/TabItem'; :::caution -This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-alpha.*` release. +This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-beta.3` release. Please use GitHub docs for the latest stable version, `1.x.x`. ::: diff --git a/docs/docs/config/04-environment.mdx b/docs/docs/config/04-environment.mdx index 0c94947..00e4db9 100644 --- a/docs/docs/config/04-environment.mdx +++ b/docs/docs/config/04-environment.mdx @@ -9,7 +9,7 @@ import TabItem from '@theme/TabItem'; :::caution -This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-alpha.*` release. +This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-beta.3` release. Please use GitHub docs for the latest stable version, `1.x.x`. ::: diff --git a/docs/docs/config/05-executor.mdx b/docs/docs/config/05-executor.mdx index a593d7b..d6dfb51 100644 --- a/docs/docs/config/05-executor.mdx +++ b/docs/docs/config/05-executor.mdx @@ -9,7 +9,7 @@ import TabItem from '@theme/TabItem'; :::caution -This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-alpha.*` release. +This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-beta.3` release. Please use GitHub docs for the latest stable version, `1.x.x`. ::: diff --git a/docs/docs/config/06-history.mdx b/docs/docs/config/06-history.mdx index 5e3f06d..c93d69d 100644 --- a/docs/docs/config/06-history.mdx +++ b/docs/docs/config/06-history.mdx @@ -7,7 +7,7 @@ description: Monitor long-term trends in your test execution. :::caution -This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-alpha.*` release. +This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-beta.3` release. Please use GitHub docs for the latest stable version, `1.x.x`. ::: diff --git a/docs/docs/config/07-errors.mdx b/docs/docs/config/07-errors.mdx index 91da102..f19beac 100644 --- a/docs/docs/config/07-errors.mdx +++ b/docs/docs/config/07-errors.mdx @@ -6,7 +6,7 @@ description: Distinguish between types of test failures. :::caution -This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-alpha.*` release. +This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-beta.3` release. Please use GitHub docs for the latest stable version, `1.x.x`. ::: diff --git a/docs/docs/config/index.mdx b/docs/docs/config/index.mdx index 5f32f49..f6438c2 100644 --- a/docs/docs/config/index.mdx +++ b/docs/docs/config/index.mdx @@ -8,7 +8,7 @@ import DocCardList from '@theme/DocCardList'; :::caution -This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-alpha.*` release. +This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-beta.3` release. Please use GitHub docs for the latest stable version, `1.x.x`. ::: diff --git a/docs/docs/introduction/01-installation.mdx b/docs/docs/introduction/01-installation.mdx index 777857e..22cb810 100644 --- a/docs/docs/introduction/01-installation.mdx +++ b/docs/docs/introduction/01-installation.mdx @@ -6,7 +6,7 @@ slug: /docs/installation :::caution -This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-alpha.*` release. +This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-beta.3` release. Please use GitHub docs for the latest stable version, `1.x.x`. ::: diff --git a/docs/docs/introduction/02-usage.mdx b/docs/docs/introduction/02-usage.mdx index cf626d0..58f6dec 100644 --- a/docs/docs/introduction/02-usage.mdx +++ b/docs/docs/introduction/02-usage.mdx @@ -6,7 +6,7 @@ slug: /docs/usage :::caution -This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-alpha.*` release. +This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-beta.3` release. Please use GitHub docs for the latest stable version, `1.x.x`. ::: diff --git a/docs/docs/introduction/index.mdx b/docs/docs/introduction/index.mdx index 0e82791..66f2ef7 100644 --- a/docs/docs/introduction/index.mdx +++ b/docs/docs/introduction/index.mdx @@ -7,7 +7,7 @@ slug: /docs :::caution -This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-alpha.*` release. +This website version refers to the unreleased version of `jest-allure2-reporter`, partially available as `2.0.0-beta.3` release. Please use GitHub docs for the latest stable version, `1.x.x`. ::: @@ -32,6 +32,7 @@ It provides several **entry points**:
jest-allure2-reporter
The reporter itself, which is responsible for collecting test results and generating a report.
+
jest-allure2-reporter/api
DSL to add additional metadata to your test definitions: $Link, $Owner.
`allure` runtime API to use inside your tests: allure.step, allure.attachment.
diff --git a/docs/reference/_category_.yml b/docs/reference/_category_.yml deleted file mode 100644 index 24a4602..0000000 --- a/docs/reference/_category_.yml +++ /dev/null @@ -1 +0,0 @@ -label: "API" \ No newline at end of file diff --git a/docs/reference/classes/_category_.yml b/docs/reference/classes/_category_.yml deleted file mode 100644 index 55c7980..0000000 --- a/docs/reference/classes/_category_.yml +++ /dev/null @@ -1,2 +0,0 @@ -label: "Classes" -position: 3 \ No newline at end of file diff --git a/docs/reference/classes/environment_node.AllureNodeJestEnvironment.md b/docs/reference/classes/environment_node.AllureNodeJestEnvironment.md deleted file mode 100644 index 9994053..0000000 --- a/docs/reference/classes/environment_node.AllureNodeJestEnvironment.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -id: "environment_node.AllureNodeJestEnvironment" -title: "Class: AllureNodeJestEnvironment" -sidebar_label: "AllureNodeJestEnvironment" -custom_edit_url: null ---- - -[environment-node](../modules/environment_node.md).AllureNodeJestEnvironment - -## Hierarchy - -- `TestEnvironment` - - ↳ **`AllureNodeJestEnvironment`** - -## Constructors - -### constructor - -• **new AllureNodeJestEnvironment**(`config`, `context`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `config` | `any` | -| `context` | `any` | - -#### Overrides - -TestEnvironment.constructor - -#### Defined in - -[packages/library/src/environment-node.ts:6](https://github.com/wix-incubator/jest-allure2-reporter/blob/039baf3/packages/library/src/environment-node.ts#L6) - -## Properties - -### testEvents - -• `Readonly` **testEvents**: `ReadonlyAsyncEmitter`<`ForwardedCircusEvent`, ``"*"`` \| `ForwardedCircusEventType`\> - -#### Inherited from - -TestEnvironment.testEvents - -#### Defined in - -node_modules/jest-metadata/dist/environment-decorator.d.ts:8 - -## Methods - -### #attachCode - -▸ `Private` **#attachCode**(`«destructured»`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `«destructured»` | `ForwardedCircusEvent` | - -#### Returns - -`void` - -#### Defined in - -[packages/library/src/environment-node.ts:19](https://github.com/wix-incubator/jest-allure2-reporter/blob/039baf3/packages/library/src/environment-node.ts#L19) - -___ - -### handleTestEvent - -▸ **handleTestEvent**(`event`, `state`): `void` \| `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `event` | `unknown` | -| `state` | `unknown` | - -#### Returns - -`void` \| `Promise`<`void`\> - -#### Inherited from - -TestEnvironment.handleTestEvent - -#### Defined in - -node_modules/jest-metadata/dist/environment-decorator.d.ts:4 - -___ - -### setup - -▸ **setup**(): `Promise`<`unknown`\> - -#### Returns - -`Promise`<`unknown`\> - -#### Inherited from - -TestEnvironment.setup - -#### Defined in - -node_modules/jest-metadata/dist/environment-decorator.d.ts:3 - -___ - -### teardown - -▸ **teardown**(): `Promise`<`unknown`\> - -#### Returns - -`Promise`<`unknown`\> - -#### Inherited from - -TestEnvironment.teardown - -#### Defined in - -node_modules/jest-metadata/dist/environment-decorator.d.ts:5 diff --git a/docs/reference/classes/index.JestAllure2Reporter.md b/docs/reference/classes/index.JestAllure2Reporter.md deleted file mode 100644 index e6b0cf3..0000000 --- a/docs/reference/classes/index.JestAllure2Reporter.md +++ /dev/null @@ -1,284 +0,0 @@ ---- -id: "index.JestAllure2Reporter" -title: "Class: JestAllure2Reporter" -sidebar_label: "JestAllure2Reporter" -custom_edit_url: null ---- - -[index](../modules/).JestAllure2Reporter - -## Hierarchy - -- `JestMetadataReporter` - - ↳ **`JestAllure2Reporter`** - -## Constructors - -### constructor - -• **new JestAllure2Reporter**(`globalConfig`, `options`) - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `globalConfig` | `GlobalConfig` | -| `options` | `Partial`<[`JestAllure2ReporterOptions`](../modules/#jestallure2reporteroptions)\> | - -#### Overrides - -JestMetadataReporter.constructor - -#### Defined in - -[packages/library/src/JestAllure2Reporter.ts:28](https://github.com/wix-incubator/jest-allure2-reporter/blob/039baf3/packages/library/src/JestAllure2Reporter.ts#L28) - -## Properties - -### #private - -• `Private` **#private**: `any` - -#### Inherited from - -JestMetadataReporter.#private - -#### Defined in - -node_modules/jest-metadata/dist/reporter.d.ts:7 - -___ - -### \_emitter - -• `Private` `Readonly` **\_emitter**: `ReporterEmitter` - -#### Defined in - -[packages/library/src/JestAllure2Reporter.ts:24](https://github.com/wix-incubator/jest-allure2-reporter/blob/039baf3/packages/library/src/JestAllure2Reporter.ts#L24) - -___ - -### \_options - -• `Private` `Readonly` **\_options**: `Partial`<[`JestAllure2ReporterOptions`](../modules/#jestallure2reporteroptions)\> - -#### Defined in - -[packages/library/src/JestAllure2Reporter.ts:25](https://github.com/wix-incubator/jest-allure2-reporter/blob/039baf3/packages/library/src/JestAllure2Reporter.ts#L25) - -___ - -### \_testRunContext - -• `Private` `Readonly` **\_testRunContext**: `TestRunContext` - -#### Defined in - -[packages/library/src/JestAllure2Reporter.ts:26](https://github.com/wix-incubator/jest-allure2-reporter/blob/039baf3/packages/library/src/JestAllure2Reporter.ts#L26) - -## Methods - -### getLastError - -▸ **getLastError**(): `void` \| `Error` - -#### Returns - -`void` \| `Error` - -#### Overrides - -JestMetadataReporter.getLastError - -#### Defined in - -[packages/library/src/JestAllure2Reporter.ts:105](https://github.com/wix-incubator/jest-allure2-reporter/blob/039baf3/packages/library/src/JestAllure2Reporter.ts#L105) - -___ - -### onRunComplete - -▸ **onRunComplete**(`testContexts`, `aggregatedResult`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `testContexts` | `Set`<`TestContext`\> | -| `aggregatedResult` | `AggregatedResult` | - -#### Returns - -`Promise`<`void`\> - -#### Overrides - -JestMetadataReporter.onRunComplete - -#### Defined in - -[packages/library/src/JestAllure2Reporter.ts:97](https://github.com/wix-incubator/jest-allure2-reporter/blob/039baf3/packages/library/src/JestAllure2Reporter.ts#L97) - -___ - -### onRunStart - -▸ **onRunStart**(`aggregatedResult`, `options`): `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `aggregatedResult` | `AggregatedResult` | -| `options` | `ReporterOnStartOptions` | - -#### Returns - -`Promise`<`void`\> - -#### Overrides - -JestMetadataReporter.onRunStart - -#### Defined in - -[packages/library/src/JestAllure2Reporter.ts:56](https://github.com/wix-incubator/jest-allure2-reporter/blob/039baf3/packages/library/src/JestAllure2Reporter.ts#L56) - -___ - -### onTestCaseResult - -▸ **onTestCaseResult**(`test`, `testCaseResult`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `test` | `Test` | -| `testCaseResult` | `AssertionResult` | - -#### Returns - -`void` - -#### Overrides - -JestMetadataReporter.onTestCaseResult - -#### Defined in - -[packages/library/src/JestAllure2Reporter.ts:73](https://github.com/wix-incubator/jest-allure2-reporter/blob/039baf3/packages/library/src/JestAllure2Reporter.ts#L73) - -___ - -### onTestFileResult - -▸ **onTestFileResult**(`test`, `testResult`, `aggregatedResult`): `void` \| `Promise`<`void`\> - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `test` | `Test` | -| `testResult` | `TestResult` | -| `aggregatedResult` | `AggregatedResult` | - -#### Returns - -`void` \| `Promise`<`void`\> - -#### Overrides - -JestMetadataReporter.onTestFileResult - -#### Defined in - -[packages/library/src/JestAllure2Reporter.ts:81](https://github.com/wix-incubator/jest-allure2-reporter/blob/039baf3/packages/library/src/JestAllure2Reporter.ts#L81) - -___ - -### onTestFileStart - -▸ **onTestFileStart**(`test`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `test` | `Test` | - -#### Returns - -`void` - -#### Overrides - -JestMetadataReporter.onTestFileStart - -#### Defined in - -[packages/library/src/JestAllure2Reporter.ts:66](https://github.com/wix-incubator/jest-allure2-reporter/blob/039baf3/packages/library/src/JestAllure2Reporter.ts#L66) - -___ - -### onTestResult - -▸ **onTestResult**(`_test`, `_testResult`, `_aggregatedResult`): `void` - -**`Deprecated`** - -**`See`** - - - - - - - - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_test` | `unknown` | -| `_testResult` | `unknown` | -| `_aggregatedResult` | `unknown` | - -#### Returns - -`void` - -#### Inherited from - -JestMetadataReporter.onTestResult - -#### Defined in - -node_modules/jest-metadata/dist/reporter.d.ts:35 - -___ - -### onTestStart - -▸ **onTestStart**(`_test`): `void` - -**`Deprecated`** - -**`See`** - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `_test` | `unknown` | - -#### Returns - -`void` - -#### Inherited from - -JestMetadataReporter.onTestStart - -#### Defined in - -node_modules/jest-metadata/dist/reporter.d.ts:19 diff --git a/docs/reference/index.md b/docs/reference/index.md deleted file mode 100644 index 8bfbb72..0000000 --- a/docs/reference/index.md +++ /dev/null @@ -1,87 +0,0 @@ ---- -id: "index" -title: "jest-allure2-reporter" -sidebar_label: "Readme" -sidebar_position: 0 -custom_edit_url: null ---- - -[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner-direct-single.svg)](https://stand-with-ukraine.pp.ua) - -
- - - -# jest-allure2-reporter - -Idiomatic Jest reporter for Allure Framework - -[![npm version](https://badge.fury.io/js/jest-allure2-reporter.svg)](https://badge.fury.io/js/jest-allure2-reporter) -[![CI](https://github.com/wix-incubator/jest-allure2-reporter/actions/workflows/ci.yml/badge.svg)](https://github.com/wix-incubator/jest-allure2-reporter/actions/workflows/ci.yml) -[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release) -[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) - -
- -## Installation - -> This is an express guide to get you started quickly. Please visit [our documentation website] for more information. - -Your project should have [`jest`] installed. The minimum supported version is `27.x`. - -Run in your project: - -```bash -npm install --save-dev jest-allure2-reporter -``` - -Edit your Jest config, e.g. `jest.config.js`: - -```diff -/** @type {import('@jest/types').Config.InitialOptions} */ -module.exports = { - // ... - reporters: [ - 'default', -+ 'jest-allure2-reporter', - ], -}; -``` - -## Usage - -Run your tests with `jest` as usual, e.g.: - -```bash -npm test -``` - -and then view the results: - -```bash -allure serve -``` - -![Example screenshot](../img/example.png) - -If you need to generate a static report, e.g., on CI, run instead: - -```bash -allure generate -``` - -Make sure you have `allure` CLI installed beforehand. For more information about it, refer to the official [Allure docs]. - -## Contributing - -See the [Contributing] guide on the website. - -## License - -Licensed under [MIT License]. - -[`jest`]: https://jestjs.io -[our documentation website]: https://wix-incubator.github.io/jest-allure2-reporter/ -[Allure docs]: https://docs.qameta.io/allure/#_get_started -[Contributing]: https://wix-incubator.github.io/jest-allure2-reporter/about/contributing -[MIT License]: LICENSE diff --git a/docs/reference/modules.md b/docs/reference/modules.md deleted file mode 100644 index ecb5f70..0000000 --- a/docs/reference/modules.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -id: "modules" -title: "jest-allure2-reporter" -sidebar_label: "Table of Contents" -sidebar_position: 0.5 -hide_table_of_contents: true -custom_edit_url: null ---- - -## Modules - -- [annotations](modules/annotations.md) -- [environment-node](modules/environment_node.md) -- [index](modules/) diff --git a/docs/reference/modules/_category_.yml b/docs/reference/modules/_category_.yml deleted file mode 100644 index 63f9c4e..0000000 --- a/docs/reference/modules/_category_.yml +++ /dev/null @@ -1,2 +0,0 @@ -label: "Modules" -position: 1 \ No newline at end of file diff --git a/docs/reference/modules/annotations.md b/docs/reference/modules/annotations.md deleted file mode 100644 index f49565c..0000000 --- a/docs/reference/modules/annotations.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -id: "annotations" -title: "Module: annotations" -sidebar_label: "annotations" -sidebar_position: 0 -custom_edit_url: null ---- - -## Functions - -### $Description - -▸ **$Description**(`description`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `description` | `string` | - -#### Returns - -`void` - -#### Defined in - -[packages/library/src/annotations.ts:14](https://github.com/wix-incubator/jest-allure2-reporter/blob/039baf3/packages/library/src/annotations.ts#L14) - -___ - -### $DescriptionHtml - -▸ **$DescriptionHtml**(`descriptionHtml`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `descriptionHtml` | `string` | - -#### Returns - -`void` - -#### Defined in - -[packages/library/src/annotations.ts:16](https://github.com/wix-incubator/jest-allure2-reporter/blob/039baf3/packages/library/src/annotations.ts#L16) - -___ - -### $Issue - -▸ **$Issue**(`issue`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `issue` | `string` | - -#### Returns - -`void` - -#### Defined in - -[packages/library/src/annotations.ts:18](https://github.com/wix-incubator/jest-allure2-reporter/blob/039baf3/packages/library/src/annotations.ts#L18) - -___ - -### $Lead - -▸ **$Lead**(`lead`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `lead` | `string` | - -#### Returns - -`void` - -#### Defined in - -[packages/library/src/annotations.ts:19](https://github.com/wix-incubator/jest-allure2-reporter/blob/039baf3/packages/library/src/annotations.ts#L19) - -___ - -### $Link - -▸ **$Link**(`name`, `url`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `url` | `string` | - -#### Returns - -`void` - -#### Defined in - -[packages/library/src/annotations.ts:21](https://github.com/wix-incubator/jest-allure2-reporter/blob/039baf3/packages/library/src/annotations.ts#L21) - -___ - -### $Owner - -▸ **$Owner**(`owner`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `owner` | `string` | - -#### Returns - -`void` - -#### Defined in - -[packages/library/src/annotations.ts:20](https://github.com/wix-incubator/jest-allure2-reporter/blob/039baf3/packages/library/src/annotations.ts#L20) - -___ - -### $Severity - -▸ **$Severity**(`severity`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `severity` | `string` | - -#### Returns - -`void` - -#### Defined in - -[packages/library/src/annotations.ts:22](https://github.com/wix-incubator/jest-allure2-reporter/blob/039baf3/packages/library/src/annotations.ts#L22) - -___ - -### $Tag - -▸ **$Tag**(`...tagNames`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `...tagNames` | `string`[] | - -#### Returns - -`void` - -#### Defined in - -[packages/library/src/annotations.ts:25](https://github.com/wix-incubator/jest-allure2-reporter/blob/039baf3/packages/library/src/annotations.ts#L25) - -___ - -### $TmsLink - -▸ **$TmsLink**(`name`, `url`): `void` - -#### Parameters - -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `url` | `string` | - -#### Returns - -`void` - -#### Defined in - -[packages/library/src/annotations.ts:23](https://github.com/wix-incubator/jest-allure2-reporter/blob/039baf3/packages/library/src/annotations.ts#L23) diff --git a/docs/reference/modules/environment_node.md b/docs/reference/modules/environment_node.md deleted file mode 100644 index 74eaa57..0000000 --- a/docs/reference/modules/environment_node.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -id: "environment_node" -title: "Module: environment-node" -sidebar_label: "environment-node" -sidebar_position: 0 -custom_edit_url: null ---- - -## Classes - -- [AllureNodeJestEnvironment](../classes/environment_node.AllureNodeJestEnvironment.md) - -## References - -### default - -Renames and re-exports [AllureNodeJestEnvironment](../classes/environment_node.AllureNodeJestEnvironment.md) diff --git a/docs/reference/modules/index.md b/docs/reference/modules/index.md deleted file mode 100644 index e3e9db3..0000000 --- a/docs/reference/modules/index.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -id: "index" -title: "Module: index" -sidebar_label: "index" -sidebar_position: 0 -custom_edit_url: null ---- - -## Classes - -- [JestAllure2Reporter](../classes/.JestAllure2Reporter) - -## References - -### default - -Renames and re-exports [JestAllure2Reporter](../classes/.JestAllure2Reporter) - -## Type Aliases - -### JestAllure2ReporterOptions - -Ƭ **JestAllure2ReporterOptions**: `Object` - -Options to use with jest-allure2-reporter package in Jest config - -**`Example`** - -```ts -{ - * // ... - * reporters: [ - * 'default', - * [ - * 'jest-allure2-reporter', - * { - * resultsDir: 'allure-results', - * packageName: 'my-package', - * errorsAsFailedAssertions: true, - * }, - * } -``` - -#### Type declaration - -| Name | Type | Description | -| :------ | :------ | :------ | -| `environmentInfo` | `boolean` \| `JestAllure2Reporter$EnvironmentInfoCustomizer` | Getter function to extract environment information from the test environment. By default, the environment information is extracted from the `process.env` object. Use boolean `false` to disable environment information. **`Default`** ```ts true ``` | -| `errorsAsFailedAssertions` | `boolean` | Treat thrown errors as failed assertions. By default, the reporter distinguishes between failed assertions and thrown errors. The former are reported as FAILED tests, the latter as BROKEN tests. **`Default`** ```ts false ``` | -| `executorInfo` | `JestAllure2Reporter$TestCaseExtractor`<`Allure$ExecutorInfo`\> | Getter function to extract executor information from the test environment. The executor is the build agent or any other system that initiates the test run. | -| `overwriteResultsDir` | `boolean` | Whether the reporter should delete the results directory before running tests. **`Default`** ```ts true ``` | -| `resultsDir` | `string` | Path to the directory where the report will be generated. **`Default`** ```ts /allure-results ``` | -| `testInfo` | `Partial`<`JestAllure2Reporter$TestInfoCustomizer`\> | - | - -#### Defined in - -[packages/library/src/JestAllure2ReporterOptions.ts:19](https://github.com/wix-incubator/jest-allure2-reporter/blob/039baf3/packages/library/src/JestAllure2ReporterOptions.ts#L19) diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 9fc5b9f..c05768f 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -79,13 +79,7 @@ const config = { label: 'Docs', }, { - type: 'docSidebar', - sidebarId: 'referenceSidebar', - position: 'left', - label: 'Reference', - }, - { - href: 'https://allure-framework.github.io/allure-demo/5/', + href: 'https://allure-report-20231215124928.surge.sh/', label: 'Demo', position: 'left', }, @@ -114,10 +108,6 @@ const config = { label: 'API', to: '/docs/api', }, - { - label: 'Reference', - to: '/docs/reference', - }, ], }, { diff --git a/website/sidebars.js b/website/sidebars.js index 44518b4..f83a11c 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -19,12 +19,12 @@ const sidebars = { aboutSidebar: [ {type: 'autogenerated', dirName: 'about'}, ], - referenceSidebar: [ - 'reference/index', - 'reference/modules/annotations', - 'reference/modules/environment_node', - 'reference/classes/index.JestAllure2Reporter', - ], + // referenceSidebar: [ + // 'reference/index', + // 'reference/modules/annotations', + // 'reference/modules/environment_node', + // 'reference/classes/index.JestAllure2Reporter', + // ], }; module.exports = sidebars;