Next

package.json

@@ -1,9 +1,10 @@
 {
   "name": "mochawesome",
-  "version": "6.2.2",
+  "version": "7.0.0-alpha.0",
   "description": "A gorgeous reporter for Mocha.js",
   "scripts": {
     "lint": "eslint src test*",
+    "dev": "mocha test-functional/simple --config test-functional/.mocharc.json",
     "test": "npm run lint && cross-env NODE_ENV=test nyc mocha --config test/.mocharc.json",
     "test:fn": "mocha test-functional --config test-functional/.mocharc.json",
     "test:par": "mocha test-parallel --parallel --config test-parallel/.mocharc.json",
@@ -48,32 +49,37 @@
     "branches": 90
   },
   "dependencies": {
+    "@typescript-eslint/eslint-plugin": "^4.29.3",
+    "@typescript-eslint/parser": "^4.29.3",
     "chalk": "^4.1.0",
     "diff": "^5.0.0",
     "json-stringify-safe": "^5.0.1",
-    "lodash.isempty": "^4.4.0",
-    "lodash.isfunction": "^3.0.9",
-    "lodash.isobject": "^3.0.2",
-    "lodash.isstring": "^4.0.1",
+    "lodash": "^4.17.21",
     "mochawesome-report-generator": "^5.2.0",
     "strip-ansi": "^6.0.0",
     "uuid": "^8.3.2"
   },
   "peerDependencies": {
-    "mocha": ">=7"
+    "mocha": ">=9"
   },
   "devDependencies": {
+    "@types/diff": "^5.0.1",
+    "@types/json-stringify-safe": "^5.0.0",
+    "@types/lodash": "^4.14.172",
+    "@types/mocha": "^9.0.0",
+    "@types/node": "^16.7.1",
     "cross-env": "^7.0.3",
     "eslint": "^7.20.0",
     "eslint-config-prettier": "^7.2.0",
     "husky": "^5.0.9",
     "lint-staged": "^10.5.4",
-    "mocha": "^8.3.0",
+    "mocha": "^9.1.0",
     "nyc": "^15.1.0",
     "prettier": "^2.2.1",
     "proxyquire": "^2.1.0",
     "should": "^13.2.3",
-    "sinon": "^9.2.4"
+    "sinon": "^9.2.4",
+    "typescript": "^4.3.5"
   },
   "lint-staged": {
     "*.js": "eslint --cache --fix",

src/addContext.ts

@@ -0,0 +1,117 @@
+import isObject from 'lodash/isobject';
+import jsonStringify from 'json-stringify-safe';
+import Logger from './logger';
+
+const logger = new Logger(console);
+const errorPrefix = 'Error adding context:';
+const ERRORS = {
+  INVALID_ARGS: `${errorPrefix} Invalid arguments.`,
+  INVALID_TEST: `${errorPrefix} Invalid test object.`,
+  INVALID_CONTEXT: (ctx: Mochawesome.ContextArg) => {
+    const expected =
+      'Expected a string or an object of shape { title: string, value: any } but saw:';
+    return `${errorPrefix} ${expected}\n${jsonStringify(
+      ctx,
+      (key, val) => (val === undefined ? 'undefined' : val),
+      2
+    )}`;
+  },
+};
+
+function _normalizeContext(
+  context: Mochawesome.ContextArg
+): Mochawesome.Context | undefined {
+  // Ensure that context meets the requirements
+  if (
+    (typeof context === 'string' && !context.trim()) ||
+    (typeof context === 'object' && context.title === undefined)
+  ) {
+    logger.error(ERRORS.INVALID_CONTEXT(context));
+    return;
+  }
+
+  if (typeof context === 'string') {
+    return {
+      title: '',
+      value: context,
+    };
+  }
+
+  if (context.value === undefined) {
+    return {
+      ...context,
+      value: 'undefined',
+    };
+  }
+
+  return context;
+}
+
+/**
+ * Add context to the test object so it can
+ * be displayed in the mochawesome report
+ *
+ * Usage:
+ *
+ * it('should test something', function () {
+ *   someFunctionThatTestsCode();
+ *
+ *   addContext(this, 'some context to add');
+ *
+ *   addContext(this, {
+ *     title: 'Expected number of something'
+ *     value: 42
+ *   });
+ *
+ *   assert('something');
+ * });
+ *
+ */
+const addContext = function (
+  runnable: MochaRunnable,
+  _context: Mochawesome.ContextArg
+) {
+  // Check args to see if we should bother continuing
+  if (!runnable || !_context || !isObject(runnable)) {
+    logger.error(ERRORS.INVALID_ARGS);
+    return;
+  }
+
+  const context = _normalizeContext(_context);
+  if (!context) {
+    return;
+  }
+
+  /*
+   * When `addContext` is called from inside a hook the test object
+   * will be `.currentTest`, and the hook will be `.test`.
+   * Otherwise the test is just `.test` and `.currentTest` is undefined.
+   */
+  const { currentTest, test: activeTest } = runnable;
+
+  /*
+   * For `beforeAll` and `afterAll`, add the context to the hook,
+   * otherwise add it to the actual test.
+   */
+  const isEachHook =
+    currentTest &&
+    activeTest &&
+    /^"(?:before|after)\seach"/.test(activeTest.title);
+
+  const theTest = isEachHook ? currentTest : activeTest;
+
+  if (!theTest) {
+    logger.error(ERRORS.INVALID_TEST);
+    return;
+  }
+
+  // Test doesn't already have context -> set it
+  if (!theTest.context) {
+    theTest.context = [context];
+  } else if (Array.isArray(theTest.context)) {
+    // Test has context and context is an array -> push new context
+    theTest.context.push(context);
+  }
+};
+
+export = addContext;