jest-allure2-adapter - npm Package Compare versions

Comparing version 0.2.18 to 0.2.19

package.json

 {
   "name": "jest-allure2-adapter",
-  "version": "0.2.18",
+  "version": "0.2.19",
   "description": "Allure 2 Adapter for jest",
@@ -5,0 +5,0 @@ "main": "./dist/index",

readme.md

@@ -42,6 +42,6 @@ # Jest-Allure-2 reporting plugin
 
-Then add `jest-allure2-adapter/dist/setup` to `setupFilesAfterEnv` section of your config.
+Then add `jest-allure2-adapter/dist/setup-default` to `setupFilesAfterEnv` section of your config.
 
 ```
-setupFilesAfterEnv: ["jest-allure2-adapter/dist/setup"]
+setupFilesAfterEnv: ["jest-allure2-adapter/dist/setup-default"]
 ```
@@ -128,2 +128,50 @@
 
+## Custrom Jasmine reporter
+
+To use custom jasmine reporter - for example to add smth into allure on spec started you can use custom jasmine reporter.
+In this case you do not need to add `jest-allure2-adapter/dist/setup-default` into SetupFilesAfterEnv section.
+see example:
+
+```json
+// jest.setup.ts
+setupFilesAfterEnv: [
+    './config/jest-custom-reporter.ts',
+  ],
+```
+
+```typescript
+// jest-custom-reporter.ts
+import { AllureReporterApi, jasmine_ } from 'jest-allure2-adapter';
+import { relative } from 'path';
+import { registerAllureReporter } from 'jest-allure2-adapter/dist/setup';
+
+class JasmineAllureReporter implements jasmine_.CustomReporter {
+  private allure: AllureReporterApi;
+
+  constructor(allure: AllureReporterApi) {
+    this.allure = allure;
+  }
+
+  suiteStarted(suite?: jasmine_.CustomReporterResult) {
+    this.allure.startGroup(suite.description);
+    // some actions here on suite started
+  }
+
+  suiteDone() {
+    this.allure.endGroup();
+  }
+
+  specStarted(spec: jasmine_.CustomReporterResult) {
+    this.allure.startTest(spec);
+    // some actions here on test started
+  }
+
+  specDone(spec: jasmine_.CustomReporterResult) {
+    this.allure.endTest(spec);
+  }
+}
+
+registerAllureReporter((allure) => new JasmineAllureReporter(allure));
+```
+
 **Example (todo)**
@@ -165,3 +213,3 @@
 
-- [X] Ability to implement own JasmineAllureReporter (0.2.16)
+- [x] Ability to implement own JasmineAllureReporter (0.2.16)
 - [ ] Add before/after hooks
@@ -168,0 +216,0 @@ - [ ] Add examples

New alerts

License Policy Violation

License

This 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

License

This 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

48507

increased by2.71%

Number of lines in readme file

234

increased by25.81%

No dependency changes