Sign upLogin

pstuifzand/ekster

View on GitHub
Star
cmd/ek/main.go

Summary

Maintainability
F
3 days
Test Coverage

Function performCommands has a Cognitive Complexity of 89 (exceeds 20 allowed). Consider refactoring.
Open

func performCommands(sub microsub.Microsub, commands []string) {
    if len(commands) == 0 {
        flag.Usage()
        return
    }
Severity: Minor
Found in cmd/ek/main.go - About 1 day to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Function performCommands has 153 lines of code (exceeds 50 allowed). Consider refactoring.
Open

func performCommands(sub microsub.Microsub, commands []string) {
    if len(commands) == 0 {
        flag.Usage()
        return
    }
Severity: Major
Found in cmd/ek/main.go - About 5 hrs to fix

File main.go has 526 lines of code (exceeds 500 allowed). Consider refactoring.
Open

// Ek is a microsub client.
package main

import (
    "encoding/json"
Severity: Minor
Found in cmd/ek/main.go - About 2 hrs to fix

Function importOPMLIntoMicrosub has a Cognitive Complexity of 33 (exceeds 20 allowed). Consider refactoring.
Open

func importOPMLIntoMicrosub(sub microsub.Microsub, filename string) {
    channelMap := make(map[string]microsub.Channel)
    channels, err := sub.ChannelsGetList()
    if err != nil {
        log.Fatalf("an error occurred: %s\n", err)
Severity: Minor
Found in cmd/ek/main.go - About 2 hrs to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Function main has 72 lines of code (exceeds 50 allowed). Consider refactoring.
Open

func main() {
    flag.Parse()

    flag.Usage = func() {
        fmt.Print(`Ek is a tool for managing Microsub servers.
Severity: Minor
Found in cmd/ek/main.go - About 1 hr to fix

Function importOPMLIntoMicrosub has 62 lines of code (exceeds 50 allowed). Consider refactoring.
Open

func importOPMLIntoMicrosub(sub microsub.Microsub, filename string) {
    channelMap := make(map[string]microsub.Channel)
    channels, err := sub.ChannelsGetList()
    if err != nil {
        log.Fatalf("an error occurred: %s\n", err)
Severity: Minor
Found in cmd/ek/main.go - About 1 hr to fix

Function importJSONIntoMicrosub has a Cognitive Complexity of 24 (exceeds 20 allowed). Consider refactoring.
Open

func importJSONIntoMicrosub(sub microsub.Microsub, filename string) {
    var export Export
    f, err := os.Open(filename)
    if err != nil {
        log.Fatalf("can't open file %s: %s", filename, err)
Severity: Minor
Found in cmd/ek/main.go - About 55 mins to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Function loadEndpoints has 7 return statements (exceeds 4 allowed).
Open

func loadEndpoints(c *client.Client, me *url.URL, filename string) error {
    var endpoints indieauth.Endpoints

    f, err := os.Open(filename)
    if err != nil {
Severity: Major
Found in cmd/ek/main.go - About 45 mins to fix

2: cannot find package "github.com/gilliek/go-opml/opml" in any of:
Open

    "github.com/gilliek/go-opml/opml"
Severity: Minor
Found in cmd/ek/main.go by govet

Similar blocks of code found in 2 locations. Consider refactoring.
Open

        if ch, e := channelMap[c.Text]; !e {
            channelCreated, err := sub.ChannelsCreate(c.Text)
            if err != nil {
                log.Printf("An error occurred: %q\n", err)
                continue
Severity: Minor
Found in cmd/ek/main.go and 1 other location - About 30 mins to fix
cmd/ek/main.go on lines 509..520

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 101.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Similar blocks of code found in 2 locations. Consider refactoring.
Open

        if ch, e := channelMap[c.Name]; !e {
            channelCreated, err := sub.ChannelsCreate(c.Name)
            if err != nil {
                log.Printf("An error occurred: %q\n", err)
                continue
Severity: Minor
Found in cmd/ek/main.go and 1 other location - About 30 mins to fix
cmd/ek/main.go on lines 571..582

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 101.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

There are no issues that match your filters.

Category
Status