Preparing report...

Report for github.com/couchbaselabs/vellum

A+    Excellent!    Found 13 issues across 57 files

Tweet

gofmt100%

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

No problems detected. Good job!


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!


gocyclo89%

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.

    • vellum/vellum_test.go
    • Line 418: warning: cyclomatic complexity 29 of function TestMerge() is high (> 15) (gocyclo)
    • Line 25: warning: cyclomatic complexity 26 of function TestRoundTripSimple() is high (> 15) (gocyclo)
    • vellum/fst_iterator_test.go
    • Line 299: warning: cyclomatic complexity 21 of function TestIteratorSeek() is high (> 15) (gocyclo)
    • Line 582: warning: cyclomatic complexity 18 of function TestRegexpSearch() is high (> 15) (gocyclo)
    • Line 133: warning: cyclomatic complexity 17 of function TestIteratorStartKey() is high (> 15) (gocyclo)

golint85%

Golint is a linter for Go source code.

    • vellum/fst.go
    • Line 240: warning: comment on exported method FST.Reader should be of the form "Reader ..." (golint)
    • Line 246: warning: exported method FST.GetMinKey should have comment or be unexported (golint)
    • Line 269: warning: exported method FST.GetMaxKey should have comment or be unexported (golint)
    • Line 298: warning: exported method Reader.Get should have comment or be unexported (golint)
    • vellum/utf8/utf8.go
    • Line 32: warning: exported function NewSequencesPrealloc should have comment or be unexported (golint)
    • Line 243: warning: exported type RangeStack should have comment or be unexported (golint)
    • Line 245: warning: exported method RangeStack.Push should have comment or be unexported (golint)
    • Line 249: warning: exported method RangeStack.Pop should have comment or be unexported (golint)
    • vellum/regexp/regexp.go
    • Line 38: warning: exported var DefaultLimit should have comment or be unexported (golint)
    • Line 47: warning: comment on exported function New should be of the form "New ..." (golint)
    • Line 55: warning: comment on exported function NewWithLimit should be of the form "NewWithLimit ..." (golint)
    • Line 67: warning: exported function NewParsedWithLimit should have comment or be unexported (golint)
    • vellum/levenshtein/alphabet.go
    • Line 23: warning: exported type FullCharacteristicVector should have comment or be unexported (golint)
    • Line 60: warning: exported type Alphabet should have comment or be unexported (golint)
    • vellum/levenshtein/dfa.go
    • Line 22: warning: exported const SinkState should have comment or be unexported (golint)
    • Line 24: warning: exported type DFA should have comment or be unexported (golint)
    • Line 62: warning: exported method DFA.Start should have comment or be unexported (golint)
    • Line 66: warning: exported method DFA.IsMatch should have comment or be unexported (golint)
    • Line 73: warning: exported method DFA.CanMatch should have comment or be unexported (golint)
    • Line 77: warning: exported method DFA.Accept should have comment or be unexported (golint)
    • Line 99: warning: exported type Utf8DFAStateBuilder should have comment or be unexported (golint)
    • Line 134: warning: exported type Utf8StateId should have comment or be unexported (golint)
    • Line 211: warning: don't use underscores in Go names; method parameter default_suc_orig should be defaultSucOrig (golint)
    • vellum/levenshtein/levenshtein_nfa.go
    • Line 22: warning: comment on exported type Distance should be of the form "Distance ..." (with optional leading article) (golint)
    • Line 33: warning: exported type Exact should have comment or be unexported (golint)
    • Line 41: warning: exported type Atleast should have comment or be unexported (golint)
    • Line 59: warning: exported type NFAState should have comment or be unexported (golint)
    • Line 65: warning: exported type NFAStates should have comment or be unexported (golint)
    • Line 105: warning: exported type MultiState should have comment or be unexported (golint)
    • Line 109: warning: exported method MultiState.States should have comment or be unexported (golint)
    • Line 113: warning: exported method MultiState.Clear should have comment or be unexported (golint)
    • Line 175: warning: exported type LevenshteinNFA should have comment or be unexported (golint)
    • vellum/levenshtein/parametric_dfa.go
    • Line 24: warning: exported type ParametricState should have comment or be unexported (golint)
    • Line 37: warning: exported type Transition should have comment or be unexported (golint)
    • Line 54: warning: exported type ParametricStateIndex should have comment or be unexported (golint)
    • Line 104: warning: exported type ParametricDFA 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!