fix various linting issues (#204)

markus-wa · web-flow · commit 94b3361c2b7b · 2020-04-18T18:52:31.000+01:00
diff --git a/.golangci.yml b/.golangci.yml
@@ -14,6 +14,14 @@ linters:
     - gochecknoglobals
     - lll
     - typecheck
+    - gomnd
+issues:
+  exclude-rules:
+    # Exclude some linters from running on tests files.
+    - path: _test\.go
+      linters:
+        - wsl
+        - funlen
 linters-settings:
   gocritic:
     disabled-checks:
diff --git a/internal/constants/constants.go b/internal/constants/constants.go
@@ -0,0 +1,9 @@
+package constants
+
+const (
+	MaxEdictBits                 = 11
+	EntityHandleIndexMask        = (1 << MaxEdictBits) - 1
+	EntityHandleSerialNumberBits = 10
+	EntityHandleBits             = MaxEdictBits + EntityHandleSerialNumberBits
+	InvalidEntityHandle          = (1 << EntityHandleBits) - 1
+)
diff --git a/pkg/demoinfocs/common/equipment.go b/pkg/demoinfocs/common/equipment.go
@@ -122,6 +122,7 @@ func init() {
 	initEqElementToName()
 }
 
+//nolint:funlen
 func initEqNameToWeapon() {
 	eqNameToWeapon = make(map[string]EquipmentType)
 
@@ -198,6 +199,7 @@ func initEqNameToWeapon() {
 	eqNameToWeapon["worldspawn"] = EqWorld
 }
 
+//nolint:funlen
 func initEqElementToName() {
 	eqElementToName = make(map[EquipmentType]string)
 	eqElementToName[EqAK47] = "AK-47"
@@ -333,7 +335,9 @@ func (e Equipment) ZoomLevel() ZoomLevel {
 		return 0
 	}
 
+	// if the property doesn't exist we return 0 by default
 	val, _ := e.Entity.PropertyValue("m_zoomLevel")
+
 	return ZoomLevel(val.IntVal)
 }
 
@@ -350,7 +354,9 @@ func (e Equipment) AmmoReserve() int {
 		return 0
 	}
 
+	// if the property doesn't exist we return 0 by default
 	val, _ := e.Entity.PropertyValue("m_iPrimaryReserveAmmoCount")
+
 	return val.IntVal
 }
 
diff --git a/pkg/demoinfocs/common/inferno.go b/pkg/demoinfocs/common/inferno.go
@@ -49,9 +49,8 @@ func (inf Inferno) UniqueID() int64 {
 func (inf Inferno) Fires() Fires {
 	entity := inf.Entity
 	origin := entity.Position()
-
-	var fires []Fire
 	nFires := entity.PropertyValueMust("m_fireCount").IntVal
+	fires := make([]Fire, 0, nFires)
 
 	for i := 0; i < nFires; i++ {
 		iStr := fmt.Sprintf("%03d", i)
diff --git a/pkg/demoinfocs/common/player.go b/pkg/demoinfocs/common/player.go
@@ -6,17 +6,10 @@ import (
 
 	"github.com/golang/geo/r3"
 
+	constants "github.com/markus-wa/demoinfocs-golang/v2/internal/constants"
 	st "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/sendtables"
 )
 
-const (
-	maxEdictBits                 = 11
-	entityHandleIndexMask        = (1 << maxEdictBits) - 1
-	entityHandleSerialNumberBits = 10
-	entityHandleBits             = maxEdictBits + entityHandleSerialNumberBits
-	invalidEntityHandle          = (1 << entityHandleBits) - 1
-)
-
 // Player contains mostly game-relevant player information.
 type Player struct {
 	demoInfoProvider demoInfoProvider // provider for demo info such as tick-rate or current tick
@@ -76,7 +69,7 @@ func (p *Player) IsAirborne() bool {
 
 	groundEntityHandle := p.Entity.Property("m_hGroundEntity").Value().IntVal
 
-	return groundEntityHandle == invalidEntityHandle
+	return groundEntityHandle == constants.InvalidEntityHandle
 }
 
 // FlashDurationTime returns the duration of the blinding effect as time.Duration instead of float32 in seconds.
@@ -129,7 +122,7 @@ This isn't very conclusive but it looks like IsFlashed isn't super reliable curr
 
 // Used internally to set the active weapon, see ActiveWeapon()
 func (p *Player) activeWeaponID() int {
-	return getInt(p.Entity, "m_hActiveWeapon") & entityHandleIndexMask
+	return getInt(p.Entity, "m_hActiveWeapon") & constants.EntityHandleIndexMask
 }
 
 // ActiveWeapon returns the currently active / equipped weapon of the player.
diff --git a/pkg/demoinfocs/datatables.go b/pkg/demoinfocs/datatables.go
@@ -7,22 +7,12 @@ import (
 	"github.com/golang/geo/r3"
 	"github.com/markus-wa/go-unassert"
 
+	constants "github.com/markus-wa/demoinfocs-golang/v2/internal/constants"
 	common "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/common"
 	events "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/events"
 	st "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/sendtables"
 )
 
-const (
-	maxEdictBits                 = 11
-	entityHandleIndexMask        = (1 << maxEdictBits) - 1
-	entityHandleSerialNumberBits = 10
-	entityHandleBits             = maxEdictBits + entityHandleSerialNumberBits
-	invalidEntityHandle          = (1 << entityHandleBits) - 1
-	maxEntities                  = 1 << maxEdictBits
-	maxPlayers                   = 64
-	maxWeapons                   = 64
-)
-
 func (p *parser) mapEquipment() {
 	for _, sc := range p.stParser.ServerClasses() {
 		switch sc.Name() {
@@ -215,6 +205,7 @@ func (p *parser) getOrCreatePlayer(entityID int, rp *playerInfo) (isNew bool, pl
 	return isNew, player
 }
 
+//nolint:funlen
 func (p *parser) bindNewPlayer(playerEntity st.Entity) {
 	entityID := playerEntity.ID()
 	rp := p.rawPlayers[entityID-1]
@@ -289,6 +280,8 @@ func (p *parser) bindNewPlayer(playerEntity st.Entity) {
 	}
 }
 
+const maxWeapons = 64
+
 func (p *parser) bindPlayerWeapons(playerEntity st.Entity, pl *common.Player) {
 	// Some demos have an additional prefix for player weapons weapon
 	var wepPrefix string
@@ -303,8 +296,8 @@ func (p *parser) bindPlayerWeapons(playerEntity st.Entity, pl *common.Player) {
 	for i := range cache {
 		i2 := i // Copy for passing to handler
 		playerEntity.Property(wepPrefix + fmt.Sprintf("%03d", i)).OnUpdate(func(val st.PropertyValue) {
-			entityID := val.IntVal & entityHandleIndexMask
-			if entityID != entityHandleIndexMask {
+			entityID := val.IntVal & constants.EntityHandleIndexMask
+			if entityID != constants.EntityHandleIndexMask {
 				if cache[i2] != 0 {
 					// Player already has a weapon in this slot.
 					delete(pl.Inventory, cache[i2])
@@ -351,7 +344,7 @@ func (p *parser) bindWeapons() {
 			case "CBaseCSGrenade":
 				// @micvbang TODO: handle grenades dropped by dead player.
 				// Grenades that were dropped by a dead player (and can be picked up by other players).
-			}
+			} //nolint:wsl
 		}
 	}
 
@@ -368,7 +361,7 @@ func (p *parser) bindGrenadeProjectiles(entity st.Entity) {
 	p.gameState.grenadeProjectiles[entityID] = proj
 
 	var wep common.EquipmentType
-	entity.OnCreateFinished(func() {
+	entity.OnCreateFinished(func() { //nolint:wsl
 		// copy the weapon so it doesn't get overwritten by a new entity in parser.weapons
 		wepCopy := *(getPlayerWeapon(proj.Thrower, wep))
 		proj.WeaponInstance = &wepCopy
diff --git a/pkg/demoinfocs/debug_on.go b/pkg/demoinfocs/debug_on.go
@@ -38,6 +38,7 @@ func debugGameEvent(d *msg.CSVCMsg_GameEventListDescriptorT, ge *msg.CSVCMsg_Gam
 	if debugGameEvents == yes {
 		// Map only the relevant data for each type
 		data := make(map[string]interface{})
+
 		for k, v := range mapGameEventData(d, ge) {
 			switch v.Type {
 			case typeStr:
diff --git a/pkg/demoinfocs/fake/parser.go b/pkg/demoinfocs/fake/parser.go
@@ -211,14 +211,12 @@ func (p *Parser) ParseNextFrame() (b bool, err error) {
 }
 
 func max(numbers map[int][]interface{}) (maxNumber int) {
-	for maxNumber = range numbers {
-		break
-	}
 	for n := range numbers {
 		if n > maxNumber {
 			maxNumber = n
 		}
 	}
+
 	return
 }
 
diff --git a/pkg/demoinfocs/game_events.go b/pkg/demoinfocs/game_events.go
@@ -3,6 +3,7 @@ package demoinfocs
 import (
 	"errors"
 	"fmt"
+
 	"github.com/golang/geo/r3"
 	"github.com/markus-wa/go-unassert"
 
@@ -22,6 +23,7 @@ func (p *parser) handleGameEvent(ge *msg.CSVCMsg_GameEvent) {
 	if p.gameEventDescs == nil {
 		p.eventDispatcher.Dispatch(events.ParserWarn{Message: "received GameEvent but event descriptors are missing"})
 		unassert.Error("received GameEvent but event descriptors are missing")
+
 		return
 	}
 
@@ -71,6 +73,7 @@ func (geh gameEventHandler) playerByUserID32(userID int32) *common.Player {
 
 type gameEventHandlerFunc func(map[string]*msg.CSVCMsg_GameEventKeyT)
 
+//nolint:funlen
 func newGameEventHandler(parser *parser) gameEventHandler {
 	geh := gameEventHandler{parser: parser}
 
@@ -192,15 +195,15 @@ func (geh gameEventHandler) roundStart(data map[string]*msg.CSVCMsg_GameEventKey
 	})
 }
 
-func (geh gameEventHandler) csWinPanelMatch(data map[string]*msg.CSVCMsg_GameEventKeyT) {
+func (geh gameEventHandler) csWinPanelMatch(map[string]*msg.CSVCMsg_GameEventKeyT) {
 	geh.dispatch(events.AnnouncementWinPanelMatch{})
 }
 
-func (geh gameEventHandler) roundAnnounceFinal(data map[string]*msg.CSVCMsg_GameEventKeyT) {
+func (geh gameEventHandler) roundAnnounceFinal(map[string]*msg.CSVCMsg_GameEventKeyT) {
 	geh.dispatch(events.AnnouncementFinalRound{})
 }
 
-func (geh gameEventHandler) roundAnnounceLastRoundHalf(data map[string]*msg.CSVCMsg_GameEventKeyT) {
+func (geh gameEventHandler) roundAnnounceLastRoundHalf(map[string]*msg.CSVCMsg_GameEventKeyT) {
 	geh.dispatch(events.AnnouncementLastRoundHalf{})
 }
 
@@ -222,7 +225,7 @@ func (geh gameEventHandler) roundEnd(data map[string]*msg.CSVCMsg_GameEventKeyT)
 	})
 }
 
-func (geh gameEventHandler) roundOfficiallyEnded(data map[string]*msg.CSVCMsg_GameEventKeyT) {
+func (geh gameEventHandler) roundOfficiallyEnded(map[string]*msg.CSVCMsg_GameEventKeyT) {
 	// Issue #42
 	// Sometimes grenades & infernos aren't deleted / destroyed via entity-updates at the end of the round,
 	// so we need to do it here for those that weren't.
@@ -263,11 +266,11 @@ func (geh gameEventHandler) botTakeover(data map[string]*msg.CSVCMsg_GameEventKe
 	})
 }
 
-func (geh gameEventHandler) beginNewMatch(data map[string]*msg.CSVCMsg_GameEventKeyT) {
+func (geh gameEventHandler) beginNewMatch(map[string]*msg.CSVCMsg_GameEventKeyT) {
 	geh.dispatch(events.MatchStart{})
 }
 
-func (geh gameEventHandler) roundFreezeEnd(data map[string]*msg.CSVCMsg_GameEventKeyT) {
+func (geh gameEventHandler) roundFreezeEnd(map[string]*msg.CSVCMsg_GameEventKeyT) {
 	geh.dispatch(events.RoundFreezetimeEnd{})
 }
 
diff --git a/pkg/demoinfocs/game_state.go b/pkg/demoinfocs/game_state.go
@@ -1,6 +1,7 @@
 package demoinfocs
 
 import (
+	constants "github.com/markus-wa/demoinfocs-golang/v2/internal/constants"
 	common "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/common"
 	st "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/sendtables"
 )
@@ -180,6 +181,7 @@ type participants struct {
 // Includes spectators.
 func (ptcp participants) ByUserID() map[int]*common.Player {
 	res := make(map[int]*common.Player)
+
 	for k, v := range ptcp.playersByUserID {
 		// We need to check if the player entity hasn't been destroyed yet
 		// See https://github.com/markus-wa/demoinfocs-golang/issues/98
@@ -269,11 +271,11 @@ func (ptcp participants) TeamMembers(team common.Team) []*common.Player {
 //
 // Returns nil if not found or if handle == invalidEntityHandle (used when referencing no entity).
 func (ptcp participants) FindByHandle(handle int) *common.Player {
-	if handle == invalidEntityHandle {
+	if handle == constants.InvalidEntityHandle {
 		return nil
 	}
 
-	entityID := handle & entityHandleIndexMask
+	entityID := handle & constants.EntityHandleIndexMask
 	player := ptcp.playersByEntityID[entityID]
 
 	if player == nil {
diff --git a/pkg/demoinfocs/game_state_test.go b/pkg/demoinfocs/game_state_test.go
@@ -5,6 +5,7 @@ import (
 
 	"github.com/stretchr/testify/assert"
 
+	constants "github.com/markus-wa/demoinfocs-golang/v2/internal/constants"
 	common "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/common"
 	st "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/sendtables"
 	stfake "github.com/markus-wa/demoinfocs-golang/v2/pkg/demoinfocs/sendtables/fake"
@@ -146,7 +147,7 @@ func TestParticipants_FindByHandle(t *testing.T) {
 
 	ptcps := participants{
 		playersByEntityID: map[int]*common.Player{
-			3000 & entityHandleIndexMask: pl,
+			3000 & constants.EntityHandleIndexMask: pl,
 		},
 	}
 
@@ -160,11 +161,11 @@ func TestParticipants_FindByHandle_InvalidEntityHandle(t *testing.T) {
 	pl.Team = common.TeamTerrorists
 	ptcps := participants{
 		playersByEntityID: map[int]*common.Player{
-			invalidEntityHandle & entityHandleIndexMask: pl,
+			constants.InvalidEntityHandle & constants.EntityHandleIndexMask: pl,
 		},
 	}
 
-	found := ptcps.FindByHandle(invalidEntityHandle)
+	found := ptcps.FindByHandle(constants.InvalidEntityHandle)
 
 	assert.Nil(t, found)
 }
diff --git a/pkg/demoinfocs/net_messages.go b/pkg/demoinfocs/net_messages.go
@@ -42,13 +42,14 @@ func (p *parser) handlePacketEntities(pe *msg.CSVCMsg_PacketEntities) {
 				existing.Destroy()
 			}
 			p.gameState.entities[currentEntity] = p.stParser.ReadEnterPVS(r, currentEntity)
-		} else {
+		} else { //nolint:gocritic
 			// Delta Update
 			if entity := p.gameState.entities[currentEntity]; entity != nil {
 				entity.ApplyUpdate(r)
 			}
 		}
 	}
+
 	r.Pool()
 }
 
diff --git a/pkg/demoinfocs/parser.go b/pkg/demoinfocs/parser.go
@@ -233,11 +233,12 @@ func (p *parser) UnregisterNetMessageHandler(identifier dp.HandlerIdentifier) {
 	p.msgDispatcher.UnregisterHandler(identifier)
 }
 
-func (p *parser) error() (err error) {
+func (p *parser) error() error {
 	p.errLock.Lock()
-	err = p.err
+	err := p.err
 	p.errLock.Unlock()
-	return
+
+	return err
 }
 
 func (p *parser) setError(err error) {
diff --git a/pkg/demoinfocs/parsing.go b/pkg/demoinfocs/parsing.go
diff --git a/pkg/demoinfocs/sendtables/propdecoder.go b/pkg/demoinfocs/sendtables/propdecoder.go
diff --git a/pkg/demoinfocs/sendtables/st_parser.go b/pkg/demoinfocs/sendtables/st_parser.go
diff --git a/pkg/demoinfocs/stringtables.go b/pkg/demoinfocs/stringtables.go
diff --git a/pkg/demoinfocs/user_messages.go b/pkg/demoinfocs/user_messages.go

Original file line number	Diff line number	Diff line change
`@@ -122,6 +122,7 @@ func init() {`
`122`	`122`	`initEqElementToName()`
`123`	`123`	`}`
`124`	`124`
	`125`	`+//nolint:funlen`
`125`	`126`	`func initEqNameToWeapon() {`
`126`	`127`	`eqNameToWeapon = make(map[string]EquipmentType)`
`127`	`128`
`@@ -198,6 +199,7 @@ func initEqNameToWeapon() {`
`198`	`199`	`eqNameToWeapon["worldspawn"] = EqWorld`
`199`	`200`	`}`
`200`	`201`
	`202`	`+//nolint:funlen`
`201`	`203`	`func initEqElementToName() {`
`202`	`204`	`eqElementToName = make(map[EquipmentType]string)`
`203`	`205`	`eqElementToName[EqAK47] = "AK-47"`
`@@ -333,7 +335,9 @@ func (e Equipment) ZoomLevel() ZoomLevel {`
`333`	`335`	`return 0`
`334`	`336`	`}`
`335`	`337`
	`338`	`+ // if the property doesn't exist we return 0 by default`
`336`	`339`	`val, _ := e.Entity.PropertyValue("m_zoomLevel")`
	`340`	`+`
`337`	`341`	`return ZoomLevel(val.IntVal)`
`338`	`342`	`}`
`339`	`343`
`@@ -350,7 +354,9 @@ func (e Equipment) AmmoReserve() int {`
`350`	`354`	`return 0`
`351`	`355`	`}`
`352`	`356`
	`357`	`+ // if the property doesn't exist we return 0 by default`
`353`	`358`	`val, _ := e.Entity.PropertyValue("m_iPrimaryReserveAmmoCount")`
	`359`	`+`
`354`	`360`	`return val.IntVal`
`355`	`361`	`}`
`356`	`362`
Original file line number	Diff line number	Diff line change
`@@ -211,14 +211,12 @@ func (p *Parser) ParseNextFrame() (b bool, err error) {`
`211`	`211`	`}`
`212`	`212`
`213`	`213`	`func max(numbers map[int][]interface{}) (maxNumber int) {`
`214`		`- for maxNumber = range numbers {`
`215`		`- break`
`216`		`- }`
`217`	`214`	`for n := range numbers {`
`218`	`215`	`if n > maxNumber {`
`219`	`216`	`maxNumber = n`
`220`	`217`	`}`
`221`	`218`	`}`
	`219`	`+`
`222`	`220`	`return`
`223`	`221`	`}`
`224`	`222`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@ package demoinfocs`
`3`	`3`	`import (`
`4`	`4`	`"errors"`
`5`	`5`	`"fmt"`
	`6`	`+`
`6`	`7`	`"github.com/golang/geo/r3"`
`7`	`8`	`"github.com/markus-wa/go-unassert"`
`8`	`9`
`@@ -22,6 +23,7 @@ func (p parser) handleGameEvent(ge msg.CSVCMsg_GameEvent) {`
`22`	`23`	`if p.gameEventDescs == nil {`
`23`	`24`	`p.eventDispatcher.Dispatch(events.ParserWarn{Message: "received GameEvent but event descriptors are missing"})`
`24`	`25`	`unassert.Error("received GameEvent but event descriptors are missing")`
	`26`	`+`
`25`	`27`	`return`
`26`	`28`	`}`
`27`	`29`
`@@ -71,6 +73,7 @@ func (geh gameEventHandler) playerByUserID32(userID int32) *common.Player {`
`71`	`73`
`72`	`74`	`type gameEventHandlerFunc func(map[string]*msg.CSVCMsg_GameEventKeyT)`
`73`	`75`
	`76`	`+//nolint:funlen`
`74`	`77`	`func newGameEventHandler(parser *parser) gameEventHandler {`
`75`	`78`	`geh := gameEventHandler{parser: parser}`
`76`	`79`
`@@ -192,15 +195,15 @@ func (geh gameEventHandler) roundStart(data map[string]*msg.CSVCMsg_GameEventKey`
`192`	`195`	`})`
`193`	`196`	`}`
`194`	`197`
`195`		`-func (geh gameEventHandler) csWinPanelMatch(data map[string]*msg.CSVCMsg_GameEventKeyT) {`
	`198`	`+func (geh gameEventHandler) csWinPanelMatch(map[string]*msg.CSVCMsg_GameEventKeyT) {`
`196`	`199`	`geh.dispatch(events.AnnouncementWinPanelMatch{})`
`197`	`200`	`}`
`198`	`201`
`199`		`-func (geh gameEventHandler) roundAnnounceFinal(data map[string]*msg.CSVCMsg_GameEventKeyT) {`
	`202`	`+func (geh gameEventHandler) roundAnnounceFinal(map[string]*msg.CSVCMsg_GameEventKeyT) {`
`200`	`203`	`geh.dispatch(events.AnnouncementFinalRound{})`
`201`	`204`	`}`
`202`	`205`
`203`		`-func (geh gameEventHandler) roundAnnounceLastRoundHalf(data map[string]*msg.CSVCMsg_GameEventKeyT) {`
	`206`	`+func (geh gameEventHandler) roundAnnounceLastRoundHalf(map[string]*msg.CSVCMsg_GameEventKeyT) {`
`204`	`207`	`geh.dispatch(events.AnnouncementLastRoundHalf{})`
`205`	`208`	`}`
`206`	`209`
`@@ -222,7 +225,7 @@ func (geh gameEventHandler) roundEnd(data map[string]*msg.CSVCMsg_GameEventKeyT)`
`222`	`225`	`})`
`223`	`226`	`}`
`224`	`227`
`225`		`-func (geh gameEventHandler) roundOfficiallyEnded(data map[string]*msg.CSVCMsg_GameEventKeyT) {`
	`228`	`+func (geh gameEventHandler) roundOfficiallyEnded(map[string]*msg.CSVCMsg_GameEventKeyT) {`
`226`	`229`	`// Issue #42`
`227`	`230`	`// Sometimes grenades & infernos aren't deleted / destroyed via entity-updates at the end of the round,`
`228`	`231`	`// so we need to do it here for those that weren't.`
`@@ -263,11 +266,11 @@ func (geh gameEventHandler) botTakeover(data map[string]*msg.CSVCMsg_GameEventKe`
`263`	`266`	`})`
`264`	`267`	`}`
`265`	`268`
`266`		`-func (geh gameEventHandler) beginNewMatch(data map[string]*msg.CSVCMsg_GameEventKeyT) {`
	`269`	`+func (geh gameEventHandler) beginNewMatch(map[string]*msg.CSVCMsg_GameEventKeyT) {`
`267`	`270`	`geh.dispatch(events.MatchStart{})`
`268`	`271`	`}`
`269`	`272`
`270`		`-func (geh gameEventHandler) roundFreezeEnd(data map[string]*msg.CSVCMsg_GameEventKeyT) {`
	`273`	`+func (geh gameEventHandler) roundFreezeEnd(map[string]*msg.CSVCMsg_GameEventKeyT) {`
`271`	`274`	`geh.dispatch(events.RoundFreezetimeEnd{})`
`272`	`275`	`}`
`273`	`276`