This is a simple formatter based directly on the included formatter for Eslint HTML. The only difference is a fallback for the URL, hardcoded to the current Eslint docs URL.
Based on Julian Laval's work.
Author: Julian Laval and Aaron Huggins
Given a word and a count, append an s if count is not one.
Returns: string - The original word with an s on the end if count is not one.
| Param | Type | Description |
|---|---|---|
| word | string |
A word in its singular form. |
| count | int |
A number controlling whether word should be pluralized. |
Renders text along the template of x problems (x errors, x warnings)
Returns: string - The formatted string, pluralized where necessary
| Param | Type | Description |
|---|---|---|
| totalErrors | string |
Total errors |
| totalWarnings | string |
Total warnings |
Get the color based on whether there are errors/warnings...
Returns: int - The color code (0 = green, 1 = yellow, 2 = red)
| Param | Type | Description |
|---|---|---|
| totalErrors | string |
Total errors |
| totalWarnings | string |
Total warnings |
Get HTML (table rows) describing the messages.
Returns: string - HTML (table rows) describing the messages.
| Param | Type | Description |
|---|---|---|
| messages | Array |
Messages. |
| parentIndex | int |
Index of the parent HTML row. |
| rulesMeta | Object |
Dictionary containing metadata for each rule executed by the analysis. |
Returns: string - HTML string describing the results.
| Param | Type | Description |
|---|---|---|
| results | Array |
Test results. |
| rulesMeta | Object |
Dictionary containing metadata for each rule executed by the analysis. |
© 2019 Aaron Huggins <aaron@nuclearfamily.llc>. Documented by jsdoc-to-markdown.