Sign upLogin

elliotchance/gedcom

View on GitHub
Star
html/publish.go

Summary

Maintainability
A
2 hrs
Test Coverage

Method Publisher.Places has a Cognitive Complexity of 28 (exceeds 20 allowed). Consider refactoring.
Open

func (publisher *Publisher) Places() map[string]*place {
    if publisher.placesMap == nil {
        publisher.placesMap = map[string]*place{}

        // Get all of the unique place names.
Severity: Minor
Found in html/publish.go - About 1 hr 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

Method Publisher.Places has 5 return statements (exceeds 4 allowed).
Open

func (publisher *Publisher) Places() map[string]*place {
    if publisher.placesMap == nil {
        publisher.placesMap = map[string]*place{}

        // Get all of the unique place names.
Severity: Major
Found in html/publish.go - About 35 mins to fix

    exported type PublishShowOptions should have comment or be unexported
    Open

    type PublishShowOptions struct {
    Severity: Minor
    Found in html/publish.go by golint

    exported type Publisher should have comment or be unexported
    Open

    type Publisher struct {
    Severity: Minor
    Found in html/publish.go by golint

    exported method Publisher.Publish should have comment or be unexported
    Open

    func (publisher *Publisher) Publish(fileWriter core.FileWriter, parallel int) (err error) {
    Severity: Minor
    Found in html/publish.go by golint

    exported method Publisher.Files should have comment or be unexported
    Open

    func (publisher *Publisher) Files(channelSize int) chan *core.File {
    Severity: Minor
    Found in html/publish.go by golint

    exported method Publisher.Places should have comment or be unexported
    Open

    func (publisher *Publisher) Places() map[string]*place {
    Severity: Minor
    Found in html/publish.go by golint

    There are no issues that match your filters.

    Category
    Status