Go Report Card

Preparing report...

Report for github.com/github/vulcanizer

A+    Excellent!    Found 4 issues across 22 files

Tweet
Last refresh:

Refresh now

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!

gocyclo95%

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.

golint90%

Golint is a linter for Go source code.

    • vulcanizer/es.go
    • Line 20: warning: comment on exported type ExcludeSettings should be of the form "ExcludeSettings ..." (with optional leading article) (golint)
    • Line 26: warning: exported type Auth should have comment or be unexported (golint)
    • Line 31: warning: comment on exported type Client should be of the form "Client ..." (with optional leading article) (golint)
    • Line 42: warning: comment on exported type Node should be of the form "Node ..." (with optional leading article) (golint)
    • Line 59: warning: comment on exported type NodeStats should be of the form "NodeStats ..." (with optional leading article) (golint)
    • Line 66: warning: comment on exported type NodeJVM should be of the form "NodeJVM ..." (with optional leading article) (golint)
    • Line 88: warning: comment on exported type Index should be of the form "Index ..." (with optional leading article) (golint)
    • Line 99: warning: comment on exported type Shard should be of the form "Shard ..." (with optional leading article) (golint)
    • Line 111: warning: comment on exported type ShardOverlap should be of the form "ShardOverlap ..." (with optional leading article) (golint)
    • Line 120: warning: comment on exported type ShardRecovery should be of the form "ShardRecovery ..." (with optional leading article) (golint)
    • Line 146: warning: comment on exported type Alias should be of the form "Alias ..." (with optional leading article) (golint)
    • Line 155: warning: comment on exported type AliasActionType should be of the form "AliasActionType ..." (with optional leading article) (golint)
    • Line 159: warning: exported const AddAlias should have comment (or a comment on this block) or be unexported (golint)
    • Line 163: warning: comment on exported type AliasAction should be of the form "AliasAction ..." (with optional leading article) (golint)
    • Line 170: warning: exported method AliasAction.MarshalJSON should have comment or be unexported (golint)
    • Line 184: warning: comment on exported type ClusterHealth should be of the form "ClusterHealth ..." (with optional leading article) (golint)
    • Line 199: warning: comment on exported type IndexHealth should be of the form "IndexHealth ..." (with optional leading article) (golint)
    • Line 209: warning: comment on exported type ClusterSettings should be of the form "ClusterSettings ..." (with optional leading article) (golint)
    • Line 215: warning: comment on exported type Setting should be of the form "Setting ..." (with optional leading article) (golint)
    • Line 232: warning: comment on exported type Snapshot should be of the form "Snapshot ..." (with optional leading article) (golint)
    • Line 254: warning: comment on exported type Repository should be of the form "Repository ..." (with optional leading article) (golint)
    • Line 267: warning: comment on exported type Token should be of the form "Token ..." (with optional leading article) (golint)
    • Line 276: warning: exported type ReloadSecureSettingsResponse should have comment or be unexported (golint)
    • Line 292: warning: comment on exported function NewClient should be of the form "NewClient ..." (golint)
    • Line 361: warning: comment on exported method ShardRecovery.TimeRemaining should be of the form "TimeRemaining ..." (golint)
    • Line 374: warning: comment on exported method ShardOverlap.SafeToRemove should be of the form "SafeToRemove ..." (golint)
    • Line 443: warning: comment on exported method Client.GetClusterExcludeSettings should be of the form "GetClusterExcludeSettings ..." (golint)
    • Line 457: warning: comment on exported method Client.DrainServer should be of the form "DrainServer ..." (golint)
    • Line 482: warning: comment on exported method Client.FillOneServer should be of the form "FillOneServer ..." (golint)
    • Line 515: warning: comment on exported method Client.FillAll should be of the form "FillAll ..." (golint)
    • Line 535: warning: comment on exported method Client.GetNodes should be of the form "GetNodes ..." (golint)
    • Line 551: warning: comment on exported method Client.GetNodeAllocations should be of the form "GetNodeAllocations ..." (golint)
    • Line 582: warning: exported method Client.GetNodeJVMStats should have comment or be unexported (golint)
    • Line 658: warning: comment on exported method Client.GetAllIndices should be of the form "GetAllIndices ..." (golint)
    • Line 672: warning: comment on exported method Client.GetIndices should be of the form "GetIndices ..." (golint)
    • Line 684: warning: comment on exported method Client.GetAllAliases should be of the form "GetAllAliases ..." (golint)
    • Line 699: warning: comment on exported method Client.GetAliases should be of the form "GetAliases ..." (golint)
    • Line 715: warning: comment on exported method Client.ModifyAliases should be of the form "ModifyAliases ..." (golint)
    • Line 737: warning: comment on exported method Client.DeleteIndex should be of the form "DeleteIndex ..." (golint)
    • Line 756: warning: comment on exported method Client.OpenIndex should be of the form "OpenIndex ..." (golint)
    • Line 778: warning: comment on exported method Client.CloseIndex should be of the form "CloseIndex ..." (golint)
    • Line 800: warning: comment on exported method Client.GetHealth should be of the form "GetHealth ..." (golint)
    • Line 825: warning: comment on exported method Client.GetClusterSettings should be of the form "GetClusterSettings ..." (golint)
    • Line 855: warning: comment on exported method Client.SetAllocation should be of the form "SetAllocation ..." (golint)
    • Line 883: warning: comment on exported method Client.SetClusterSetting should be of the form "SetClusterSetting ..." (golint)
    • Line 935: warning: comment on exported method Client.GetSnapshots should be of the form "GetSnapshots ..." (golint)
    • Line 951: warning: comment on exported method Client.GetSnapshotStatus should be of the form "GetSnapshotStatus ..." (golint)
    • Line 967: warning: comment on exported method Client.DeleteSnapshot should be of the form "DeleteSnapshot ..." (golint)
    • Line 986: warning: comment on exported method Client.VerifyRepository should be of the form "VerifyRepository ..." (golint)
    • Line 1000: warning: comment on exported method Client.RegisterRepository should be of the form "RegisterRepository ..." (golint)
    • Line 1028: warning: comment on exported method Client.RemoveRepository should be of the form "RemoveRepository ..." (golint)
    • Line 1046: warning: comment on exported method Client.GetRepositories should be of the form "GetRepositories ..." (golint)
    • Line 1074: warning: comment on exported method Client.SnapshotIndices should be of the form "SnapshotIndices ..." (golint)
    • Line 1099: warning: comment on exported method Client.SnapshotAllIndices should be of the form "SnapshotAllIndices ..." (golint)
    • Line 1117: warning: comment on exported method Client.RestoreSnapshotIndices should be of the form "RestoreSnapshotIndices ..." (golint)
    • Line 1150: warning: comment on exported method Client.AnalyzeText should be of the form "AnalyzeText ..." (golint)
    • Line 1178: warning: comment on exported method Client.AnalyzeTextWithField should be of the form "AnalyzeTextWithField ..." (golint)
    • Line 1206: warning: comment on exported method Client.GetPrettyIndexSettings should be of the form "GetPrettyIndexSettings ..." (golint)
    • Line 1227: warning: comment on exported method Client.GetIndexSettings should be of the form "GetIndexSettings ..." (golint)
    • Line 1244: warning: comment on exported method Client.SetIndexSetting should be of the form "SetIndexSetting ..." (golint)
    • Line 1267: warning: comment on exported method Client.GetPrettyIndexMappings should be of the form "GetPrettyIndexMappings ..." (golint)
    • Line 1286: warning: comment on exported method Client.GetPrettyIndexSegments should be of the form "GetPrettyIndexSegments ..." (golint)
    • Line 1305: warning: comment on exported method Client.GetShards should be of the form "GetShards ..." (golint)
    • Line 1347: warning: comment on exported method Client.GetShardOverlap should be of the form "GetShardOverlap ..." (golint)
    • Line 1404: warning: comment on exported method Client.GetShardRecovery should be of the form "GetShardRecovery ..." (golint)
    • Line 1473: warning: comment on exported method Client.ReloadSecureSettings should be of the form "ReloadSecureSettings ..." (golint)
    • Line 1487: warning: comment on exported method Client.ReloadSecureSettingsWithPassword should be of the form "ReloadSecureSettingsWithPassword ..." (golint)

license100%

Checks whether your project has a LICENSE file.

No problems detected. Good job!

ineffassign95%

IneffAssign detects ineffectual assignments in Go code.

misspell90%

Misspell Finds commonly misspelled English words