ユーザー定義フォーマッターの記述

フォーマッターは次のシグネチャを持つ関数です

/**
 * @type {import('stylelint').Formatter}
 */
export default function formatter(results, returnValue) {
  return "a string of formatted results";
}

ここで、最初の引数 (results) は Stylelint の結果オブジェクト (型 Array<StylelintResult>) の配列で、次の形式を取ります

// 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 problem warning objects, each like the following ...
    {
      "line": 3,
      "column": 12,
      "endLine": 4,
      "endColumn": 15,
      "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.dokyumento.jp/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
}

2 番目の引数 (returnValue) はオブジェクト (型 LinterResult) で、次の 1 つ以上のキーを持ちます

{
  "errored": false, // `true` if there were any warnings with "error" severity
  "maxWarningsExceeded": {
    // Present if Stylelint was configured with a `maxWarnings` count
    "maxWarnings": 10,
    "foundWarnings": 15
  },
  "ruleMetadata": {
    "block-no-empty": {
      "url": "https://stylelint.dokyumento.jp/user-guide/rules/block-no-empty"
    },
    // other rules...
  }
}

引数の受け渡し

環境変数をフォーマッターで使用できます。たとえば、SKIP_WARNINGS を渡します

SKIP_WARNINGS=true stylelint "*.css" --custom-formatter ./my-formatter.js

または、別個のフォーマットプログラムを作成して、組み込みの JSON フォーマッターからの出力をパイプでそこに流すことができます

stylelint -f json "*.css" 2>&1 | my-program-that-reads-JSON --option

stylelint.formatters

Stylelint の内部フォーマッターは、stylelint.formatters で公開されています。