func Generate has a cyclomatic complexity of 21 with "high" risk116// Generate generates the config file.
117//
118//nolint:gocyclo
119func (c *JiraCLIConfigGenerator) Generate() (string, error) {120 var cfgFile string
121
122 if cfgFile = viper.ConfigFileUsed(); cfgFile == "" {func configureProjectAndBoardDetails has a cyclomatic complexity of 21 with "high" risk477}
478
479//nolint:gocyclo
480func (c *JiraCLIConfigGenerator) configureProjectAndBoardDetails() error {481 project := c.usrCfg.Project
482 board := c.usrCfg.Board
483func configureServerAndLoginDetails has a cyclomatic complexity of 22 with "high" risk302}
303
304//nolint:gocyclo
305func (c *JiraCLIConfigGenerator) configureServerAndLoginDetails() error {306 var qs []*survey.Question
307
308 c.value.server = c.usrCfg.Serverfunc initTable has a cyclomatic complexity of 21 with "high" risk263}
264
265//nolint:gocyclo
266func (t *Table) initTable() {267 t.view.SetSelectable(true, false).
268 SetSelectedStyle(customTUIStyle(t.style)).
269 SetDoneFunc(func(key tcell.Key) {func prompt has a cyclomatic complexity of 17 with "high" risk 67// EXTENDED to augment prompt text and keypress handling.
68//
69//nolint:gocyclo
70func (e *JiraEditor) prompt(initialValue string, config *survey.PromptConfig) (interface{}, error) { 71 err := e.Render(
72 EditorQuestionTemplate,
73 // EXTENDED to support printing editor in prompt and BlankAllowed.A function with high cyclomatic complexity can be hard to understand and maintain. Cyclomatic complexity is a software metric that measures the number of independent paths through a function. A higher cyclomatic complexity indicates that the function has more decision points and is more complex.
Functions with high cyclomatic complexity are more likely to have bugs and be harder to test. They may lead to reduced code maintainability and increased development time.
To reduce the cyclomatic complexity of a function, you can:
- Break the function into smaller, more manageable functions.
- Refactor complex logic into separate functions or classes.
- Avoid multiple return paths and deeply nested control expressions.
Bad practice
package main
import "log"
func fizzbuzzfuzz(x int) { // cc = 1
if x == 0 || x < 0 { // cc = 3 (if, ||)
return
}
for i := 1; i <= x; i++ { // cc = 4 (for)
switch i % 15 * 2 {
case 0: // cc = 5 (case)
countDiv3 += 1
countDiv5 += 1
log.Println("fizzbuzz")
break
case 3:
case 6:
case 9:
case 12: // cc = 9 (case)
countDiv3 += 1
log.Println("fizz")
break
case 5:
case 10: // cc = 11 (case)
countDiv5 += 1
log.Println("buzz")
break
default:
log.Printf("%d\n", x)
}
}
} // CC == 11; raises issues
Recommended
package main
import "log"
func fizzbuzz(x int) { // cc = 1
for i := 1; i <= x; i++ { // cc = 2 (for)
y := i%3 == 0
z := i%5 == 0
if y == z { // 3
if y == false { // 4
log.Printf("%d\n", i)
} else {
log.Println("fizzbuzz")
}
} else {
if y { // 5
log.Println("fizz")
} else {
log.Println("buzz")
}
}
}
} // CC == 5
Issue configuration
Cyclomatic complexity threshold can be configured using the
cyclomatic_complexity_threshold (docs) in the
.deepsource.toml config file.
Configuring this is optional. If you don't provide a value, the Analyzer will
raise issues for functions with complexity higher than the default threshold,
which is medium(only raise issues for >15) for the Go Analyzer.
Here's the mapping of the risk category to the cyclomatic complexity score to help you configure this better:
| Risk category | Cyclomatic complexity range | Recommended action |
|---|---|---|
| low | 1-5 | No action needed. |
| medium | 6-15 | Review and monitor. |
| high | 16-25 | Review and refactor. Recommended to add comments if the function is absolutely needed to be kept as it is. |
| very-high. | 26-50 | Refactor to reduce the complexity. |
| critical | >50 | Must refactor this. This can make the code untestable and very difficult to understand. |