Skip to content

Updated README #119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nbirillo merged 2 commits into from
Aug 27, 2021
Merged

Updated README #119

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fe25b59
Added output examples with --group-by-difficulty
GirZ0n Aug 27, 2021
2bd54a1
typo fix
GirZ0n Aug 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 96 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": "<the code 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 **&#8209;&#8209;group&#8209;by&#8209;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": "<your file>",
"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": "<the code 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 <path to your file or project> (N violations)
Expand Down