formatters.json

[
  {
    "formatterName": "checkstyle",
    "description": "Formats errors as through they were Checkstyle output.",
    "descriptionDetails": "\nImitates the XMLLogger from Checkstyle 4.3. All failures have the 'warning' severity.",
    "sample": "\n<?xml version=\"1.0\" encoding=\"utf-8\"?>\n<checkstyle version=\"4.3\">\n    <file name=\"myFile.ts\">\n        <error line=\"1\" column=\"14\" severity=\"warning\" message=\"Missing semicolon\" source=\"failure.tslint.semicolon\" />\n    </file>\n</checkstyle>",
    "consumer": "machine"
  },
  {
    "formatterName": "codeFrame",
    "description": "Framed formatter which creates a frame of error code.",
    "descriptionDetails": "\nPrints syntax highlighted code in a frame with a pointer to where\nexactly lint error is happening.",
    "sample": "\nsrc/components/Payment.tsx\nParentheses are required around the parameters of an arrow function definition (arrow-parens)\n  21 |     public componentDidMount() {\n  22 |         this.input.focus();\n> 23 |         loadStripe().then(Stripe => Stripe.pay());\n     |                          ^\n  24 |     }\n  25 |\n  26 |     public render() {",
    "consumer": "human"
  },
  {
    "formatterName": "filesList",
    "description": "Lists files containing lint errors.",
    "sample": "directory/myFile.ts",
    "consumer": "machine"
  },
  {
    "formatterName": "json",
    "description": "Formats errors as simple JSON.",
    "sample": "\n[\n    {\n        \"endPosition\": {\n            \"character\": 13,\n            \"line\": 0,\n            \"position\": 13\n        },\n        \"failure\": \"Missing semicolon\",\n        \"fix\": {\n            \"innerRuleName\": \"semicolon\",\n            \"innerReplacements\": [\n                {\n                    \"innerStart\": 13,\n                    \"innerLength\": 0,\n                    \"innerText\": \";\"\n                }\n            ]\n        },\n        \"name\": \"myFile.ts\",\n        \"ruleName\": \"semicolon\",\n        \"startPosition\": {\n            \"character\": 13,\n            \"line\": 0,\n            \"position\": 13\n        }\n    }\n]",
    "consumer": "machine"
  },
  {
    "formatterName": "msbuild",
    "description": "Formats errors for consumption by msbuild.",
    "descriptionDetails": "\nThe output is compatible with both msbuild and Visual Studio. All failures have the\n'warning' severity.",
    "sample": "myFile.ts(1,14): warning: Missing semicolon",
    "consumer": "machine"
  },
  {
    "formatterName": "pmd",
    "description": "Formats errors as through they were PMD output.",
    "descriptionDetails": "Imitates the XML output from PMD. All errors have a priority of 1.",
    "sample": "\n<pmd version=\"tslint\">\n    <file name=\"myFile.ts\">\n        <violation begincolumn=\"14\" beginline=\"1\" priority=\"1\" rule=\"Missing semicolon\"></violation>\n    </file>\n</pmd>",
    "consumer": "machine"
  },
  {
    "formatterName": "prose",
    "description": "The default formatter which outputs simple human-readable messages.",
    "sample": "myFile.ts[1, 14]: Missing semicolon",
    "consumer": "human"
  },
  {
    "formatterName": "stylish",
    "description": "Human-readable formatter which creates stylish messages.",
    "descriptionDetails": "\nThe output matches that produced by eslint's stylish formatter. Its readability\nenhanced through spacing and colouring",
    "sample": "\nmyFile.ts\n1:14  semicolon  Missing semicolon",
    "consumer": "human"
  },
  {
    "formatterName": "verbose",
    "description": "The human-readable formatter which includes the rule name in messages.",
    "descriptionDetails": "The output is the same as the prose formatter with the rule name included",
    "sample": "(semicolon) myFile.ts[1, 14]: Missing semicolon",
    "consumer": "human"
  },
  {
    "formatterName": "vso",
    "description": "Formats output as VSO/TFS logging commands.",
    "descriptionDetails": "\nIntegrates with Visual Studio Online and Team Foundation Server by outputting errors\nas 'warning' logging commands.",
    "sample": "##vso[task.logissue type=warning;sourcepath=myFile.ts;linenumber=1;columnnumber=14;code=semicolon;]Missing semicolon",
    "consumer": "machine"
  }
]