diff --git a/git/patch.go b/git/patch.go index a856d795e9eb1347f8c00418a96eab2240d39af6..b797edd0c13cf9663fbbcab5c9b5278b7defa075 100644 --- a/git/patch.go +++ b/git/patch.go @@ -136,7 +136,7 @@ func (f *DiffFile) Files() (from *DiffFileChange, to *DiffFileChange) { return } -// FileStats. +// FileStats represents statistics for changed files in a diff. type FileStats []*DiffFile // String returns a string representation of file stats. @@ -237,7 +237,7 @@ type Diff struct { Files []*DiffFile } -// FileStats returns the diff file stats. +// Stats returns the diff file stats. func (d *Diff) Stats() FileStats { return d.Files } diff --git a/git/repo.go b/git/repo.go index d84b99442842e4d2c2891fd879f46b295e94d423..5272f0341de8f12b0863490a094b9ae0f7be50eb 100644 --- a/git/repo.go +++ b/git/repo.go @@ -8,7 +8,7 @@ import ( ) var ( - // DiffMaxFile is the maximum number of files to show in a diff. + // DiffMaxFiles is the maximum number of files to show in a diff. DiffMaxFiles = 1000 // DiffMaxFileLines is the maximum number of lines to show in a file diff. DiffMaxFileLines = 1000 diff --git a/pkg/access/access.go b/pkg/access/access.go index efe9a230d753f414f84911d72f5549fe6e87074d..107acfa7e9fc3db11ad8153bf048ce0cfe301427 100644 --- a/pkg/access/access.go +++ b/pkg/access/access.go @@ -1,3 +1,4 @@ +// Package access defines access control levels and permissions for repositories and users. package access import ( diff --git a/pkg/cron/cron.go b/pkg/cron/cron.go index 8c6d68e3b37a466048dff0eaf346c4d3ebaf6fcc..12241f5fa8424d2678516ed0b78d0c7ccbeb1b15 100644 --- a/pkg/cron/cron.go +++ b/pkg/cron/cron.go @@ -37,7 +37,7 @@ func NewScheduler(ctx context.Context) *Scheduler { } } -// Shutdonw gracefully shuts down the Scheduler. +// Shutdown gracefully shuts down the Scheduler. func (s *Scheduler) Shutdown() { ctx, cancel := context.WithTimeout(s.Cron.Stop(), 30*time.Second) defer func() { cancel() }() diff --git a/pkg/daemon/daemon.go b/pkg/daemon/daemon.go index bb98652180dcbe4d3ed52d07898c84c07ccf2d78..a5a91f826d2cdfd6f936c5eeb9ec74a6389f311b 100644 --- a/pkg/daemon/daemon.go +++ b/pkg/daemon/daemon.go @@ -58,7 +58,7 @@ type GitDaemon struct { liMu sync.Mutex } -// NewDaemon returns a new Git daemon. +// NewGitDaemon returns a new Git daemon. func NewGitDaemon(ctx context.Context) (*GitDaemon, error) { cfg := config.FromContext(ctx) addr := cfg.Git.ListenAddr diff --git a/pkg/daemon/daemon_test.go b/pkg/daemon/daemon_test.go index 54a00e53e6841da90f63c0255aa0a875429d1b35..fa0f9cc46082a99896da6855309c6575de7d6399 100644 --- a/pkg/daemon/daemon_test.go +++ b/pkg/daemon/daemon_test.go @@ -6,7 +6,6 @@ import ( "log" "net" "os" - "strings" "testing" "time" @@ -86,7 +85,7 @@ func TestIdleTimeout(t *testing.T) { time.Sleep(10 * time.Millisecond) } time.Sleep(2 * time.Second) - _, err = readPktline(c) + err = readPktline(c) if err == nil { t.Errorf("expected error, got nil") } @@ -100,16 +99,16 @@ func TestInvalidRepo(t *testing.T) { if err := pktline.NewEncoder(c).EncodeString("git-upload-pack /test.git\x00"); err != nil { t.Fatalf("expected nil, got error: %v", err) } - _, err = readPktline(c) + err = readPktline(c) if err != nil && err.Error() != git.ErrInvalidRepo.Error() { t.Errorf("expected %q error, got %q", git.ErrInvalidRepo, err) } } -func readPktline(c net.Conn) (string, error) { +func readPktline(c net.Conn) error { pktout := pktline.NewScanner(c) if !pktout.Scan() { - return "", pktout.Err() + return pktout.Err() } - return strings.TrimSpace(string(pktout.Bytes())), nil + return nil } diff --git a/pkg/db/context.go b/pkg/db/context.go index 5e289d8df96a0941d4d594aaba3494f553465e24..c5ea19563885a4ec964fcbd9cc70765c0b969722 100644 --- a/pkg/db/context.go +++ b/pkg/db/context.go @@ -1,3 +1,4 @@ +// Package db provides database interface and connection management for Soft Serve. package db import "context" diff --git a/pkg/log/log.go b/pkg/log/log.go index 57bf25285e2b88a0ba75f0be41b83583081f5df5..fe5a76bcee11f19f623ad2d6c3b9026845524f09 100644 --- a/pkg/log/log.go +++ b/pkg/log/log.go @@ -1,3 +1,4 @@ +// Package log provides logging functionality and context-aware logging utilities. package log import ( diff --git a/pkg/proto/access_token.go b/pkg/proto/access_token.go index 2876c361356718acc2e3bf975a891b709c76f33a..ed318a270cd6fe088927e45cf00dbf4f73fb7eee 100644 --- a/pkg/proto/access_token.go +++ b/pkg/proto/access_token.go @@ -1,3 +1,4 @@ +// Package proto defines protocol buffer-like interfaces and data structures for the Soft Serve API. package proto import "time" diff --git a/pkg/ssh/session_test.go b/pkg/ssh/session_test.go index 8abb9aaf548cbdb408d060cd55878c5eae8e8f8f..e6f57d64ec5fadb2568ad771e24e8fbd9ac77f2f 100644 --- a/pkg/ssh/session_test.go +++ b/pkg/ssh/session_test.go @@ -28,7 +28,7 @@ func TestSession(t *testing.T) { is := is.New(t) t.Run("authorized repo access", func(t *testing.T) { t.Log("setting up") - s, close := setup(t) + s, cleanup := setup(t) s.Stderr = os.Stderr t.Log("requesting pty") err := s.RequestPty("xterm", 80, 40, nil) @@ -43,7 +43,7 @@ func TestSession(t *testing.T) { var ee *gossh.ExitMissingError is.True(errors.As(err, &ee)) t.Log("session exited") - is.NoErr(close()) + is.NoErr(cleanup()) }) } diff --git a/pkg/ssh/ssh.go b/pkg/ssh/ssh.go index 716b8daac469a8dfbb64b76c0de2e87c63dbb0a1..51ff3a131f1df55d0cdb9926ef00ad011380045b 100644 --- a/pkg/ssh/ssh.go +++ b/pkg/ssh/ssh.go @@ -162,7 +162,7 @@ func initializePermissions(ctx ssh.Context) { } } -// PublicKeyAuthHandler handles public key authentication. +// PublicKeyHandler handles public key authentication. func (s *SSHServer) PublicKeyHandler(ctx ssh.Context, pk ssh.PublicKey) (allowed bool) { if pk == nil { return false diff --git a/pkg/ui/common/component.go b/pkg/ui/common/component.go index ee81bd20100489af93c73ef0d733409862b00691..64818f0ea28168932b636970984f19f754c49a4c 100644 --- a/pkg/ui/common/component.go +++ b/pkg/ui/common/component.go @@ -13,7 +13,7 @@ type Component interface { SetSize(width, height int) } -// TabComponenet represents a model that is mounted to a tab. +// TabComponent represents a model that is mounted to a tab. // TODO: find a better name. type TabComponent interface { Component diff --git a/pkg/ui/keymap/keymap.go b/pkg/ui/keymap/keymap.go index 707a558616cec72ec85e1a07cde964e25930ce4d..883dbc9ee2f4b7f2e2013a1a1f0a489401f075d4 100644 --- a/pkg/ui/keymap/keymap.go +++ b/pkg/ui/keymap/keymap.go @@ -1,3 +1,4 @@ +// Package keymap defines key bindings and keyboard shortcuts for the TUI. package keymap import "github.com/charmbracelet/bubbles/v2/key" diff --git a/pkg/ui/pages/selection/item.go b/pkg/ui/pages/selection/item.go index 1bb24da4ab6752f225c995177602ceb4cb0c6cac..e816e5ddfc6c5acedac51b3df8589adb46f8a33f 100644 --- a/pkg/ui/pages/selection/item.go +++ b/pkg/ui/pages/selection/item.go @@ -52,7 +52,7 @@ type Item struct { cmd string } -// New creates a new Item. +// NewItem creates a new Item. func NewItem(c common.Common, repo proto.Repository) (Item, error) { var lastUpdate *time.Time lu := repo.UpdatedAt() diff --git a/testscript/script_test.go b/testscript/script_test.go index 0866d9bc6f51808e4cd2739ea6ced238d520d070..1c1e40e849937804dbfb3086c6f7c0a4e8aeb6b8 100644 --- a/testscript/script_test.go +++ b/testscript/script_test.go @@ -351,11 +351,11 @@ func check(ts *testscript.TestScript, err error, neg bool) { } } -func cmdReadfile(ts *testscript.TestScript, neg bool, args []string) { +func cmdReadfile(ts *testscript.TestScript, neg bool, args []string) { //nolint:unparam ts.Stdout().Write([]byte(ts.ReadFile(args[0]))) } -func cmdEnvfile(ts *testscript.TestScript, neg bool, args []string) { +func cmdEnvfile(ts *testscript.TestScript, neg bool, args []string) { //nolint:unparam if len(args) < 1 { ts.Fatalf("usage: envfile key=file...") } @@ -481,7 +481,7 @@ func cmdCurl(ts *testscript.TestScript, neg bool, args []string) { check(ts, cmd.Execute(), neg) } -func cmdEnsureServerRunning(ts *testscript.TestScript, neg bool, args []string) { +func cmdEnsureServerRunning(ts *testscript.TestScript, neg bool, args []string) { //nolint:unparam if len(args) < 1 { ts.Fatalf("Must supply a TCP port of one of the services to connect to. " + "These are set as env vars as they are randomized. " + @@ -507,7 +507,7 @@ func cmdEnsureServerRunning(ts *testscript.TestScript, neg bool, args []string) } } -func cmdEnsureServerNotRunning(ts *testscript.TestScript, neg bool, args []string) { +func cmdEnsureServerNotRunning(ts *testscript.TestScript, neg bool, args []string) { //nolint:unparam if len(args) < 1 { ts.Fatalf("Must supply a TCP port of one of the services to connect to. " + "These are set as env vars as they are randomized. " + @@ -533,7 +533,7 @@ func cmdEnsureServerNotRunning(ts *testscript.TestScript, neg bool, args []strin } } -func cmdStopserver(ts *testscript.TestScript, neg bool, args []string) { +func cmdStopserver(ts *testscript.TestScript, neg bool, args []string) { //nolint:unparam // stop the server resp, err := http.DefaultClient.Head(fmt.Sprintf("%s/__stop", ts.Getenv("SOFT_SERVE_HTTP_PUBLIC_URL"))) check(ts, err, neg)