.config/coc/extensions/node_modules/coc-prettier/node_modules/stylelint/docs/developer-guide/formatters.md

   1 # Writing formatters
   2
   3 A formatter is a function that accepts *an array of these stylelint result objects* and outputs a string:
   4
   5 ```js
   6 // A stylelint result object
   7 {
   8   source:  "path/to/file.css", // The filepath or PostCSS identifier like <input css 1>
   9   errored: true, // This is `true` if at least one rule with an "error"-level severity triggered a warning
  10   warnings: [ // Array of rule violation warning objects, each like the following ...
  11     {
  12       line: 3,
  13       column: 12,
  14       rule: "block-no-empty",
  15       severity: "error",
  16       text: "You should not have an empty block (block-no-empty)"
  17     },
  18     ..
  19   ],
  20   deprecations: [ // Array of deprecation warning objects, each like the following ...
  21     {
  22       text: "Feature X has been deprecated and will be removed in the next major version.",
  23       reference: "https://stylelint.io/docs/feature-x.md"
  24     }
  25   ],
  26   invalidOptionWarnings: [ // Array of invalid option warning objects, each like the following ...
  27     {
  28       text: "Invalid option X for rule Y",
  29     }
  30   ],
  31   ignored: false // This is `true` if the file's path matches a provided ignore pattern
  32 }
  33 ```
  34
  35 ## `stylelint.formatters`
  36
  37 stylelint's internal formatters are exposed publicly in `stylelint.formatters`.