You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-13Lines changed: 13 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ It's also sensitive to code quality best practices—things like avoiding global
15
15
16
16
The overall score for a project should ideally be below **3** to ensure the code is maintainable and easy to understand. However, some files that involve more advanced or domain-specific logic may range between **3 and 4**. The default threshold for the a-score across the whole project is **3.3**, meaning the codebase should strive to keep its complexity below this level, but you can adjust this based on your team's needs.
17
17
18
-
### B-Score
18
+
### B-Score[BETA]
19
19
20
20
The b-score evaluates your code’s according to the Single Level of Abstraction (SLA) principle promoted by Uncle Bob’s *Clean Code*. The tool analyzes the abstraction levels in your code and assigns a score based on whether functions are mixing high- and low-level operations.
21
21
@@ -38,12 +38,15 @@ The CLI follows a specific convention for enabling and disabling boolean flags:
38
38
This applies to all boolean flags in the tool.
39
39
40
40
```bash
41
-
-a, --a-score # Enable A score (default: True), disable with --no-a-score
42
-
-b, --b-score # Enable B score (default: True), disable with --no-b-score
43
-
-r, --recommendation # Enable recommendations (default: True), disable with --no-recommendation
44
-
-at, --a-score-threshold # Set A score threshold (default: 3.3)
45
-
-bt, --b-score-threshold # Set B score threshold (default: 2.5)
46
-
-c, --clear # Clear existing reports and re-evaluate all files (default: False)
41
+
-a, --a-score # Enable A score (default: True), disable with --no-a-score
42
+
-b, --b-score # Enable B score (default: False), disable with --no-b-score
43
+
-ps, --print-improvement-suggestions # Enable print of improvement suggestions (default: false), disable with --no-print-improvement-suggestions
44
+
-at, --a-score-threshold # Set A score threshold (default: 3.3)
45
+
-bt, --b-score-threshold # Set B score threshold (default: 2.5)
46
+
-c, --clear # Clear existing reports and re-evaluate all files (default: False)
47
+
-d, --details # Add details for every function into report file (default: False)
Recommendation: Refactor the collect_data function by breaking it down into smaller functions that handle specific tasks, such as handling user input, updating user information, and managing actions taken. This will reduce its cognitive complexity and improve readability.
127
+
Suggestion: Refactor the collect_data function by breaking it down into smaller functions that handle specific tasks, such as handling user input, updating user information, and managing actions taken. This will reduce its cognitive complexity and improve readability.
0 commit comments