accessibility-checker 3.1.0 → 3.1.4

package/lib/log/ACMetricsLogger.js

@@ -1,3 +1,4 @@
+"use strict";
 /******************************************************************************
     Copyright:: 2020- IBM, Inc
 
@@ -13,16 +14,15 @@
     See the License for the specific language governing permissions and
     limitations under the License.
  *****************************************************************************/
-
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ACMetricsLogger = void 0;
 /*******************************************************************************
  * NAME: ACMetricsLogger.js
  * DESCRIPTION: Common Metrics logger object which can be shared between tools
  *              to upload metrics of the tool to the metrics server.
  *******************************************************************************/
-
 // Load required modules
-var request = require('request');
-
+var request = require("request");
 /**
  * This function is responsible for constructing the accessibility-checker Metrics object which contains all the function
  * that are needed to upload scan metrics to the metric server.
@@ -35,31 +35,17 @@ var request = require('request');
  *
  * @memberOf this
  */
-var ACMetricsLogger = function (toolName, logger, policies) {
-
-    // Variable Decleration
-    this.metricsURLV2 = "https://able.ibm.com/tools";
-
-    // accessibility-checker Metrics Logger
-    this.log = logger;
-
-    // Init all the local object variables
-    this.toolName = toolName;
-
-    // Contains the time it took for a scan for the V1 metric server
-    this.scanTimesV1 = [];
-
-    // Contains the scan times indexed by profile for V2 metric server
-    this.scanTimesV2 = {};
-
-    // Additional details to upload to the metrics server
-    this.policies = policies;
-
-    // In the case that policies provided is an array convert it to a comma seperated list
-    if (this.policies instanceof Array) {
-        this.policies = this.policies.join(",");
+var ACMetricsLogger = /** @class */ (function () {
+    function ACMetricsLogger(toolName, logger, policies) {
+        this.metricsURLV2 = "https://able.ibm.com/tools";
+        this.scanTimesV1 = [];
+        this.scanTimesV2 = {};
+        this.policies = policies.join(",");
+        // accessibility-checker Metrics Logger
+        this.log = logger;
+        // Init all the local object variables
+        this.toolName = toolName;
     }
-
     /**
      * This function is responsible for profiling the testcases and adding the scan time to the global
      * array which will be sent to the metrics server to log the number of scans that were performed.
@@ -76,19 +62,16 @@ var ACMetricsLogger = function (toolName, logger, policies) {
      *
      * @memberOf this
      */
-    this.profileV2 = function (scanTime, profile) {
+    ACMetricsLogger.prototype.profileV2 = function (scanTime, profile) {
         this.log.debug("START 'profileV2' function");
-
         // URI encode the profile text provided
         profile = encodeURIComponent(profile);
-
         // Add the time it took for the testcase to run to the global array, indexed by the profile
         this.scanTimesV2[profile] = this.scanTimesV2[profile] || [];
         this.scanTimesV2[profile].push(scanTime);
-
         this.log.debug("END 'profileV2' function");
     };
-
+    ;
     /**
      * This function is responsible for uploading scan results to the metrics server:
      * https://aat.w3ibm.mybluemix.net
@@ -99,66 +82,55 @@ var ACMetricsLogger = function (toolName, logger, policies) {
      *
      * @memberOf this
      */
-    this.sendLogsV2 = function (done, rulePack) {
+    ACMetricsLogger.prototype.sendLogsV2 = function (done, rulePack) {
         this.log.debug("START 'sendLogsV2' function");
-
         // Copy this.log into loggerInScope so that it can be used in callback function
         var loggerInScope = this.log;
-
         try {
             // Variable Decleration
-            var numProfiles = 0;
+            var numProfiles_1 = 0;
             var accountId = "";
-
-            // Reset the timeout to 0
-            if (this.timeout) {
-                this.timeout(0);
-            }
-
             // Loop over all the profiles with in the scanTime Object
             for (var profile in this.scanTimesV2) {
-
-                // Loop over all the V2 Scan Times until it reaches 0
-                while (this.scanTimesV2[profile].length > 0) {
+                var _loop_1 = function () {
                     // Build a truncatedScanTime Array to upload to the metrics server chunck by chunck
-                    var subScanTimes = this.scanTimesV2[profile].splice(0, 150);
-
+                    var subScanTimes = this_1.scanTimesV2[profile].splice(0, 150);
                     // Increment the num Profile
-                    ++numProfiles;
-
+                    ++numProfiles_1;
                     // Start building the Query string to be sent to the metrics server
-                    var qs = "?t=" + this.toolName + "&tag=" + profile + "&a=" + accountId + "&pol=" + this.policies + "&st=";
-
+                    var qs = "?t=" + this_1.toolName + "&tag=" + profile + "&a=" + accountId + "&pol=" + this_1.policies + "&st=";
                     subScanTimes.forEach(function (t) {
                         qs += t;
                         qs += ",";
                     });
                     qs = qs.substr(0, qs.length - 1);
-
-                    this.log.debug("Uploading: " + this.metricsURLV2 + "/api/pub/meter/v2" + qs);
-
+                    this_1.log.debug("Uploading: " + this_1.metricsURLV2 + "/api/pub/meter/v2" + qs);
                     // Dispatch the call to the metrics server
                     // Istanbul is not able to capture the coverate of functions call in a callback therefore we need to skip
                     /* istanbul ignore next */
-                    request.get(this.metricsURLV2 + "/api/pub/meter/v2" + qs, function () {
+                    request.get(this_1.metricsURLV2 + "/api/pub/meter/v2" + qs, function () {
                         // Decrement the numProfiles to identify that scan has finished
-                        --numProfiles;
-
+                        --numProfiles_1;
                         // Once all metrics for all profiles have been uploaded we end this function call
-                        if (numProfiles === 0) {
+                        if (numProfiles_1 === 0) {
                             loggerInScope.debug("END 'sendLogsV2' function");
                             done && done();
                         }
                     });
+                };
+                var this_1 = this;
+                // Loop over all the V2 Scan Times until it reaches 0
+                while (this.scanTimesV2[profile].length > 0) {
+                    _loop_1();
                 }
             }
-
             // Once all metrics for all profiles have been uploaded we end this function call
-            if (numProfiles === 0) {
+            if (numProfiles_1 === 0) {
                 this.log.debug("END 'sendLogsV2' function");
                 done && done();
             }
-        } catch (e) {
+        }
+        catch (e) {
             /* istanbul ignore next */
             this.log.debug("Error uploading metrics logs: " + e);
             /* istanbul ignore next */
@@ -167,7 +139,9 @@ var ACMetricsLogger = function (toolName, logger, policies) {
             done && done();
         }
     };
-};
-
-// Export this function, which can be used to create a new metrics logger object
-module.exports = ACMetricsLogger;
+    ;
+    return ACMetricsLogger;
+}());
+exports.ACMetricsLogger = ACMetricsLogger;
+;
+//# sourceMappingURL=ACMetricsLogger.js.map

package/lib/log/ACMetricsLogger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ACMetricsLogger.js","sourceRoot":"","sources":["../../../src-ts/lib/log/ACMetricsLogger.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;+EAc+E;;;AAE/E;;;;iFAIiF;AAEjF,wBAAwB;AACxB,iCAAmC;AAGnC;;;;;;;;;;;GAWG;AACH;IAUI,yBAAY,QAAgB,EAAE,MAAe,EAAE,QAAkB;QARjE,iBAAY,GAAW,4BAA4B,CAAC;QAGpD,gBAAW,GAAG,EAAE,CAAC;QACjB,gBAAW,GAEP,EAAE,CAAC;QAGH,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAEnC,uCAAuC;QACvC,IAAI,CAAC,GAAG,GAAG,MAAM,CAAC;QAElB,sCAAsC;QACtC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC7B,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,mCAAS,GAAT,UAAU,QAAgB,EAAE,OAAe;QACvC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAE7C,uCAAuC;QACvC,OAAO,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;QAEtC,2FAA2F;QAC3F,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QAC5D,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEzC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC;IAC/C,CAAC;IAAA,CAAC;IAEF;;;;;;;;;OASG;IACH,oCAAU,GAAV,UAAW,IAAI,EAAE,QAAQ;QACrB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC;QAE9C,+EAA+E;QAC/E,IAAI,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC;QAE7B,IAAI;YACA,uBAAuB;YACvB,IAAI,aAAW,GAAG,CAAC,CAAC;YACpB,IAAI,SAAS,GAAG,EAAE,CAAC;YAEnB,yDAAyD;YACzD,KAAK,IAAI,OAAO,IAAI,IAAI,CAAC,WAAW,EAAE;;oBAI9B,mFAAmF;oBACnF,IAAI,YAAY,GAAG,OAAK,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;oBAE5D,4BAA4B;oBAC5B,EAAE,aAAW,CAAC;oBAEd,mEAAmE;oBACnE,IAAI,EAAE,GAAG,KAAK,GAAG,OAAK,QAAQ,GAAG,OAAO,GAAG,OAAO,GAAG,KAAK,GAAG,SAAS,GAAG,OAAO,GAAG,OAAK,QAAQ,GAAG,MAAM,CAAC;oBAE1G,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC;wBAC5B,EAAE,IAAI,CAAC,CAAC;wBACR,EAAE,IAAI,GAAG,CAAC;oBACd,CAAC,CAAC,CAAC;oBACH,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;oBAEjC,OAAK,GAAG,CAAC,KAAK,CAAC,aAAa,GAAG,OAAK,YAAY,GAAG,mBAAmB,GAAG,EAAE,CAAC,CAAC;oBAE7E,0CAA0C;oBAC1C,yGAAyG;oBACzG,0BAA0B;oBAC1B,OAAO,CAAC,GAAG,CAAC,OAAK,YAAY,GAAG,mBAAmB,GAAG,EAAE,EAAE;wBACtD,+DAA+D;wBAC/D,EAAE,aAAW,CAAC;wBAEd,iFAAiF;wBACjF,IAAI,aAAW,KAAK,CAAC,EAAE;4BACnB,aAAa,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;4BACjD,IAAI,IAAI,IAAI,EAAE,CAAC;yBAClB;oBACL,CAAC,CAAC,CAAC;;;gBA/BP,qDAAqD;gBACrD,OAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC;;iBA+B1C;aACJ;YAED,iFAAiF;YACjF,IAAI,aAAW,KAAK,CAAC,EAAE;gBACnB,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;gBAC5C,IAAI,IAAI,IAAI,EAAE,CAAC;aAClB;SACJ;QAAC,OAAO,CAAC,EAAE;YACR,0BAA0B;YAC1B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,gCAAgC,GAAG,CAAC,CAAC,CAAC;YACrD,0BAA0B;YAC1B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC;YAC5C,0BAA0B;YAC1B,IAAI,IAAI,IAAI,EAAE,CAAC;SAClB;IACL,CAAC;IAAA,CAAC;IACN,sBAAC;AAAD,CAAC,AA1HD,IA0HC;AA1HY,0CAAe;AA0H3B,CAAC"}

package/lib/reporters/ACReporterCSV.d.ts

@@ -0,0 +1,103 @@
+/******************************************************************************
+     Copyright:: 2020- IBM, Inc
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+  *****************************************************************************/
+import { IConfigUnsupported } from "../api/IChecker";
+import { IScanSummary } from "./ReportUtil";
+/**
+ * This function is responsible for constructing the aChecker Reporter which will be used to, report
+ * the scan results, such as writing the page results and the summary to a JSON file. This reporter function
+ * is registered with Karma server and triggered based on events that are triggered by the karma communication.
+ *
+ * @param {Object} baseReporterDecorator - the base karma reporter, which had the base functions which we override
+ * @param {Object} this.Config - All the Karma this.Configuration, we will extract what we need from this over
+ *                          all object, we need the entire object so that we detect any changes in the object
+ *                          as other plugins are loaded and the object is updated dynamically.
+ * @param {Object} logger - logger object which is used to log debug/error/info messages
+ * @param {Object} emitter - emitter object which allows to listem on any event that is triggered and allow to execute
+ *                           custom code, to handle the event that was triggered.
+ *
+ * @return - N/A
+ *
+ * @memberOf this
+ */
+export declare class ACReporterCSV {
+    resultStr: string;
+    Config: IConfigUnsupported;
+    constructor(config: IConfigUnsupported, scanSummary: IScanSummary);
+    report(info: any): void;
+    /**
+     * This function is responsible for performing any action when the entire karma run is done.
+     * Overrides onRunComplete function from baseReporterDecorator
+     *
+     * @override
+     *
+     * @memberOf this
+     */
+    onRunComplete(): void;
+    /**
+     * This function is responsible for saving a single scans results to a file as JSON. On a side note
+     * this function will also extract the label which will be the file names where the results will be
+     * saved.
+     *
+     * @param {Object} this.Config - Karma this.Config object, used to extrat the outputFolder from the ACthis.Config.
+     * @param {Object} results - Provide the scan results for a single page that should be saved.
+     *
+     * @memberOf this
+     */
+    savePageResults(report: any): void;
+    /**
+     * This function is responsible for converting a javascript object into JSON and then writing that to a
+     * json file.
+     *
+     * @param {String} fileName - Full path of file where the JSON object should be stored
+     * @param {String} content - The javascript object which should be converted and saved to file as JSON.
+     *
+     * @memberOf this
+     */
+    writeObjectToFile(fileName: any, content: any): void;
+    /**
+     * This function is responsible for saving the summary object of the while scan to a summary file.
+     *
+     * @param {Object} summary - The summary object that needs to be written to the summary file.
+     *
+     * @memberOf this
+     */
+    saveSummary(): void;
+    /**
+     * This function is responsible for indexing the results into global spaces based on label.
+     *
+     * @param {Object} results - Results object which will be provided to the user/wroten to the file.
+     *                           Refer to aChecker.buildReport function's return to figure out what the object
+     *                           will look like.
+     *
+     * @return - N/A - Global object is updated with the results
+     *
+     * @memberOf this
+     */
+    addResultsToGlobal(results: any): void;
+    /**
+     * This function is responsible for updating/creating the global violation summary for the engine karma run
+     * for browser that it is running on. Will take the pageCount object which is part of the page object and
+     * add extract the values for each of the levels and add them to the global object. This will provide an overall
+     * summary of violations for all testcases run and all scans done.
+     *
+     * @param {Object} pageCount - Provide the page count object, in the following format:
+     *
+     * @return N/A - Global summary object is updated with the counts
+     *
+     * @memberOf this
+     */
+    addToSummaryCount(pageCount: any): void;
+}

package/lib/reporters/ACReporterCSV.js

@@ -1,3 +1,4 @@
+"use strict";
 /******************************************************************************
      Copyright:: 2020- IBM, Inc
 
@@ -13,24 +14,31 @@
     See the License for the specific language governing permissions and
     limitations under the License.
   *****************************************************************************/
- 
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ACReporterCSV = void 0;
 // Load all the modules that are needed
-var pathLib = require('path');
-var fs = require('fs');
-const path = require("path");
-// Variable Declearation
-var log;
-
-// Global aChecker Summary Holder
-var scanSummary = {};
-
+var pathLib = require("path");
+var fs = require("fs");
+var ACEngineManager_1 = require("../ACEngineManager");
+var toCSV = function (str) {
+    if (str === null) {
+        return '"null"';
+    }
+    else if (str.length == 0) {
+        return '""';
+    }
+    else {
+        str = str.replace(/"/g, '""');
+        return "\"" + str + "\"";
+    }
+};
 /**
  * This function is responsible for constructing the aChecker Reporter which will be used to, report
  * the scan results, such as writing the page results and the summary to a JSON file. This reporter function
  * is registered with Karma server and triggered based on events that are triggered by the karma communication.
  *
  * @param {Object} baseReporterDecorator - the base karma reporter, which had the base functions which we override
- * @param {Object} config - All the Karma configuration, we will extract what we need from this over
+ * @param {Object} this.Config - All the Karma this.Configuration, we will extract what we need from this over
  *                          all object, we need the entire object so that we detect any changes in the object
  *                          as other plugins are loaded and the object is updated dynamically.
  * @param {Object} logger - logger object which is used to log debug/error/info messages
@@ -41,29 +49,38 @@ var scanSummary = {};
  *
  * @memberOf this
  */
-var ACReporter = function (aChecker) {
-    let Config = aChecker.Config;
-    Config.DEBUG && console.log("START ACReporter Constructor");
-    // Override adapters
-    this.adapters = [];
-
+var ACReporterCSV = /** @class */ (function () {
+    function ACReporterCSV(config, scanSummary) {
+        this.resultStr = "Label,Level,RuleId,Message,Xpath,Help\n";
+        this.Config = config;
+        this.Config.DEBUG && console.log("START ACReporter Constructor");
+        var myThis = this;
+        if (typeof (after) !== "undefined") {
+            after(function (done) {
+                myThis.onRunComplete();
+                done && done();
+            });
+        }
+        else {
+            process.on('beforeExit', function () {
+                myThis.onRunComplete();
+            });
+        }
+        this.Config.DEBUG && console.log("END ACReporter Constructor");
+    }
     // This emitter function is responsible for calling this function when the info event is detected
-    this.report = function(info) {
-        Config.DEBUG && console.log("START 'info' emitter function");
-
+    ACReporterCSV.prototype.report = function (info) {
+        this.Config.DEBUG && console.log("START 'info' emitter function");
         // Save the results of a single scan to a JSON file based on the label provided
-        savePageResults(info);
-
+        this.savePageResults(info);
         // Update the overall summary object count object to include the new scan that was performed
-        addToSummaryCount(info.summary.counts);
-
+        this.addToSummaryCount(info.summary.counts);
         // Save the summary of this scan into global space of this reporter, to be logged
         // once the whole scan is done.
-        addResultsToGlobal(info);
-
-        Config.DEBUG && console.log("END 'info' emitter function");
+        this.addResultsToGlobal(info);
+        this.Config.DEBUG && console.log("END 'info' emitter function");
     };
-
+    ;
     /**
      * This function is responsible for performing any action when the entire karma run is done.
      * Overrides onRunComplete function from baseReporterDecorator
@@ -72,49 +89,31 @@ var ACReporter = function (aChecker) {
      *
      * @memberOf this
      */
-    this.onRunComplete = function () {
-        Config.DEBUG && console.log("START 'ACReporterCSV::onRunComplete' function");
-
-        // Add End time when the whole karma run is done
-        // End time will be in milliseconds elapsed since 1 January 1970 00:00:00 UTC up until now.
-        scanSummary.endReport = Date.now();
-
+    ACReporterCSV.prototype.onRunComplete = function () {
+        this.Config.DEBUG && console.log("START 'ACReporterCSV::onRunComplete' function");
         // Save summary object to a JSON file.
-        saveSummary(scanSummary);
-
-        Config.DEBUG && console.log("END 'ACReporterCSV::onRunComplete' function");
+        this.saveSummary();
+        this.Config.DEBUG && console.log("END 'ACReporterCSV::onRunComplete' function");
     };
-
-    var toCSV = function(str) {
-		if (str === null) {
-			return '"null"';
-		} else if (str.length == 0) {
-			return '""';
-		} else {
-			str = str.replace(/"/g, '""');
-			return `"${str}"`;
-		}
-	}
+    ;
     /**
      * This function is responsible for saving a single scans results to a file as JSON. On a side note
      * this function will also extract the label which will be the file names where the results will be
      * saved.
      *
-     * @param {Object} config - Karma config object, used to extrat the outputFolder from the ACConfig.
+     * @param {Object} this.Config - Karma this.Config object, used to extrat the outputFolder from the ACthis.Config.
      * @param {Object} results - Provide the scan results for a single page that should be saved.
      *
      * @memberOf this
      */
-    var savePageResults = function (report) {
-        Config.DEBUG && console.log("START 'savePageResults' function");
-
-        for (const result of report.results) {
-            this.resultStr += `${toCSV(report.label)},${toCSV(result.level)},${toCSV(result.ruleId)},${toCSV(result.message)},${toCSV(result.path.dom)},${toCSV(aChecker.getHelpURL(result.ruleId))}\n`
+    ACReporterCSV.prototype.savePageResults = function (report) {
+        this.Config.DEBUG && console.log("START 'savePageResults' function");
+        for (var _i = 0, _a = report.results; _i < _a.length; _i++) {
+            var result = _a[_i];
+            this.resultStr += toCSV(report.label) + "," + toCSV(result.level) + "," + toCSV(result.ruleId) + "," + toCSV(result.message) + "," + toCSV(result.path.dom) + "," + toCSV(ACEngineManager_1.ACEngineManager.getHelpURL(result.ruleId)) + "\n";
         }
-
-        Config.DEBUG && console.log("END 'savePageResults' function");
-    }
-
+        this.Config.DEBUG && console.log("END 'savePageResults' function");
+    };
     /**
      * This function is responsible for converting a javascript object into JSON and then writing that to a
      * json file.
@@ -124,76 +123,25 @@ var ACReporter = function (aChecker) {
      *
      * @memberOf this
      */
-    var writeObjectToFile = function (fileName, content) {
-        Config.DEBUG && console.log("START 'writeObjectToFileAsCSV' function");
-        fileName = path.join(aChecker.Config.outputFolder, fileName);
+    ACReporterCSV.prototype.writeObjectToFile = function (fileName, content) {
+        this.Config.DEBUG && console.log("START 'writeObjectToFileAsCSV' function");
+        fileName = pathLib.join(this.Config.outputFolder, fileName);
         // Extract the parent directory of the file name that is provided
         var parentDir = pathLib.dirname(fileName);
-
-        Config.DEBUG && console.log("Parent Directoy: \"" + parentDir + "\"");
-
+        this.Config.DEBUG && console.log("Parent Directoy: \"" + parentDir + "\"");
         // In the case that the parent directoy does not exist, create the directories
         if (!fs.existsSync(parentDir)) {
-
             // Create the parent directory recerseivly if it does not exist.
-            fs.mkdirSync(parentDir, { recursive: true});
+            fs.mkdirSync(parentDir, { recursive: true });
         }
-
-        Config.DEBUG && console.log("Object will be written to file: \"" + fileName + "\"");
-
+        this.Config.DEBUG && console.log("Object will be written to file: \"" + fileName + "\"");
         // Convert the Object into JSON string and write that to the file
         // Make sure to use utf-8 encoding to avoid an issues specify to OS.
         // In terms of the JSON string that is constructed use 4 spaces to format the JSON object, before
         // writing it to the file.
         fs.writeFileSync(fileName, content, { encoding: 'utf-8' });
-
-        Config.DEBUG && console.log("END 'writeObjectToFileAsCSV' function");
-    }
-
-    /**
-     * This function is responsible for initializing the summary object which will store all informations about the
-     * scans that will occurs while karma is still running and running compliance scans.
-     *
-     * @return {Object} scanSummary - return the built scan summary object, which will follow the following format:
-     * {
-     *     "scanID": "ef3aec68-f073-4f9c-b372-421ae00bd55d",
-     *     "counts": {
-     *         "violation": 0,
-     *         "potentialviolation": 0,
-     *         "recommendation": 0,
-     *         "potentialrecommendation": 0,
-     *         "manual": 0
-     *     },
-     *     "startReport": "2016-06-06T00:52:41.603Z",
-     *     "endReport": "",
-     *     "toolID": "karma-ibma-v1.0.0",
-     *     "policies": [
-     *         "CI162_5_2_DCP070116",
-     *         "CI162_5_2_DCP080115"
-     *     ],
-     *     "reportLevels": [
-     *         "violation",
-     *         "potentialviolation",
-     *         "recommendation",
-     *         "potentialrecommendation",
-     *         "manual"
-     *     ],
-     *     "labels": [
-     *         "Firefox",
-     *         "master",
-     *         "V12",
-     *         "Linux"
-     *     ],
-     *     "pageScanSummary": {}
-     * }
-     *
-     * @memberOf this
-     */
-    var initializeSummary = function (config) {
-        this.resultStr = `Label,Level,RuleId,Message,Xpath,Help\n`
-        return scanSummary;
-    }
-
+        this.Config.DEBUG && console.log("END 'writeObjectToFileAsCSV' function");
+    };
     /**
      * This function is responsible for saving the summary object of the while scan to a summary file.
      *
@@ -201,15 +149,14 @@ var ACReporter = function (aChecker) {
      *
      * @memberOf this
      */
-    var saveSummary = function (summary, done) {
-        if (Config.outputFormat.indexOf("csv") === -1) {
+    ACReporterCSV.prototype.saveSummary = function () {
+        if (this.Config.outputFormat.indexOf("csv") === -1) {
             return;
         }
-        Config.DEBUG && console.log("START 'saveSummary' function");
-        writeObjectToFile("results.csv", this.resultStr);
-        Config.DEBUG && console.log("END 'saveSummary' function");
-    }
-
+        this.Config.DEBUG && console.log("START 'saveSummary' function");
+        this.writeObjectToFile("results.csv", this.resultStr);
+        this.Config.DEBUG && console.log("END 'saveSummary' function");
+    };
     /**
      * This function is responsible for indexing the results into global spaces based on label.
      *
@@ -221,11 +168,10 @@ var ACReporter = function (aChecker) {
      *
      * @memberOf this
      */
-    var addResultsToGlobal = function (results) {
-        Config.DEBUG && console.log("START 'addResultsToGlobal' function");
-        Config.DEBUG && console.log("END 'addResultsToGlobal' function");
-    }
-
+    ACReporterCSV.prototype.addResultsToGlobal = function (results) {
+        this.Config.DEBUG && console.log("START 'addResultsToGlobal' function");
+        this.Config.DEBUG && console.log("END 'addResultsToGlobal' function");
+    };
     /**
      * This function is responsible for updating/creating the global violation summary for the engine karma run
      * for browser that it is running on. Will take the pageCount object which is part of the page object and
@@ -238,25 +184,10 @@ var ACReporter = function (aChecker) {
      *
      * @memberOf this
      */
-    var addToSummaryCount = function (pageCount) {
-
-    }
-
-    scanSummary = initializeSummary();
-
-    var myThis = this;
-    if (typeof(after) !== "undefined") {
-        after(function(done) {
-            myThis.onRunComplete();
-            done && done();
-        });
-    } else {
-        process.on('beforeExit', function() {
-            myThis.onRunComplete();
-        });
-    }
-    Config.DEBUG && console.log("END ACReporter Constructor");
-};
-
-// Export this function, which will be called when Karma loads the reporter
-module.exports = ACReporter;
+    ACReporterCSV.prototype.addToSummaryCount = function (pageCount) {
+    };
+    return ACReporterCSV;
+}());
+exports.ACReporterCSV = ACReporterCSV;
+;
+//# sourceMappingURL=ACReporterCSV.js.map

package/lib/reporters/ACReporterCSV.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ACReporterCSV.js","sourceRoot":"","sources":["../../../src-ts/lib/reporters/ACReporterCSV.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;gFAcgF;;;AAEhF,uCAAuC;AACvC,8BAAgC;AAChC,uBAAyB;AACzB,sDAAqD;AAMrD,IAAI,KAAK,GAAG,UAAS,GAAG;IACpB,IAAI,GAAG,KAAK,IAAI,EAAE;QACd,OAAO,QAAQ,CAAC;KACnB;SAAM,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,EAAE;QACxB,OAAO,IAAI,CAAC;KACf;SAAM;QACH,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC9B,OAAO,OAAI,GAAG,OAAG,CAAC;KACrB;AACL,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH;IAII,uBAAY,MAA0B,EAAE,WAAyB;QAHjE,cAAS,GAAW,yCAAyC,CAAC;QAI1D,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAC;QACjE,IAAI,MAAM,GAAG,IAAI,CAAC;QAClB,IAAI,OAAM,CAAC,KAAK,CAAC,KAAK,WAAW,EAAE;YAC/B,KAAK,CAAC,UAAS,IAAI;gBACf,MAAM,CAAC,aAAa,EAAE,CAAC;gBACvB,IAAI,IAAI,IAAI,EAAE,CAAC;YACnB,CAAC,CAAC,CAAC;SACN;aAAM;YACH,OAAO,CAAC,EAAE,CAAC,YAAY,EAAE;gBACrB,MAAM,CAAC,aAAa,EAAE,CAAC;YAC3B,CAAC,CAAC,CAAC;SACN;QACD,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;IACnE,CAAC;IAED,iGAAiG;IACjG,8BAAM,GAAN,UAAO,IAAI;QACP,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAC;QAElE,+EAA+E;QAC/E,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAE3B,4FAA4F;QAC5F,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAE5C,iFAAiF;QACjF,+BAA+B;QAC/B,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAE9B,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;IACpE,CAAC;IAAA,CAAC;IAEF;;;;;;;OAOG;IACH,qCAAa,GAAb;QACI,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,+CAA+C,CAAC,CAAC;QAElF,sCAAsC;QACtC,IAAI,CAAC,WAAW,EAAE,CAAC;QAEnB,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,6CAA6C,CAAC,CAAC;IACpF,CAAC;IAAA,CAAC;IAEF;;;;;;;;;OASG;IACH,uCAAe,GAAf,UAAgB,MAAM;QAClB,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,kCAAkC,CAAC,CAAC;QAErE,KAAqB,UAAc,EAAd,KAAA,MAAM,CAAC,OAAO,EAAd,cAAc,EAAd,IAAc,EAAE;YAAhC,IAAM,MAAM,SAAA;YACb,IAAI,CAAC,SAAS,IAAO,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,SAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,SAAI,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,SAAI,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,SAAI,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,SAAI,KAAK,CAAC,iCAAe,CAAC,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAI,CAAA;SACrM;QAED,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;OAQG;IACH,yCAAiB,GAAjB,UAAkB,QAAQ,EAAE,OAAO;QAC/B,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,yCAAyC,CAAC,CAAC;QAC5E,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;QAC5D,iEAAiE;QACjE,IAAI,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAE1C,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,qBAAqB,GAAG,SAAS,GAAG,IAAI,CAAC,CAAC;QAE3E,8EAA8E;QAC9E,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;YAE3B,gEAAgE;YAChE,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAC,CAAC,CAAC;SAC/C;QAED,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,oCAAoC,GAAG,QAAQ,GAAG,IAAI,CAAC,CAAC;QAEzF,iEAAiE;QACjE,oEAAoE;QACpE,iGAAiG;QACjG,0BAA0B;QAC1B,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;QAE3D,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,uCAAuC,CAAC,CAAC;IAC9E,CAAC;IAED;;;;;;OAMG;IACH,mCAAW,GAAX;QACI,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE;YAChD,OAAO;SACV;QACD,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAC;QACjE,IAAI,CAAC,iBAAiB,CAAC,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QACtD,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;;OAUG;IACH,0CAAkB,GAAlB,UAAmB,OAAO;QACtB,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,qCAAqC,CAAC,CAAC;QACxE,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,OAAO,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;OAWG;IACH,yCAAiB,GAAjB,UAAkB,SAAS;IAE3B,CAAC;IACL,oBAAC;AAAD,CAAC,AA7JD,IA6JC;AA7JY,sCAAa;AA6JzB,CAAC"}