A formatter is a function that accepts an array of these stylelint result objects and outputs a string:
// A stylelint result object { source: "path/to/file.css", // The filepath or PostCSS identifier like <input css 1> errored: true, // This is `true` if at least one rule with an "error"-level severity triggered a warning warnings: [ // Array of rule violation warning objects, each like the following ... { line: 3, column: 12, rule: "block-no-empty", severity: "error", text: "You should not have an empty block (block-no-empty)" }, .. ], deprecations: [ // Array of deprecation warning objects, each like the following ... { text: "Feature X has been deprecated and will be removed in the next major version.", reference: "https://stylelint.io/docs/feature-x.md" } ], invalidOptionWarnings: [ // Array of invalid option warning objects, each like the following ... { text: "Invalid option X for rule Y", } ], ignored: false // This is `true` if the file's path matches a provided ignore pattern }
stylelint.formatters
stylelint's internal formatters are exposed publicly in stylelint.formatters
.