出力形式

Oxlint は、リンティング結果を出力するための複数の形式をサポートしています。これらは、さまざまな CI システムや他のツールとの統合に利用できます。

CLI から Oxlint を実行する際、--format（または -f）オプションを使用して希望する形式を指定できます。

利用可能な形式

--format=default

指定がない場合のデフォルト出力形式です。

  x eslint(no-debugger): `debugger` ステートメントは許可されていません
    ╭─[test.js:5:1]
  4 │
  5 │ debugger;
    · ─────────
  6 │
    ╰────
  ヘルプ: `debugger` ステートメントを削除してください

警告は 0 件、エラーは 1 件発見されました。
1 ファイル、2 ルール、1 スレッドで 6 ミリ秒で完了しました。

--format=checkstyle

Checkstyle XML 形式の出力をします。一部の CI ツールがこの形式を読み取ることができます。

<?xml version="1.0" encoding="utf-8"?>
<checkstyle version="4.3">
  <file name="test.js">
    <error line="5" column="1" severity="error" message="`debugger` statement is not allowed" source="eslint(no-debugger)" />
  </file>
</checkstyle>

--format=github

GitHub Actions および GitHub の アノテーション機能 と連携するために設計されています。

::error file=test.js,line=5,endLine=5,col=1,endColumn=10,title=eslint(no-debugger)::`debugger` statement is not allowed

--format=gitlab

GitLab CI および GitLab のコード品質機能 と連携するために設計されています。

[
  {
    "description": "`debugger` statement is not allowed",
    "check_name": "eslint(no-debugger)",
    "fingerprint": "9333a3278325994",
    "severity": "critical",
    "location": {
      "path": "test.js",
      "lines": {
        "begin": 5,
        "end": 5
      }
    }
  }
]

--format=json

汎用的な JSON 出力形式であり、--rules と組み合わせてすべての Oxlint ルールのリストを JSON 形式で取得することも可能です。

{
  "diagnostics": [
    {
      "message": "`debugger` statement is not allowed",
      "code": "eslint(no-debugger)",
      "severity": "error",
      "causes": [],
      "url": "https://oxc.rs/docs/guide/usage/linter/rules/eslint/no-debugger.html",
      "help": "Remove the debugger statement",
      "filename": "test.js",
      "labels": [
        {
          "span": {
            "offset": 38,
            "length": 9,
            "line": 5,
            "column": 1
          }
        }
      ],
      "related": []
    }
  ],
  "number_of_files": 1,
  "number_of_rules": 2,
  "threads_count": 1,
  "start_time": 0.018611917
}

--format=junit

JUnit XML 形式の出力をします。GitLab CI や Bitbucket Pipelines など、JUnit レポートをサポートする CI システムに有用です。

<?xml version="1.0" encoding="UTF-8"?>
<testsuites name="Oxlint" tests="1" failures="0" errors="1">
  <testsuite name="test.js" tests="1" disabled="0" errors="1" failures="0">
    <testcase name="eslint(no-debugger)">
      <error message="`debugger` statement is not allowed">line 5, column 1, `debugger` statement is not allowed</error>
    </testcase>
  </testsuite>
</testsuites>

--format=stylish

Stylish は ESLint のデフォルト出力形式であり、人間が読みやすいコンパクトな出力に適しています。

test.js
5:1   error `debugger` statement is not allowed  eslint(no-debugger)

✖ 1 problem (1 error, 0 warnings)

--format=unix

基本的な、1 行のみの形式です。

test.js:5:1: `debugger` statement is not allowed [Error/eslint(no-debugger)]

1 problem