diff --git a/README.md b/README.md index a20f8978..b6070181 100644 --- a/README.md +++ b/README.md @@ -168,7 +168,102 @@ The output examples: } ``` -3. Text format: +3. Json `old format` (with **‑‑group‑by‑difficulty** argument): + +```json +{ + "quality": { + "EASY": { + "code": "BAD", + "text": "Code quality (beta): BAD" + }, + "MEDIUM": { + "code": "BAD", + "text": "Code quality (beta): BAD" + }, + "HARD": { + "code": "BAD", + "text": "Code quality (beta): BAD" + } + }, + "issues": [ + { + "code": "C002", + "text": "Too long function. Try to split it into smaller functions / methods.It will make your code easy to understand and less error prone.", + "line": "", + "line_number": 54, + "column_number": 0, + "category": "FUNC_LEN", + "difficulty": "EASY", + "influence_on_penalty": { + "EASY": 0, + "MEDIUM": 0, + "HARD": 0 + } + }, + ... + ] +} +``` + +4. Json `new format` (with **‑‑group‑by‑difficulty** argument) + +```json +{ + "quality": { + "EASY": { + "code": "BAD", + "text": "Code quality (beta): BAD" + }, + "MEDIUM": { + "code": "BAD", + "text": "Code quality (beta): BAD" + }, + "HARD": { + "code": "BAD", + "text": "Code quality (beta): BAD" + } + }, + "file_review_results": [ + { + "file_name": "", + "quality": { + "EASY": { + "code": "BAD", + "text": "Code quality (beta): BAD" + }, + "MEDIUM": { + "code": "BAD", + "text": "Code quality (beta): BAD" + }, + "HARD": { + "code": "BAD", + "text": "Code quality (beta): BAD" + } + }, + "issues": [ + { + "code": "W0703", + "text": "Catching too general exception Exception", + "line": "", + "line_number": 174, + "column_number": 12, + "category": "BEST_PRACTICES", + "difficulty": "MEDIUM", + "influence_on_penalty": { + "EASY": 0, + "MEDIUM": 0, + "HARD": 0 + } + }, + ... + ] + } + ] +} +``` + +5. Text format: ```text Review of (N violations)