all: fix lint errors

Author: gucio321

cmd/giu-game/tic-tac-go.go

@@ -3,11 +3,12 @@ package main
 import (
 	"bytes"
 	_ "embed"
-	"github.com/gucio321/tic-tac-go/pkg/game"
 	"image"
 	"image/png"
 	"log"
 
+	"github.com/gucio321/tic-tac-go/pkg/game"
+
 	"github.com/AllenDang/giu"
 
 	"github.com/gucio321/tic-tac-go/pkg/giuwidget"

internal/terminalgame/menu/menu.go

@@ -3,14 +3,15 @@ package menu
 import (
 	"errors"
 	"fmt"
-	"github.com/gucio321/go-clear"
 	"log"
 	"math/rand"
 	"runtime"
 	"strconv"
 	"strings"
 	"time"
 
+	"github.com/gucio321/go-clear"
+
 	"github.com/jaytaylor/html2text"
 	"github.com/pkg/browser"
 	"github.com/russross/blackfriday"

pkg/core/pcplayer/pc_player_engine.go

@@ -13,13 +13,16 @@ import (
 
 var _ player.Player = &PCPlayer{}
 
+// PCPlayer is a simple-AI logic used in Tic-Tac-Go for calculating PC-player's move.
 type PCPlayer struct {
 	b        *board.Board
 	pcLetter letter.Letter
 }
 
+// NewPCPlayer creates new PCPlayer instance.
 func NewPCPlayer(b *board.Board, pcLetter letter.Letter) *PCPlayer {
 	rand.Seed(time.Now().UnixNano())
+
 	return &PCPlayer{
 		b:        b,
 		pcLetter: pcLetter,
@@ -41,11 +44,11 @@ func (p *PCPlayer) String() string {
 //   - take opponent's opposite corner
 //   - take center
 //   - take random side
-// nolint:gocognit,gocyclo // https://github.com/gucio321/tic-tac-go/issues/154
 func (p PCPlayer) GetMove() (i int) {
 	return p.getPCMove(p.b)
 }
 
+// nolint:gocyclo // https://github.com/gucio321/tic-tac-go/issues/154
 func (p *PCPlayer) getPCMove(gameBoard *board.Board) (i int) {
 	playerLetter := p.pcLetter.Opposite()
 
@@ -143,7 +146,7 @@ func (p *PCPlayer) getPCMove(gameBoard *board.Board) (i int) {
 	panic("Tic-Tac-Go: pcplayer.GetPCMove(...): cannot determinate pc move - board is full")
 }
 
-func (p *PCPlayer) canWin(baseBoard *board.Board, player letter.Letter) (canWin bool, results []int) {
+func (p *PCPlayer) canWin(baseBoard *board.Board, playerLetter letter.Letter) (canWin bool, results []int) {
 	results = make([]int, 0)
 
 	for i := 0; i < baseBoard.Width()*baseBoard.Height(); i++ {
@@ -153,9 +156,9 @@ func (p *PCPlayer) canWin(baseBoard *board.Board, player letter.Letter) (canWin
 
 		fictionBoard := baseBoard.Copy()
 
-		fictionBoard.SetIndexState(i, player)
+		fictionBoard.SetIndexState(i, playerLetter)
 
-		if ok, _ := fictionBoard.IsWinner(player); ok {
+		if ok, _ := fictionBoard.IsWinner(playerLetter); ok {
 			results = append(results, i)
 		}
 	}
@@ -192,7 +195,7 @@ the O-player will not be able to keep X from winning.
 +---+---+---+---+---+
 O-player lost.
 */
-func (p *PCPlayer) canWinTwoMoves(gameBoard *board.Board, player letter.Letter) (result []int) {
+func (p *PCPlayer) canWinTwoMoves(gameBoard *board.Board, playerLetter letter.Letter) (result []int) {
 	result = make([]int, 0)
 
 	// nolint:gomnd // look a scheme above - in the second one, the chain is by 2 less than max
@@ -215,7 +218,7 @@ searching:
 			switch gameBoard.GetIndexState(potentialPlace[i]) {
 			case letter.LetterNone:
 				gaps = append(gaps, potentialPlace[i])
-			case player.Opposite(): // operation already blocked
+			case playerLetter.Opposite(): // operation already blocked
 				continue searching
 			}
 		}

pkg/core/players/player/player.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 )
 
+// Player is an interface implemented by any further Player implementations.
 type Player interface {
 	GetMove() int
 	fmt.Stringer

pkg/core/players/players.go

@@ -26,17 +26,17 @@ func Create(playerX, playerO player.Player) *Players {
 	return result
 }
 
-// PlayerX returns player1.
+// PlayerX returns X player.
 func (p *Players) PlayerX() player.Player {
 	return p.playerX
 }
 
-// Player2 returns player2.
+// PlayerO returns O player.
 func (p *Players) PlayerO() player.Player {
 	return p.playerO
 }
 
-// Current returns current player's letter
+// Current returns current player's letter.
 func (p *Players) Current() letter.Letter {
 	return p.current
 }
@@ -53,7 +53,7 @@ func (p *Players) CurrentPlayer() player.Player {
 	return nil
 }
 
-// Move returns a current player's move.
+// GetMove returns a current player's move.
 func (p *Players) GetMove() int {
 	return p.CurrentPlayer().GetMove()
 }

pkg/game/playerType.go

@@ -1,7 +1,9 @@
 package game
 
+// PlayerType represents type of player (human or Computer).
 type PlayerType byte
 
+// player types.
 const (
 	PlayerTypeHuman PlayerType = iota
 	PlayerTypePC

pkg/giuwidget/state.go

@@ -2,6 +2,7 @@ package giuwidget
 
 import (
 	"github.com/AllenDang/giu"
+
 	"github.com/gucio321/tic-tac-go/pkg/core/board/letter"
 
 	"github.com/gucio321/tic-tac-go/pkg/core/board"

pkg/giuwidget/widget.go

@@ -2,7 +2,6 @@
 package giuwidget
 
 import (
-	"github.com/gucio321/tic-tac-go/pkg/game"
 	"image/color"
 	"math"
 	"strconv"
@@ -11,6 +10,7 @@ import (
 	"golang.org/x/image/colornames"
 
 	"github.com/gucio321/tic-tac-go/pkg/core/board/letter"
+	"github.com/gucio321/tic-tac-go/pkg/game"
 )
 
 const id = "Tic-Tac-Go-game"