Go Report Card

Preparing report...

Report for github.com/VRCM-Project/vrcgo

A+    Excellent!    Found 14 issues across 20 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.

golint35%

Golint is a linter for Go source code.

    • vrcgo/pkg/vrchat/notification.go
    • Line 12: warning: exported const NotificationTypeRequestInvite should have comment (or a comment on this block) or be unexported (golint)
    • Line 15: warning: comment on exported const NotificationTypeBroadcast should be of the form "NotificationTypeBroadcast ..." (golint)
    • Line 18: warning: comment on exported const NotificationTypeMessage should be of the form "NotificationTypeMessage ..." (golint)
    • vrcgo/pkg/vrchat/vrchat.go
    • Line 16: warning: exported const ClientUserAgent should have comment (or a comment on this block) or be unexported (golint)
    • Line 20: warning: exported type VRChat should have comment or be unexported (golint)
    • Line 24: warning: exported function New should have comment or be unexported (golint)
    • Line 52: warning: exported method VRChat.Login should have comment or be unexported (golint)
    • Line 72: warning: exported method VRChat.LoginWithSteam should have comment or be unexported (golint)
    • vrcgo/pkg/vrchat/structs/notification.go
    • Line 8: warning: exported type Notification should have comment or be unexported (golint)
    • Line 21: warning: exported type NotificationInviteDetails should have comment or be unexported (golint)
    • Line 26: warning: exported type NotificationRequestInviteDetails should have comment or be unexported (golint)
    • Line 30: warning: exported type NotificationVoteToTick should have comment or be unexported (golint)
    • Line 36: warning: exported method Notification.Invite should have comment or be unexported (golint)
    • Line 41: warning: exported method Notification.RequestInvite should have comment or be unexported (golint)
    • Line 46: warning: exported method Notification.VoteToTick should have comment or be unexported (golint)
    • vrcgo/pkg/vrchat/wss/event.go
    • Line 8: warning: exported type FriendActiveEvent should have comment or be unexported (golint)
    • Line 9: warning: exported type FriendAddEvent should have comment or be unexported (golint)
    • Line 10: warning: exported type FriendDeleteEvent should have comment or be unexported (golint)
    • Line 11: warning: exported type FriendLocationEvent should have comment or be unexported (golint)
    • Line 12: warning: exported type FriendOfflineEvent should have comment or be unexported (golint)
    • Line 13: warning: exported type FriendOnlineEvent should have comment or be unexported (golint)
    • Line 14: warning: exported type FriendUpdateEvent should have comment or be unexported (golint)
    • Line 15: warning: exported type UserUpdateEvent should have comment or be unexported (golint)
    • Line 29: warning: exported method Client.OnFriendAdd should have comment or be unexported (golint)
    • Line 33: warning: exported method Client.OnFriendDelete should have comment or be unexported (golint)
    • Line 37: warning: exported method Client.OnFriendLocation should have comment or be unexported (golint)
    • Line 41: warning: exported method Client.OnFriendActive should have comment or be unexported (golint)
    • Line 45: warning: exported method Client.OnFriendOffline should have comment or be unexported (golint)
    • Line 49: warning: exported method Client.OnFriendOnline should have comment or be unexported (golint)
    • Line 53: warning: exported method Client.OnFriendUpdate should have comment or be unexported (golint)
    • Line 57: warning: exported method Client.OnUserUpdate should have comment or be unexported (golint)
    • vrcgo/pkg/vrchat/wss/wss.go
    • Line 16: warning: exported const VRChatWebSocketURL should have comment (or a comment on this block) or be unexported (golint)
    • Line 20: warning: exported type Client should have comment or be unexported (golint)
    • Line 28: warning: exported function NewClient should have comment or be unexported (golint)
    • Line 53: warning: exported method Client.Start should have comment or be unexported (golint)
    • vrcgo/pkg/vrchat/client.go
    • Line 12: warning: exported type Client should have comment or be unexported (golint)
    • Line 34: warning: exported method Client.Logout should have comment or be unexported (golint)
    • Line 39: warning: exported method Client.Verify2FA should have comment or be unexported (golint)
    • Line 55: warning: exported method Client.AuthUser should have comment or be unexported (golint)
    • Line 65: warning: exported method Client.AuthToken should have comment or be unexported (golint)
    • vrcgo/pkg/vrchat/structs/user.go
    • Line 4: warning: exported type User should have comment or be unexported (golint)
    • Line 18: warning: exported type LimitedUser should have comment or be unexported (golint)
    • Line 31: warning: exported type CurrentUser should have comment or be unexported (golint)
    • Line 62: warning: exported type Feature should have comment or be unexported (golint)
    • Line 66: warning: exported type SteamDetails should have comment or be unexported (golint)
    • Line 85: warning: exported type PastDisplayName should have comment or be unexported (golint)
    • vrcgo/pkg/vrchat/structs/websocket.go
    • Line 4: warning: exported type WebSocketMessage should have comment or be unexported (golint)
    • Line 9: warning: exported type WebSocketFriendAdd should have comment or be unexported (golint)
    • Line 14: warning: exported type WebSocketFriendDelete should have comment or be unexported (golint)
    • Line 18: warning: exported type WebSocketFriendActive should have comment or be unexported (golint)
    • Line 23: warning: exported type WebSocketUserUpdate should have comment or be unexported (golint)
    • Line 28: warning: exported type WebSocketFriendLocation should have comment or be unexported (golint)
    • Line 37: warning: exported type WebSocketFriendOffline should have comment or be unexported (golint)
    • Line 41: warning: exported type WebSocketFriendOnline should have comment or be unexported (golint)
    • Line 46: warning: exported type WebSocketFriendUpdate should have comment or be unexported (golint)
    • vrcgo/pkg/vrchat/structs/world.go
    • Line 4: warning: exported type World should have comment or be unexported (golint)
    • Line 26: warning: exported type LimitedWorld should have comment or be unexported (golint)
    • Line 62: warning: exported method World.GetName 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!