From bd123bc63a36a12446f2ba682e7c8897014a1e07 Mon Sep 17 00:00:00 2001 From: Justin Harms Date: Sun, 21 Sep 2025 23:10:21 -0500 Subject: [PATCH] Refactor module naming and update references to steamcache2 - Changed module name from `s1d3sw1ped/SteamCache2` to `s1d3sw1ped/steamcache2` for consistency. - Updated all import paths and references throughout the codebase to reflect the new module name. - Adjusted README and Makefile to use the updated module name, ensuring clarity in usage instructions. --- .goreleaser.yaml | 4 ++-- Makefile | 2 +- README.md | 2 +- cmd/root.go | 20 ++++++++++---------- cmd/version.go | 8 ++++---- go.mod | 2 +- main.go | 4 ++-- steamcache/steamcache.go | 18 +++++++++--------- vfs/cache/cache.go | 4 ++-- vfs/disk/disk.go | 10 ++++------ vfs/gc/gc.go | 6 +++--- vfs/memory/dynamic.go | 2 +- vfs/memory/memory.go | 4 ++-- vfs/vfs.go | 2 +- vfs/warming/warming.go | 2 +- 15 files changed, 44 insertions(+), 46 deletions(-) diff --git a/.goreleaser.yaml b/.goreleaser.yaml index 08b2a12..91de8ab 100644 --- a/.goreleaser.yaml +++ b/.goreleaser.yaml @@ -11,8 +11,8 @@ builds: - -s - -w - -extldflags "-static" - - -X s1d3sw1ped/SteamCache2/version.Version={{.Version}} - - -X s1d3sw1ped/SteamCache2/version.Date={{.Date}} + - -X s1d3sw1ped/steamcache2/version.Version={{.Version}} + - -X s1d3sw1ped/steamcache2/version.Date={{.Date}} env: - CGO_ENABLED=0 goos: diff --git a/Makefile b/Makefile index 62631a5..d664dcb 100644 --- a/Makefile +++ b/Makefile @@ -13,7 +13,7 @@ build-snapshot-single: deps test ## Build a snapshot of the application for the @goreleaser build --single-target --snapshot --clean help: ## Show this help message - @echo SteamCache2 Makefile + @echo steamcache2 Makefile @echo Available targets: @echo run Run the application @echo run-debug Run the application with debug logging diff --git a/README.md b/README.md index cae83a1..97b7434 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ SteamCache2 is a blazing fast download cache for Steam, designed to reduce bandw 1. **Clone and build:** ```bash git clone - cd SteamCache2 + cd steamcache2 make # This will run tests and build the application ``` diff --git a/cmd/root.go b/cmd/root.go index c2282ae..6e2d650 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -4,10 +4,10 @@ package cmd import ( "fmt" "os" - "s1d3sw1ped/SteamCache2/config" - "s1d3sw1ped/SteamCache2/steamcache" - "s1d3sw1ped/SteamCache2/steamcache/logger" - "s1d3sw1ped/SteamCache2/version" + "s1d3sw1ped/steamcache2/config" + "s1d3sw1ped/steamcache2/steamcache" + "s1d3sw1ped/steamcache2/steamcache/logger" + "s1d3sw1ped/steamcache2/version" "strings" "github.com/rs/zerolog" @@ -25,9 +25,9 @@ var ( ) var rootCmd = &cobra.Command{ - Use: "SteamCache2", - Short: "SteamCache2 is a caching solution for Steam game updates and installations", - Long: `SteamCache2 is a caching solution designed to optimize the delivery of Steam game updates and installations. + Use: "steamcache2", + Short: "steamcache2 is a caching solution for Steam game updates and installations", + Long: `steamcache2 is a caching solution designed to optimize the delivery of Steam game updates and installations. It reduces bandwidth usage and speeds up the download process by caching game files locally. This tool is particularly useful for environments with multiple Steam users, such as gaming cafes or households with multiple gamers. By caching game files, SteamCache2 ensures that subsequent downloads of the same files are served from the local cache, @@ -53,7 +53,7 @@ var rootCmd = &cobra.Command{ logger.Logger = zerolog.New(writer).With().Timestamp().Logger() logger.Logger.Info(). - Msg("SteamCache2 " + version.Version + " " + version.Date + " starting...") + Msg("steamcache2 " + version.Version + " " + version.Date + " starting...") // Load configuration cfg, err := config.LoadConfig(configPath) @@ -121,11 +121,11 @@ var rootCmd = &cobra.Command{ ) logger.Logger.Info(). - Msg("SteamCache2 " + version.Version + " started on " + cfg.ListenAddress) + Msg("steamcache2 " + version.Version + " started on " + cfg.ListenAddress) sc.Run() - logger.Logger.Info().Msg("SteamCache2 stopped") + logger.Logger.Info().Msg("steamcache2 stopped") os.Exit(0) }, } diff --git a/cmd/version.go b/cmd/version.go index 020146b..4c5ccc8 100644 --- a/cmd/version.go +++ b/cmd/version.go @@ -4,7 +4,7 @@ package cmd import ( "fmt" "os" - "s1d3sw1ped/SteamCache2/version" + "s1d3sw1ped/steamcache2/version" "github.com/spf13/cobra" ) @@ -12,10 +12,10 @@ import ( // versionCmd represents the version command var versionCmd = &cobra.Command{ Use: "version", - Short: "prints the version of SteamCache2", - Long: `Prints the version of SteamCache2. This command is useful for checking the version of the application.`, + Short: "prints the version of steamcache2", + Long: `Prints the version of steamcache2. This command is useful for checking the version of the application.`, Run: func(cmd *cobra.Command, args []string) { - fmt.Fprintln(os.Stderr, "SteamCache2", version.Version, version.Date) + fmt.Fprintln(os.Stderr, "steamcache2", version.Version, version.Date) }, } diff --git a/go.mod b/go.mod index c8a346c..8e9ae4b 100644 --- a/go.mod +++ b/go.mod @@ -1,4 +1,4 @@ -module s1d3sw1ped/SteamCache2 +module s1d3sw1ped/steamcache2 go 1.23.0 diff --git a/main.go b/main.go index 9396567..9c4b028 100644 --- a/main.go +++ b/main.go @@ -2,8 +2,8 @@ package main import ( - "s1d3sw1ped/SteamCache2/cmd" - _ "s1d3sw1ped/SteamCache2/version" // Import the version package for global version variable + "s1d3sw1ped/steamcache2/cmd" + _ "s1d3sw1ped/steamcache2/version" // Import the version package for global version variable ) func main() { diff --git a/steamcache/steamcache.go b/steamcache/steamcache.go index d0f05ea..99b6f5c 100644 --- a/steamcache/steamcache.go +++ b/steamcache/steamcache.go @@ -13,15 +13,15 @@ import ( "net/url" "os" "regexp" - "s1d3sw1ped/SteamCache2/steamcache/logger" - "s1d3sw1ped/SteamCache2/vfs" - "s1d3sw1ped/SteamCache2/vfs/adaptive" - "s1d3sw1ped/SteamCache2/vfs/cache" - "s1d3sw1ped/SteamCache2/vfs/disk" - "s1d3sw1ped/SteamCache2/vfs/gc" - "s1d3sw1ped/SteamCache2/vfs/memory" - "s1d3sw1ped/SteamCache2/vfs/predictive" - "s1d3sw1ped/SteamCache2/vfs/warming" + "s1d3sw1ped/steamcache2/steamcache/logger" + "s1d3sw1ped/steamcache2/vfs" + "s1d3sw1ped/steamcache2/vfs/adaptive" + "s1d3sw1ped/steamcache2/vfs/cache" + "s1d3sw1ped/steamcache2/vfs/disk" + "s1d3sw1ped/steamcache2/vfs/gc" + "s1d3sw1ped/steamcache2/vfs/memory" + "s1d3sw1ped/steamcache2/vfs/predictive" + "s1d3sw1ped/steamcache2/vfs/warming" "strconv" "strings" "sync" diff --git a/vfs/cache/cache.go b/vfs/cache/cache.go index 0a1fd00..9348163 100644 --- a/vfs/cache/cache.go +++ b/vfs/cache/cache.go @@ -3,8 +3,8 @@ package cache import ( "io" - "s1d3sw1ped/SteamCache2/vfs" - "s1d3sw1ped/SteamCache2/vfs/vfserror" + "s1d3sw1ped/steamcache2/vfs" + "s1d3sw1ped/steamcache2/vfs/vfserror" "sync" "sync/atomic" ) diff --git a/vfs/disk/disk.go b/vfs/disk/disk.go index 2391680..04dc4e3 100644 --- a/vfs/disk/disk.go +++ b/vfs/disk/disk.go @@ -7,9 +7,9 @@ import ( "io" "os" "path/filepath" - "s1d3sw1ped/SteamCache2/steamcache/logger" - "s1d3sw1ped/SteamCache2/vfs" - "s1d3sw1ped/SteamCache2/vfs/vfserror" + "s1d3sw1ped/steamcache2/steamcache/logger" + "s1d3sw1ped/steamcache2/vfs" + "s1d3sw1ped/steamcache2/vfs/vfserror" "sort" "strings" "sync" @@ -186,9 +186,7 @@ func (d *DiskFS) init() { // Extract key from sharded path: remove root and convert sharding back // Handle both "./disk" and "disk" root paths rootPath := d.root - if strings.HasPrefix(rootPath, "./") { - rootPath = rootPath[2:] // Remove "./" prefix - } + rootPath = strings.TrimPrefix(rootPath, "./") relPath := strings.ReplaceAll(npath[len(rootPath)+1:], "\\", "/") // Extract the original key from the sharded path diff --git a/vfs/gc/gc.go b/vfs/gc/gc.go index d14b1f5..8cd4ee9 100644 --- a/vfs/gc/gc.go +++ b/vfs/gc/gc.go @@ -4,9 +4,9 @@ package gc import ( "context" "io" - "s1d3sw1ped/SteamCache2/vfs" - "s1d3sw1ped/SteamCache2/vfs/disk" - "s1d3sw1ped/SteamCache2/vfs/memory" + "s1d3sw1ped/steamcache2/vfs" + "s1d3sw1ped/steamcache2/vfs/disk" + "s1d3sw1ped/steamcache2/vfs/memory" "sync" "sync/atomic" "time" diff --git a/vfs/memory/dynamic.go b/vfs/memory/dynamic.go index a20299a..eb41a5c 100644 --- a/vfs/memory/dynamic.go +++ b/vfs/memory/dynamic.go @@ -1,7 +1,7 @@ package memory import ( - "s1d3sw1ped/SteamCache2/vfs" + "s1d3sw1ped/steamcache2/vfs" "sync" "sync/atomic" "time" diff --git a/vfs/memory/memory.go b/vfs/memory/memory.go index e736542..9234bb3 100644 --- a/vfs/memory/memory.go +++ b/vfs/memory/memory.go @@ -5,8 +5,8 @@ import ( "bytes" "container/list" "io" - "s1d3sw1ped/SteamCache2/vfs/types" - "s1d3sw1ped/SteamCache2/vfs/vfserror" + "s1d3sw1ped/steamcache2/vfs/types" + "s1d3sw1ped/steamcache2/vfs/vfserror" "sort" "strings" "sync" diff --git a/vfs/vfs.go b/vfs/vfs.go index 1838b47..4aaa82c 100644 --- a/vfs/vfs.go +++ b/vfs/vfs.go @@ -3,7 +3,7 @@ package vfs import ( "io" - "s1d3sw1ped/SteamCache2/vfs/types" + "s1d3sw1ped/steamcache2/vfs/types" ) // VFS defines the interface for virtual file systems diff --git a/vfs/warming/warming.go b/vfs/warming/warming.go index 13deca8..482f7e5 100644 --- a/vfs/warming/warming.go +++ b/vfs/warming/warming.go @@ -2,7 +2,7 @@ package warming import ( "context" - "s1d3sw1ped/SteamCache2/vfs" + "s1d3sw1ped/steamcache2/vfs" "sync" "sync/atomic" "time"