Commit fdb02d33 authored by Philippe Charrière's avatar Philippe Charrière Committed by Marcel Amirault

Documentation: Add the severity property

parent 143c0c66
...@@ -228,6 +228,7 @@ with the following properties: ...@@ -228,6 +228,7 @@ with the following properties:
| ---------------------- | -------------------------------------------------------------------------------------- | | ---------------------- | -------------------------------------------------------------------------------------- |
| `description` | A description of the code quality violation. | | `description` | A description of the code quality violation. |
| `fingerprint` | A unique fingerprint to identify the code quality violation. For example, an MD5 hash. | | `fingerprint` | A unique fingerprint to identify the code quality violation. For example, an MD5 hash. |
| `severity` | A severity string (can be `info`, `minor`, `major`, `critical`, or `blocker`). |
| `location.path` | The relative path to the file containing the code quality violation. | | `location.path` | The relative path to the file containing the code quality violation. |
| `location.lines.begin` | The line on which the code quality violation occurred. | | `location.lines.begin` | The line on which the code quality violation occurred. |
...@@ -238,6 +239,7 @@ Example: ...@@ -238,6 +239,7 @@ Example:
{ {
"description": "'unused' is assigned a value but never used.", "description": "'unused' is assigned a value but never used.",
"fingerprint": "7815696ecbf1c96e6894b779456d330e", "fingerprint": "7815696ecbf1c96e6894b779456d330e",
"severity": "minor",
"location": { "location": {
"path": "lib/index.js", "path": "lib/index.js",
"lines": { "lines": {
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment