Skip to content

Latest commit

 

History

History
43 lines (29 loc) · 1.34 KB

SarbFormat.md

File metadata and controls

43 lines (29 loc) · 1.34 KB

SARB format

This document defines the sarb.json file format. If a static analysis tool provides an output in this format it will work directly with SARB.

Motivation

SARB could work with almost any static analysis tool. SARB needs to understand the static analysis tool's output. There are 2 options:

  • Write a Results Parser that translates the tool's output into something SARB understands
  • Make the tool output data in the sarb.json format

In most cases it is probably easier to add support for outputting the sarb.json to the static analysis tool rather than writing a Results Parser.

Format

The following information is needed for each issue the static analysis tool finds:

  • Absolute path of the file. [string]
  • Line number of the issue. [integer]
  • Type (e.g. MixedType). [string]
  • Message (e.g. Can not assign $asArray to a mixed type). [string]
  • Severity either error or warning. This is optional, if not supplied then error is assumed. [string]

It is very important Type must not have file name, class name, function or line number in it.

[
  {
    "file": "/home/johnsmith/project/Controller/HomeController.php",
    "line": 10,
    "type": "MixedType",
    "message" : "Cannot assign $asArray to a mixed type",
    "severity": "error"
  },
  ... repeat for each issue ...   
]