summaryrefslogtreecommitdiff
path: root/tools/node_modules/eslint/lib/formatters/tap.js
diff options
context:
space:
mode:
Diffstat (limited to 'tools/node_modules/eslint/lib/formatters/tap.js')
-rw-r--r--tools/node_modules/eslint/lib/formatters/tap.js92
1 files changed, 92 insertions, 0 deletions
diff --git a/tools/node_modules/eslint/lib/formatters/tap.js b/tools/node_modules/eslint/lib/formatters/tap.js
new file mode 100644
index 0000000000..9651a2bcf1
--- /dev/null
+++ b/tools/node_modules/eslint/lib/formatters/tap.js
@@ -0,0 +1,92 @@
+/**
+ * @fileoverview TAP reporter
+ * @author Jonathan Kingston
+ */
+"use strict";
+
+const yaml = require("js-yaml");
+
+//------------------------------------------------------------------------------
+// Helper Functions
+//------------------------------------------------------------------------------
+
+/**
+ * Returns a canonical error level string based upon the error message passed in.
+ * @param {Object} message Individual error message provided by eslint
+ * @returns {string} Error level string
+ */
+function getMessageType(message) {
+ if (message.fatal || message.severity === 2) {
+ return "error";
+ }
+ return "warning";
+
+}
+
+/**
+ * Takes in a JavaScript object and outputs a TAP diagnostics string
+ * @param {Object} diagnostic JavaScript object to be embedded as YAML into output.
+ * @returns {string} diagnostics string with YAML embedded - TAP version 13 compliant
+ */
+function outputDiagnostics(diagnostic) {
+ const prefix = " ";
+ let output = `${prefix}---\n`;
+
+ output += prefix + yaml.safeDump(diagnostic).split("\n").join(`\n${prefix}`);
+ output += "...\n";
+ return output;
+}
+
+//------------------------------------------------------------------------------
+// Public Interface
+//------------------------------------------------------------------------------
+
+module.exports = function(results) {
+ let output = `TAP version 13\n1..${results.length}\n`;
+
+ results.forEach((result, id) => {
+ const messages = result.messages;
+ let testResult = "ok";
+ let diagnostics = {};
+
+ if (messages.length > 0) {
+ testResult = "not ok";
+
+ messages.forEach(message => {
+ const diagnostic = {
+ message: message.message,
+ severity: getMessageType(message),
+ data: {
+ line: message.line || 0,
+ column: message.column || 0,
+ ruleId: message.ruleId || ""
+ }
+ };
+
+ /*
+ * If we have multiple messages place them under a messages key
+ * The first error will be logged as message key
+ * This is to adhere to TAP 13 loosely defined specification of having a message key
+ */
+ if ("message" in diagnostics) {
+ if (typeof diagnostics.messages === "undefined") {
+ diagnostics.messages = [];
+ }
+ diagnostics.messages.push(diagnostic);
+ } else {
+ diagnostics = diagnostic;
+ }
+ });
+ }
+
+ output += `${testResult} ${id + 1} - ${result.filePath}\n`;
+
+ // If we have an error include diagnostics
+ if (messages.length > 0) {
+ output += outputDiagnostics(diagnostics);
+ }
+
+ });
+
+ return output;
+};