Go Report Card

Preparing report...

Report for github.com/go-music-theory/music-theory

A    Great!    Found 26 issues across 48 files

Tweet
Last refresh:

Refresh now

gofmt87%

Gofmt formats Go programs. We run gofmt -s on your code, where -s is for the "simplify" command

go_vet100%

go vet examines Go source code and reports suspicious constructs, such as Printf calls whose arguments do not align with the format string.

No problems detected. Good job!

gocyclo100%

Gocyclo calculates cyclomatic complexities of functions in Go source code. The cyclomatic complexity of a function is calculated according to the following rules: 1 is the base complexity of a function +1 for each 'if', 'for', 'case', '&&' or '||' Go Report Card warns on functions with cyclomatic complexity > 15.

No problems detected. Good job!

golint52%

Golint is a linter for Go source code.

    • music-theory/key/spec.go
    • Line 1: warning: package comment should be of the form "Package key ..." (golint)
    • Line 8: warning: exported method Key.ToYAML should have comment or be unexported (golint)
    • music-theory/scale/scale.go
    • Line 1: warning: package comment should be of the form "Package scale ..." (golint)
    • Line 37: warning: receiver name should be a reflection of its identity; don't use generic names such as "this" or "self" (golint)
    • Line 48: warning: receiver name should be a reflection of its identity; don't use generic names such as "this" or "self" (golint)
    • music-theory/chord/form.go
    • Line 1: warning: package comment should be of the form "Package chord ..." (golint)
    • Line 24: warning: receiver name should be a reflection of its identity; don't use generic names such as "this" or "self" (golint)
    • Line 569: warning: receiver name should be a reflection of its identity; don't use generic names such as "this" or "self" (golint)
    • Line 585: warning: receiver name should be a reflection of its identity; don't use generic names such as "this" or "self" (golint)
    • Line 598: warning: receiver name should be a reflection of its identity; don't use generic names such as "this" or "self" (golint)
    • music-theory/chord/interval.go
    • Line 1: warning: package comment should be of the form "Package chord ..." (golint)
    • Line 12: warning: exported const I1 should have comment (or a comment on this block) or be unexported (golint)
    • music-theory/note/diff.go
    • Line 1: warning: package comment should be of the form "Package note ..." (golint)
    • Line 9: warning: receiver name should be a reflection of its identity; don't use generic names such as "this" or "self" (golint)
    • Line 14: warning: if block ends with a return statement, so drop this else and outdent its block (golint)
    • music-theory/key/key.go
    • Line 1: warning: package comment should be of the form "Package key ..." (golint)
    • Line 38: warning: receiver name should be a reflection of its identity; don't use generic names such as "this" or "self" (golint)
    • music-theory/key/mode.go
    • Line 1: warning: package comment should be of the form "Package key ..." (golint)
    • Line 12: warning: exported const Nil should have comment (or a comment on this block) or be unexported (golint)
    • music-theory/note/root.go
    • Line 1: warning: package comment should be of the form "Package note ..." (golint)
    • Line 18: warning: comment on exported function RootAndRemaining should be of the form "RootAndRemaining ..." (golint)
    • music-theory/note/class.go
    • Line 1: warning: package comment should be of the form "Package note ..." (golint)
    • Line 8: warning: exported const Nil should have comment (or a comment on this block) or be unexported (golint)
    • music-theory/note/octave.go
    • Line 1: warning: package comment should be of the form "Package note ..." (golint)
    • Line 12: warning: comment on exported function OctaveOf should be of the form "OctaveOf ..." (golint)
    • music-theory/scale/interval.go
    • Line 1: warning: package comment should be of the form "Package scale ..." (golint)
    • Line 12: warning: exported const I1 should have comment (or a comment on this block) or be unexported (golint)
    • music-theory/chord/spec.go
    • Line 1: warning: package comment should be of the form "Package chord ..." (golint)
    • Line 8: warning: exported method Chord.ToYAML should have comment or be unexported (golint)
    • music-theory/scale/list.go
    • Line 1: warning: package comment should be of the form "Package scale ..." (golint)
    • Line 8: warning: exported type List should have comment or be unexported (golint)
    • Line 16: warning: exported var ScaleModeList should have comment or be unexported (golint)
    • music-theory/scale/mode.go
    • Line 1: warning: package comment should be of the form "Package scale ..." (golint)
    • Line 16: warning: comment on exported type ModeIntervals should be of the form "ModeIntervals ..." (with optional leading article) (golint)
    • Line 23: warning: receiver name should be a reflection of its identity; don't use generic names such as "this" or "self" (golint)
    • Line 181: warning: receiver name should be a reflection of its identity; don't use generic names such as "this" or "self" (golint)
    • Line 199: warning: receiver name should be a reflection of its identity; don't use generic names such as "this" or "self" (golint)
    • Line 212: warning: receiver name should be a reflection of its identity; don't use generic names such as "this" or "self" (golint)
    • music-theory/scale/spec.go
    • Line 1: warning: package comment should be of the form "Package scale ..." (golint)
    • Line 8: warning: exported method Scale.ToYAML should have comment or be unexported (golint)
    • music-theory/chord/chord.go
    • Line 1: warning: package comment should be of the form "Package chord ..." (golint)
    • Line 35: warning: receiver name should be a reflection of its identity; don't use generic names such as "this" or "self" (golint)
    • Line 43: warning: receiver name should be a reflection of its identity; don't use generic names such as "this" or "self" (golint)
    • Line 59: warning: receiver name should be a reflection of its identity; don't use generic names such as "this" or "self" (golint)
    • music-theory/chord/list.go
    • Line 1: warning: package comment should be of the form "Package chord ..." (golint)
    • Line 8: warning: exported type List should have comment or be unexported (golint)
    • Line 16: warning: exported var ChordFormList should have comment or be unexported (golint)
    • music-theory/note/adjsymbol.go
    • Line 1: warning: package comment should be of the form "Package note ..." (golint)
    • Line 39: warning: comment on exported type AdjSymbol should be of the form "AdjSymbol ..." (with optional leading article) (golint)
    • Line 43: warning: exported const No should have comment (or a comment on this block) or be unexported (golint)
    • music-theory/key/diff.go
    • Line 1: warning: package comment should be of the form "Package key ..." (golint)
    • Line 5: warning: receiver name should be a reflection of its identity; don't use generic names such as "this" or "self" (golint)
    • music-theory/key/relative.go
    • Line 1: warning: package comment should be of the form "Package key ..." (golint)
    • Line 8: warning: exported method Key.RelativeMinor should have comment or be unexported (golint)
    • Line 18: warning: exported method Key.RelativeMajor should have comment or be unexported (golint)

license100%

Checks whether your project has a LICENSE file.

No problems detected. Good job!

ineffassign100%

IneffAssign detects ineffectual assignments in Go code.

No problems detected. Good job!

misspell100%

Misspell Finds commonly misspelled English words

No problems detected. Good job!