Blame view

node_modules/eslint/lib/formatters/html.js 4.08 KB
f7563de62   Palak Handa   first commit
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
  /**
   * @fileoverview HTML reporter
   * @author Julian Laval
   */
  "use strict";
  
  const lodash = require("lodash");
  const fs = require("fs");
  const path = require("path");
  
  //------------------------------------------------------------------------------
  // Helpers
  //------------------------------------------------------------------------------
  
  const pageTemplate = lodash.template(fs.readFileSync(path.join(__dirname, "html-template-page.html"), "utf-8"));
  const messageTemplate = lodash.template(fs.readFileSync(path.join(__dirname, "html-template-message.html"), "utf-8"));
  const resultTemplate = lodash.template(fs.readFileSync(path.join(__dirname, "html-template-result.html"), "utf-8"));
  
  /**
   * Given a word and a count, append an s if count is not one.
   * @param {string} word A word in its singular form.
   * @param {int} count A number controlling whether word should be pluralized.
   * @returns {string} The original word with an s on the end if count is not one.
   */
  function pluralize(word, count) {
      return (count === 1 ? word : `${word}s`);
  }
  
  /**
   * Renders text along the template of x problems (x errors, x warnings)
   * @param {string} totalErrors Total errors
   * @param {string} totalWarnings Total warnings
   * @returns {string} The formatted string, pluralized where necessary
   */
  function renderSummary(totalErrors, totalWarnings) {
      const totalProblems = totalErrors + totalWarnings;
      let renderedText = `${totalProblems} ${pluralize("problem", totalProblems)}`;
  
      if (totalProblems !== 0) {
          renderedText += ` (${totalErrors} ${pluralize("error", totalErrors)}, ${totalWarnings} ${pluralize("warning", totalWarnings)})`;
      }
      return renderedText;
  }
  
  /**
   * Get the color based on whether there are errors/warnings...
   * @param {string} totalErrors Total errors
   * @param {string} totalWarnings Total warnings
   * @returns {int} The color code (0 = green, 1 = yellow, 2 = red)
   */
  function renderColor(totalErrors, totalWarnings) {
      if (totalErrors !== 0) {
          return 2;
      } else if (totalWarnings !== 0) {
          return 1;
      }
      return 0;
  }
  
  /**
   * Get HTML (table rows) describing the messages.
   * @param {Array} messages Messages.
   * @param {int} parentIndex Index of the parent HTML row.
   * @returns {string} HTML (table rows) describing the messages.
   */
  function renderMessages(messages, parentIndex) {
  
      /**
       * Get HTML (table row) describing a message.
       * @param {Object} message Message.
       * @returns {string} HTML (table row) describing a message.
       */
      return lodash.map(messages, message => {
          const lineNumber = message.line || 0;
          const columnNumber = message.column || 0;
  
          return messageTemplate({
              parentIndex,
              lineNumber,
              columnNumber,
              severityNumber: message.severity,
              severityName: message.severity === 1 ? "Warning" : "Error",
              message: message.message,
              ruleId: message.ruleId
          });
      }).join("
  ");
  }
  
  /**
   * @param {Array} results Test results.
   * @returns {string} HTML string describing the results.
   */
  function renderResults(results) {
      return lodash.map(results, (result, index) => resultTemplate({
          index,
          color: renderColor(result.errorCount, result.warningCount),
          filePath: result.filePath,
          summary: renderSummary(result.errorCount, result.warningCount)
  
      }) + renderMessages(result.messages, index)).join("
  ");
  }
  
  //------------------------------------------------------------------------------
  // Public Interface
  //------------------------------------------------------------------------------
  
  module.exports = function(results) {
      let totalErrors,
          totalWarnings;
  
      totalErrors = 0;
      totalWarnings = 0;
  
      // Iterate over results to get totals
      results.forEach(result => {
          totalErrors += result.errorCount;
          totalWarnings += result.warningCount;
      });
  
      return pageTemplate({
          date: new Date(),
          reportColor: renderColor(totalErrors, totalWarnings),
          reportSummary: renderSummary(totalErrors, totalWarnings),
          results: renderResults(results)
      });
  };