jest-allure2-adapter
Advanced tools
jest-allure2-adapter - npm Package Compare versions
Comparing version 0.3.1 to 0.3.2
| { | ||
| "name": "jest-allure2-adapter", | ||
| "version": "0.3.1", | ||
| "version": "0.3.2", | ||
| "description": "Allure 2 Adapter for jest", | ||
@@ -5,0 +5,0 @@ "main": "./dist/index", |
@@ -5,3 +5,3 @@ # Jest-Allure-2 reporting plugin | ||
| #### Add more power to your tests using Jest-Allure. Easily generate nice reports at the end of the execution. | ||
| Add more power to your tests using Jest-Allure. Easily generate nice reports at the end of the execution. | ||
@@ -16,2 +16,15 @@ [](https://github.com/jest-community/awesome-jest) | ||
| ## Table of Contents | ||
| 1. [Examples](#Examples) | ||
| 2. [Installation](#Installation) | ||
| 3. [Cofiguration](#Cofiguration) | ||
| 4. [How to get a report](#How-to-get-a-report) | ||
| 5. [Advanced features](#Advanced-features) | ||
| - [Custrom Jasmine reporter](#Custrom-Jasmine-reporter) | ||
| - [Warning](#Warning) | ||
| 6. [What's next](#What's-next) | ||
| 7. [Feature Notes](#Feature-Notes) | ||
| 8. [Releases](#Releases) | ||
| #### Examples | ||
@@ -30,3 +43,3 @@ | ||
| #### Installation | ||
| ### Installation | ||
@@ -43,3 +56,3 @@ ``` | ||
| ### jest -v >24 ? | ||
| #### jest -v >24 ? | ||
@@ -52,3 +65,3 @@ Then add `jest-allure2-adapter/dist/setup-default` to `setupFilesAfterEnv` section of your config. | ||
| ### jest -v < 24 ? | ||
| #### jest -v < 24 ? | ||
@@ -65,4 +78,18 @@ #### add reporter to jest.config.js | ||
| #### How to get a report | ||
| ### Cofiguration | ||
| Object of the following type can be added into registerAllureReporter as first argument. | ||
| ```javascript | ||
| resultsDir?: string; | ||
| stepTimestamp?: boolean; | ||
| addStepStatusDetailsAttachment?: boolean; // add attachment with step status details | ||
| tmsLink?: (id: string) => string; | ||
| issueLink?: (id: string) => string; | ||
| ``` | ||
| --- | ||
| ### How to get a report | ||
| You need to install the [CLI](https://github.com/allure-framework/allure2#download) in order to obtain a report. | ||
@@ -84,3 +111,3 @@ | ||
| # Advanced features | ||
| ## Advanced features | ||
@@ -94,3 +121,3 @@ You can add description, screenshots, steps, severity and lots of other | ||
| test: AllureCurrentApi; // actions for current test | ||
| startGroup(name: string): void; | ||
@@ -114,16 +141,16 @@ startTest(spec: jasmine_.CustomReporterResult): void; | ||
| endGroup(): void; | ||
| writeCategories(categories: Category[]): void; | ||
| addEnvironment(name: string, value: string): this; | ||
| logStep(name: string, status: Status, attachments?: [Attachment]): void; | ||
| attachment(name: string, content: Buffer | string, type?: ContentType): void; | ||
| addParameter(name: string, value: string): this; | ||
| addParameters(...params: [string, any][]): this; | ||
| description(description: string): this; // sets description to current executable (test / step) | ||
| descriptionHtml(description: string): this; // sets description to current executable (test / step) | ||
| addDescription(description: string): void; // adds html description to test | ||
| addPackage(value: string): this; | ||
@@ -149,3 +176,3 @@ addLink(options: { name?: string; url: string; type?: LinkType }): this; | ||
| ## Custrom Jasmine reporter | ||
| ### Custrom Jasmine reporter | ||
@@ -204,3 +231,6 @@ To use custom jasmine reporter - for example to add smth into allure when spec or suite started you can use custom jasmine reporter. | ||
| registerAllureReporter(undefined, (allure) => new JasmineAllureReporter(allure)); | ||
| registerAllureReporter( | ||
| undefined, | ||
| (allure) => new JasmineAllureReporter(allure), | ||
| ); | ||
| ``` | ||
@@ -242,21 +272,6 @@ | ||
| ### Cofiguration | ||
| Oject of the following type can be added into registerAllureReporter as first argument. | ||
| ```javascript | ||
| resultsDir?: string; | ||
| stepTimestamp?: boolean; | ||
| addStepStatusDetailsAttachment?: boolean; // add attachment with step status details | ||
| tmsLink?: (id: string) => string; | ||
| issueLink?: (id: string) => string; | ||
| ``` | ||
| ## What's next | ||
| #### What's next | ||
| -[x] Ability to implement own JasmineAllureReporter (0.2.16) -[ ] Add before/after hooks -[ ] Add examples -[x] Ability to config (timestamp to step, jira link) (0.2.53) -[ ] historyId? -[ ] Add param to stepStatus to add attachment with details or not | ||
| - [x] Ability to implement own JasmineAllureReporter (0.2.16) | ||
| - [ ] Add before/after hooks | ||
| - [ ] Add examples | ||
| - [x] Ability to config (timestamp to step, jira link) (0.2.53) | ||
| - [ ] historyId? | ||
| --- | ||
@@ -275,3 +290,3 @@ | ||
| ### Feature Notes | ||
| ## Feature Notes | ||
@@ -291,3 +306,3 @@ #### Setting feature, story to all tests in file | ||
| - stepTimestamp: add timestamp to step or not, false by default | ||
| - addStepStatusDetailsAttachment: add step status details attachment (status details doesn't work in report, so this is workaround), buy default false | ||
| - addStepStatusDetailsAttachment: add step status details attachment (status details doesn't work in report, so this is workaround), false by default | ||
| - tmsLink / issueLink: links pattern for adding issues (`tmsLink: (id) => http://someissue.com/${id}`) | ||
@@ -294,0 +309,0 @@ |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by1.04%
40956
- Number of lines in readme file
- increased by4.53%
346