monocart-reporter 2.9.6 → 2.9.7

package/lib/plugins/audit/audit.js

@@ -1,119 +1,119 @@
-const fs = require('fs');
-const path = require('path');
-const Util = require('../../utils/util.js');
-
-const getStatus = (s) => {
-    if (s < 0.5) {
-        return 'low';
-    }
-    if (s < 0.9) {
-        return 'medium';
-    }
-    return 'high';
-};
-
-const getSummaryReport = (lhr) => {
-    const summary = {};
-
-    const props = [
-        'lighthouseVersion',
-        'requestedUrl',
-        'fetchTime'
-    ];
-    props.forEach((k) => {
-        summary[k] = lhr[k];
-    });
-
-    const audits = lhr.audits;
-    const categories = lhr.categories;
-    const performanceAudits = [
-        'first-contentful-paint',
-        'largest-contentful-paint',
-        'total-blocking-time',
-        'cumulative-layout-shift',
-        'speed-index'
-    ];
-
-    summary.categories = Object.keys(categories).map((k) => {
-        const category = categories[k];
-        const item = {
-            name: category.title,
-            score: category.score,
-            status: getStatus(category.score),
-            value: '',
-            description: category.description || ''
-        };
-        if (k === 'performance') {
-            item.metrics = performanceAudits.map((id) => {
-                const it = audits[id];
-                return {
-                    name: it.title,
-                    score: it.score,
-                    status: getStatus(it.score),
-                    value: it.displayValue,
-                    description: it.description || ''
-                };
-            });
-        }
-
-        return item;
-    });
-
-    return summary;
-};
-
-const attachAuditReport = async (runnerResult, testInfo, options = {}) => {
-
-    const logging = Util.resolveLogging(testInfo, options);
-    Util.initLoggingLevel(logging, 'audit');
-
-    if (!runnerResult || !runnerResult.lhr || !runnerResult.report) {
-        Util.logError('invalid lighthouse runner result');
-        return;
-    }
-
-    const outputDir = Util.resolveOutputDir(testInfo);
-
-    options = {
-        name: `Lighthouse Report - ${testInfo.title}`,
-        outputDir,
-        outputName: `audit-${Util.resolveTestIdWithRetry(testInfo)}`,
-        ... options
-    };
-
-    const htmlDir = path.resolve(options.outputDir, options.outputName);
-    if (!fs.existsSync(htmlDir)) {
-        fs.mkdirSync(htmlDir, {
-            recursive: true
-        });
-    }
-    options.htmlDir = htmlDir;
-
-    // `.lhr` is the Lighthouse Result as a JS object
-    const report = {
-        name: options.name,
-        ... getSummaryReport(runnerResult.lhr)
-    };
-
-    const htmlPath = path.resolve(htmlDir, 'index.html');
-    // `.report` is the HTML report as a string
-    await Util.writeFile(htmlPath, runnerResult.report);
-
-    const definition = Util.attachments.audit;
-
-    const reportPath = path.resolve(htmlDir, definition.reportFile);
-    Util.writeJSONSync(reportPath, report);
-
-    testInfo.attachments.push({
-        name: definition.name,
-        contentType: definition.contentType,
-        path: path.resolve(htmlDir, 'index.html')
-    });
-
-    return report;
-};
-
-
-module.exports = {
-    attachAuditReport
-};
+const fs = require('fs');
+const path = require('path');
+const Util = require('../../utils/util.js');
+
+const getStatus = (s) => {
+    if (s < 0.5) {
+        return 'low';
+    }
+    if (s < 0.9) {
+        return 'medium';
+    }
+    return 'high';
+};
+
+const getSummaryReport = (lhr) => {
+    const summary = {};
+
+    const props = [
+        'lighthouseVersion',
+        'requestedUrl',
+        'fetchTime'
+    ];
+    props.forEach((k) => {
+        summary[k] = lhr[k];
+    });
+
+    const audits = lhr.audits;
+    const categories = lhr.categories;
+    const performanceAudits = [
+        'first-contentful-paint',
+        'largest-contentful-paint',
+        'total-blocking-time',
+        'cumulative-layout-shift',
+        'speed-index'
+    ];
+
+    summary.categories = Object.keys(categories).map((k) => {
+        const category = categories[k];
+        const item = {
+            name: category.title,
+            score: category.score,
+            status: getStatus(category.score),
+            value: '',
+            description: category.description || ''
+        };
+        if (k === 'performance') {
+            item.metrics = performanceAudits.map((id) => {
+                const it = audits[id];
+                return {
+                    name: it.title,
+                    score: it.score,
+                    status: getStatus(it.score),
+                    value: it.displayValue,
+                    description: it.description || ''
+                };
+            });
+        }
+
+        return item;
+    });
+
+    return summary;
+};
+
+const attachAuditReport = async (runnerResult, testInfo, options = {}) => {
+
+    const logging = Util.resolveLogging(testInfo, options);
+    Util.initLoggingLevel(logging, 'audit');
+
+    if (!runnerResult || !runnerResult.lhr || !runnerResult.report) {
+        Util.logError('invalid lighthouse runner result');
+        return;
+    }
+
+    const outputDir = Util.resolveOutputDir(testInfo);
+
+    options = {
+        name: `Lighthouse Report - ${testInfo.title}`,
+        outputDir,
+        outputName: `audit-${Util.resolveTestIdWithRetry(testInfo)}`,
+        ... options
+    };
+
+    const htmlDir = path.resolve(options.outputDir, options.outputName);
+    if (!fs.existsSync(htmlDir)) {
+        fs.mkdirSync(htmlDir, {
+            recursive: true
+        });
+    }
+    options.htmlDir = htmlDir;
+
+    // `.lhr` is the Lighthouse Result as a JS object
+    const report = {
+        name: options.name,
+        ... getSummaryReport(runnerResult.lhr)
+    };
+
+    const htmlPath = path.resolve(htmlDir, 'index.html');
+    // `.report` is the HTML report as a string
+    await Util.writeFile(htmlPath, runnerResult.report);
+
+    const definition = Util.attachments.audit;
+
+    const reportPath = path.resolve(htmlDir, definition.reportFile);
+    Util.writeJSONSync(reportPath, report);
+
+    testInfo.attachments.push({
+        name: definition.name,
+        contentType: definition.contentType,
+        path: path.resolve(htmlDir, 'index.html')
+    });
+
+    return report;
+};
+
+
+module.exports = {
+    attachAuditReport
+};

package/lib/plugins/comments.js

@@ -1,124 +1,124 @@
-const fs = require('fs');
-const Util = require('../utils/util.js');
-const { Locator } = require('monocart-locator');
-
-const cacheMap = new Map();
-
-const getFileComments = (sourcePath) => {
-
-    const map = new Map();
-
-    if (!fs.existsSync(sourcePath)) {
-        return map;
-    }
-
-    // console.log('babel parse file: ', sourcePath);
-
-    const source = fs.readFileSync(sourcePath).toString('utf-8');
-
-    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, {});
-        }
-    });
-
-    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;
-        }
-
-        // first line comments for file line 0
-        const sLoc = locator.offsetToLocation(start);
-        if (sLoc.line === 1) {
-            map.set(1, {
-                value: text
-            });
-        }
-
-    });
-
-    return map;
-};
-
-const findCommentAbove = (line, map) => {
-    if (line <= 1) {
-        return;
-    }
-    const lineAbove = line - 1;
-    const comment = map.get(lineAbove);
-    if (!comment) {
-        return;
-    }
-
-    // found
-    if (comment.value) {
-        return comment;
-    }
-
-    // empty line, continue above
-    return findCommentAbove(lineAbove, map);
-
-};
-
-const findComment = (line, map) => {
-    if (line <= 1) {
-        // first line comments for file line 0
-        const comment = map.get(1);
-        if (comment && comment.value) {
-            return comment;
-        }
-        return;
-    }
-    return findCommentAbove(line, map);
-};
-
-module.exports = (metadata) => {
-    const location = metadata.location;
-    if (!location) {
-        return;
-    }
-
-    // location {}
-    // file: 'H:\\workspace\\monocart-reporter\\tests\\home-page\\home-page.spec.js',
-    // line: 13,
-    // column: 6
-
-    let map = cacheMap.get(location.file);
-    if (!map) {
-        map = getFileComments(location.file);
-        // cache file info
-        cacheMap.set(location.file, map);
-    }
-
-    // location line above
-    const comment = findComment(location.line, map);
-    if (!comment) {
-        return;
-    }
-
-    let parsedValue = comment.parsedValue;
-    if (!parsedValue) {
-        parsedValue = Util.parseComments(comment.value);
-        comment.parsedValue = parsedValue;
-    }
-
-    return parsedValue;
-};
+const fs = require('fs');
+const Util = require('../utils/util.js');
+const { Locator } = require('monocart-locator');
+
+const cacheMap = new Map();
+
+const getFileComments = (sourcePath) => {
+
+    const map = new Map();
+
+    if (!fs.existsSync(sourcePath)) {
+        return map;
+    }
+
+    // console.log('babel parse file: ', sourcePath);
+
+    const source = fs.readFileSync(sourcePath).toString('utf-8');
+
+    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, {});
+        }
+    });
+
+    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;
+        }
+
+        // first line comments for file line 0
+        const sLoc = locator.offsetToLocation(start);
+        if (sLoc.line === 1) {
+            map.set(1, {
+                value: text
+            });
+        }
+
+    });
+
+    return map;
+};
+
+const findCommentAbove = (line, map) => {
+    if (line <= 1) {
+        return;
+    }
+    const lineAbove = line - 1;
+    const comment = map.get(lineAbove);
+    if (!comment) {
+        return;
+    }
+
+    // found
+    if (comment.value) {
+        return comment;
+    }
+
+    // empty line, continue above
+    return findCommentAbove(lineAbove, map);
+
+};
+
+const findComment = (line, map) => {
+    if (line <= 1) {
+        // first line comments for file line 0
+        const comment = map.get(1);
+        if (comment && comment.value) {
+            return comment;
+        }
+        return;
+    }
+    return findCommentAbove(line, map);
+};
+
+module.exports = (metadata) => {
+    const location = metadata.location;
+    if (!location) {
+        return;
+    }
+
+    // location {}
+    // file: 'H:\\workspace\\monocart-reporter\\tests\\home-page\\home-page.spec.js',
+    // line: 13,
+    // column: 6
+
+    let map = cacheMap.get(location.file);
+    if (!map) {
+        map = getFileComments(location.file);
+        // cache file info
+        cacheMap.set(location.file, map);
+    }
+
+    // location line above
+    const comment = findComment(location.line, map);
+    if (!comment) {
+        return;
+    }
+
+    let parsedValue = comment.parsedValue;
+    if (!parsedValue) {
+        parsedValue = Util.parseComments(comment.value);
+        comment.parsedValue = parsedValue;
+    }
+
+    return parsedValue;
+};