monocart-reporter 2.1.0 → 2.2.0

package/lib/platform/share.js

@@ -2,7 +2,6 @@ const Util = {
 
     // definition
     tagPattern: /(\s*)@([^@\s]+)(\s*)/g,
-    lineBreakPattern: /\r\n|[\r\n\u2028\u2029]/gu,
 
     attachments: {
         audit: {

package/lib/plugins/comments.js

@@ -1,21 +1,10 @@
 const fs = require('fs');
 const Util = require('../utils/util.js');
-const parseSource = require('../utils/parse-source.js');
+const { Locator } = require('monocart-formatter/node');
 
 const cacheMap = new Map();
 
-function getEmptyLines(lines) {
-    const emptyLines = [];
-    const reg = /\S/;
-    lines.forEach((text, i) => {
-        if (!reg.test(text)) {
-            emptyLines.push(i + 1);
-        }
-    });
-    return emptyLines;
-}
-
-const getFileComments = (sourcePath, options = {}) => {
+const getFileComments = (sourcePath) => {
 
     const map = new Map();
 
@@ -27,33 +16,43 @@ const getFileComments = (sourcePath, options = {}) => {
 
     const source = fs.readFileSync(sourcePath).toString('utf-8');
 
-    const ast = parseSource({
-        source,
-        sourcePath,
-        options
+    const locator = new Locator(source);
+
+    const { comments, lines } = locator.lineParser;
+
+    // get empty lines, no value
+    lines.forEach((item) => {
+        if (item.blank) {
+            // 0-base
+            map.set(item.line + 1, {});
+        }
     });
 
-    if (!ast) {
-        return map;
-    }
+    comments.forEach((item) => {
+        const {
+            start, end, text
+        } = item;
+
+        // using last line
+        // 1-base
+        const eLoc = locator.offsetToLocation(end);
+        map.set(eLoc.line, {
+            value: text
+        });
+
+        // exists first line
+        if (map.has(1)) {
+            return;
+        }
 
-    ast.comments.forEach((item) => {
         // first line comments for file line 0
-        const startLine = item.loc.start.line;
-        if (startLine === 1) {
+        const sLoc = locator.offsetToLocation(start);
+        if (sLoc.line === 1) {
             map.set(1, {
-                value: item.value
+                value: text
             });
         }
-        map.set(item.loc.end.line, {
-            value: item.value
-        });
-    });
 
-    // get empty lines
-    const lines = source.split(Util.lineBreakPattern);
-    getEmptyLines(lines).forEach((line) => {
-        map.set(line, {});
     });
 
     return map;
@@ -91,7 +90,7 @@ const findComment = (line, map) => {
     return findCommentAbove(line, map);
 };
 
-module.exports = (metadata, parserOptions) => {
+module.exports = (metadata) => {
     const location = metadata.location;
     if (!location) {
         return;
@@ -104,7 +103,7 @@ module.exports = (metadata, parserOptions) => {
 
     let map = cacheMap.get(location.file);
     if (!map) {
-        map = getFileComments(location.file, parserOptions);
+        map = getFileComments(location.file);
         // cache file info
         cacheMap.set(location.file, map);
     }

package/lib/visitor.js

@@ -104,21 +104,20 @@ class Visitor {
     // data.type is step, metadata is TestStep, https://playwright.dev/docs/api/class-teststep
     async customVisitorsHandler(data, metadata) {
 
-        const collect = {
-            comments: (parserOptions) => {
-                return commentsPlugin(metadata, parserOptions);
-            }
-        };
+        if (this.options.customFieldsInComments) {
+            const customData = commentsPlugin(metadata);
+            Object.assign(data, customData);
+        }
 
         // for all data
         if (this.customCommonVisitor) {
-            await this.customCommonVisitor.call(this, data, metadata, collect);
+            await this.customCommonVisitor.call(this, data, metadata);
         }
 
         // for single column data (high priority)
         if (this.customVisitors) {
             for (const item of this.customVisitors) {
-                const res = await item.visitor.call(this, data, metadata, collect);
+                const res = await item.visitor.call(this, data, metadata);
                 if (typeof res !== 'undefined') {
                     data[item.id] = res;
                 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "monocart-reporter",
-    "version": "2.1.0",
+    "version": "2.2.0",
     "description": "A playwright test reporter. Shows suites/cases/steps with tree style, markdown annotations, custom columns/formatters/data collection visitors, console logs, style tags, send email.",
     "main": "lib/index.js",
     "bin": {
@@ -44,18 +44,18 @@
     "dependencies": {
         "console-grid": "~2.0.1",
         "eight-colors": "~1.0.3",
-        "istanbul-reports": "~3.1.6",
-        "koa": "~2.14.2",
+        "koa": "~2.15.0",
         "koa-static-resolver": "~1.0.4",
         "lz-utils": "~2.0.1",
-        "monocart-coverage-reports": "~2.0.0",
-        "nodemailer": "~6.9.7",
-        "open": "~10.0.1",
+        "monocart-coverage-reports": "~2.0.9",
+        "monocart-formatter": "^2.2.1",
+        "nodemailer": "~6.9.8",
+        "open": "~10.0.2",
         "turbogrid": "^3.0.12"
     },
     "devDependencies": {
         "@playwright/test": "^1.40.1",
-        "axios": "^1.6.3",
+        "axios": "^1.6.5",
         "dotenv": "^16.3.1",
         "eslint": "^8.56.0",
         "eslint-config-plus": "^1.0.6",