jest-circus-allure-environment - npm Package Compare versions

Comparing version 0.11.2 to 0.11.3

CHANGELOG.md

@@ -0,1 +1,8 @@
+## [0.11.3](https://github.com/ryparker/jest-circus-allure-environment/compare/v0.11.2...v0.11.3) (2020-09-03)
+
+
+### Bug Fixes
+
+* **allure.description:** allure.description should now fetch the currently active test ([f645bae](https://github.com/ryparker/jest-circus-allure-environment/commit/f645bae9dc0e48a23052ed51be873c52ea53d2ad))
+
 ## [0.11.2](https://github.com/ryparker/jest-circus-allure-environment/compare/v0.11.1...v0.11.2) (2020-07-23)
@@ -2,0 +9,0 @@

dist/index.js

@@ -10,5 +10,6 @@ "use strict";
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = void 0;
 var allure_node_environment_1 = require("./allure-node-environment");
@@ -15,0 +16,0 @@ Object.defineProperty(exports, "default", { enumerable: true, get: function () { return allure_node_environment_1.default; } });

dist/jest-allure-interface.d.ts

 /// <reference types="node" />
-import { Allure, AllureRuntime, AllureStep, AllureTest, ContentType, ExecutableItemWrapper, Status, StepInterface, Severity } from 'allure-js-commons';
+import { Allure, AllureRuntime, AllureStep, AllureTest, ContentType, ExecutableItemWrapper, Severity, Status, StepInterface } from 'allure-js-commons';
 import type AllureReporter from './allure-reporter';
@@ -4,0 +4,0 @@ import StepWrapper from './step-wrapper';

dist/jest-allure-interface.js

@@ -92,6 +92,14 @@ "use strict";
     description(markdown) {
-        this.description(markdown);
+        const { currentTest } = this.reporter;
+        if (!currentTest) {
+            throw new Error('Expected a test to be executing before adding a description.');
+        }
+        currentTest.description = markdown;
     }
     descriptionHtml(html) {
-        this.descriptionHtml(html);
+        const { currentTest } = this.reporter;
+        if (!currentTest) {
+            throw new Error('Expected a test to be executing before adding an HTML description.');
+        }
+        currentTest.descriptionHtml = html;
     }
@@ -98,0 +106,0 @@ attachment(name, content, type) {

package.json

 {
   "name": "jest-circus-allure-environment",
-  "version": "0.11.2",
+  "version": "0.11.3",
   "repository": "https://github.com/ryparker/jest-circus-allure-environment.git",
@@ -55,14 +55,14 @@ "author": "Ryan Parker <[e-mail]>",
   "dependencies": {
-    "@jest/environment": "^26.1.0",
-    "@jest/reporters": "^26.1.0",
-    "@jest/types": "^26.1.0",
-    "allure-js-commons": "^2.0.0-beta.7",
+    "@jest/environment": "^26.3.0",
+    "@jest/reporters": "^26.4.1",
+    "@jest/types": "^26.3.0",
+    "allure-js-commons": "2.0.0-beta.8",
     "ansi_up": "^4.0.4",
     "crypto": "^1.0.1",
-    "jest-circus": "^26.1.0",
+    "jest-circus": "^26.4.2",
     "jest-docblock": "^26.0.0",
-    "jest-environment-node": "^26.1.0",
-    "lodash": "^4.17.19",
-    "prettier": "^2.0.5",
-    "pretty-format": "^26.1.0",
+    "jest-environment-node": "^26.3.0",
+    "lodash": "^4.17.20",
+    "prettier": "^2.1.1",
+    "pretty-format": "^26.4.2",
     "strip-ansi": "^6.0.0"
@@ -74,15 +74,16 @@ },
     "@types/allure-js-commons": "^0.0.1",
-    "@types/jest": "^26.0.5",
-    "@types/lodash": "^4.14.158",
-    "@types/node": "^14.0.24",
-    "commitizen": "^4.1.2",
-    "cz-conventional-changelog": "^3.2.0",
-    "eslint-config-xo-typescript": "^0.31.0",
-    "eslint-plugin-jest": "^23.18.0",
+    "@types/highlight.js": "^9.12.4",
+    "@types/jest": "^26.0.13",
+    "@types/lodash": "^4.14.161",
+    "@types/node": "^14.6.3",
+    "commitizen": "^4.2.1",
+    "cz-conventional-changelog": "^3.3.0",
+    "eslint-config-xo-typescript": "^0.32.0",
+    "eslint-plugin-jest": "^23.20.0",
     "husky": "^4.2.5",
-    "jest": "^26.1.0",
-    "lint-staged": "^10.2.11",
+    "jest": "^26.4.2",
+    "lint-staged": "^10.3.0",
     "semantic-release": "^17.1.1",
-    "typescript": "^3.9.7",
-    "xo": "^0.32.1"
+    "typescript": "^4.0.2",
+    "xo": "^0.33.1"
   },
@@ -89,0 +90,0 @@ "engines": {

README.md

 # Jest Circus Allure Environment
 
+[![jest](https://jestjs.io/img/jest-badge.svg)](https://github.com/facebook/jest)
 ![Lint-Build-Test-Publish](https://github.com/ryparker/jest-circus-allure-reporter/workflows/Lint-Build-Test-Publish/badge.svg)
@@ -128,3 +129,2 @@ [![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/xojs/xo)
 
-
 ### 🔍 Descriptions
@@ -136,6 +136,6 @@
 test('does something important, when triggered by user', () => {
-	/** This uses a 3rd party API that typically undergoes maintenance on Tuesdays.
-	 */
+  /** This uses a 3rd party API that typically undergoes maintenance on Tuesdays.
+   */
 
-	...
+  ...
 })
@@ -148,12 +148,12 @@ ```
 
-_Set multiple tags using a `, ` deliminator._
+_Set multiple tags using a `,` deliminator._
 
 ```TS
 test('does something important, when triggered by user', () => {
-	/**
-	 * @tag beta
-	 * @tag feature-flagged, api-v3
-	 */
+  /**
+   * @tag beta
+   * @tag feature-flagged, api-v3
+   */
 
-	...
+  ...
 })
@@ -168,7 +168,7 @@ ```
 test('does something important, when triggered by user', () => {
-	/**
-	 * @owner ios-team
-	 */
+  /**
+   * @owner ios-team
+   */
 
-	...
+  ..
 })
@@ -193,7 +193,7 @@ ```
 test('does something important, when triggered by user', () => {
-	/**
-	 * @severity critical
-	 */
+  /**
+   * @severity critical
+   */
 
-	...
+  ...
 })
@@ -212,14 +212,13 @@ ```
 
+Example:
 
-Example
-
 ```TS
 test('validation message appears, when email field is skipped', () => {
-	/**
-	 * @epic Automate user sign up
-	 * @feature Registration page
-	 * @story Validate required registration fields before creating new user
-	 */
+  /**
+   * @epic Automate user sign up
+   * @feature Registration page
+   * @story Validate required registration fields before creating new user
+   */
 
-	...
+  ...
 })
@@ -237,13 +236,12 @@ ```
 
+Example:
 
-Example
-
 ```TS
 test('validation message appears, when email field is skipped', () => {
-	/**
-	 * @issue DEBT-60
-	 * @tms CORE-122
-	 */
+  /**
+   * @issue DEBT-60
+   * @tms CORE-122
+   */
 
-	...
+  ...
 })
@@ -254,3 +252,2 @@ ```
 
-
 ### 🎛 Global Allure API
@@ -262,3 +259,3 @@
 /**
- * Returns the Allure test instance for the currently running test when called inside of a test.
+ * Returns the Allure test instance for the currently running test.
  */
@@ -268,5 +265,5 @@ allure.currentTest(): AllureTest;
 /**
- * Starts and returns a new step instance on the current executable.
+ * Adds a description to the report of the current test. Supports markdown.
  */
-allure.description(description: string): void;
+allure.description(markdown: string): void;
 
@@ -279,8 +276,8 @@ /**
 /**
- * Starts a new Allure step sets it's status and attachments then ends the step all in one method.
+ * Starts a new Allure step, sets the status, and adds any provided attachments (optional), then ends the step.
  */
 allure.logStep(
-	name: string,
-	status: Status,
-	attachments?: Array<{ name: string; content: string; type: ContentType }>
+  name: string,
+  status: Status,
+  attachments?: Array<{ name: string; content: string; type: ContentType }>
 ): void;
@@ -297,5 +294,5 @@
 allure.attachment(
-	name: string,
-	content: Buffer | string,
-	type: ContentType
+  name: string,
+  content: Buffer | string,
+  type: ContentType
 );
@@ -302,0 +299,0 @@

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

72608

increased by1.6%

Lines of code

847

increased by1.07%

Worsened metrics

Dev dependency count

17

increased by6.25%

Number of lines in readme file

328

decreased by-0.91%

Dependency changes

• + Addedallure-js-commons@2.0.0-beta.8(transitive)

• + Addedmkdirp@1.0.4(transitive)

• - Removedallure-js-commons@2.15.1(transitive)

• - Removedansi-regex@4.1.1(transitive)

• - Removedcharenc@0.0.2(transitive)

• - Removedcrypt@0.0.2(transitive)

• - Removedmd5@2.3.0(transitive)

• - Removedstrip-ansi@5.2.0(transitive)

• Updated@jest/environment@^26.3.0

• Updated@jest/reporters@^26.4.1

• Updated@jest/types@^26.3.0

• Updatedallure-js-commons@2.0.0-beta.8

• Updatedjest-circus@^26.4.2

• Updatedjest-environment-node@^26.3.0

• Updatedlodash@^4.17.20

• Updatedprettier@^2.1.1

• Updatedpretty-format@^26.4.2