Update 1.6.0

go.mod

@@ -1,13 +1,13 @@
 module github.com/Bedrock-OSS/regolith
 
-go 1.18
+go 1.25.3
 
 require (
 	github.com/Bedrock-OSS/go-burrito v1.0.3
 	github.com/alessio/shellescape v1.4.1
+	github.com/arexon/fsnotify v0.0.0-20240929211932-1ebdc44d4bc2
 	github.com/fatih/color v1.14.1
 	github.com/google/go-github/v39 v39.2.0
-	github.com/hashicorp/go-getter v1.6.2
 	github.com/muhammadmuzzammil1998/jsonc v1.0.0
 	github.com/nightlyone/lockfile v1.0.0
 	github.com/otiai10/copy v1.7.0
@@ -22,44 +22,17 @@ require (
 replace github.com/hashicorp/go-getter => github.com/arikkfir/go-getter v1.6.3-0.20220803164326-281b7670b734
 
 require (
-	cloud.google.com/go v0.100.2 // indirect
-	cloud.google.com/go/compute v1.5.0 // indirect
-	cloud.google.com/go/iam v0.3.0 // indirect
-	cloud.google.com/go/storage v1.21.0 // indirect
 	github.com/antlr/antlr4/runtime/Go/antlr/v4 v4.0.0-20221202181307-76fa05c21b12 // indirect
-	github.com/arexon/fsnotify v0.0.0-20240929211932-1ebdc44d4bc2 // indirect
-	github.com/aws/aws-sdk-go v1.43.25 // indirect
-	github.com/bgentry/go-netrc v0.0.0-20140422174119-9fd32a8b3d3d // indirect
 	github.com/gammazero/deque v0.2.1 // indirect
-	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
-	github.com/golang/protobuf v1.5.2 // indirect
-	github.com/google/go-cmp v0.5.8 // indirect
 	github.com/google/go-querystring v1.1.0 // indirect
-	github.com/googleapis/gax-go/v2 v2.2.0 // indirect
-	github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
-	github.com/hashicorp/go-safetemp v1.0.0 // indirect
-	github.com/hashicorp/go-version v1.4.0 // indirect
 	github.com/inconshreveable/mousetrap v1.0.1 // indirect
-	github.com/jmespath/go-jmespath v0.4.0 // indirect
-	github.com/klauspost/compress v1.15.1 // indirect
 	github.com/mattn/go-colorable v0.1.13 // indirect
 	github.com/mattn/go-isatty v0.0.17 // indirect
-	github.com/mitchellh/go-homedir v1.1.0 // indirect
-	github.com/mitchellh/go-testing-interface v1.14.1 // indirect
+	github.com/pkg/errors v0.9.1 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
-	github.com/ulikunitz/xz v0.5.10 // indirect
-	go.opencensus.io v0.23.0 // indirect
 	go.uber.org/atomic v1.9.0 // indirect
 	go.uber.org/multierr v1.8.0 // indirect
 	golang.org/x/crypto v0.1.0 // indirect
 	golang.org/x/exp v0.0.0-20230131013936-aae9b4e6329d // indirect
-	golang.org/x/net v0.1.0 // indirect
-	golang.org/x/oauth2 v0.0.0-20220309155454-6242fa91716a // indirect
 	golang.org/x/text v0.6.0 // indirect
-	golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect
-	google.golang.org/api v0.73.0 // indirect
-	google.golang.org/appengine v1.6.7 // indirect
-	google.golang.org/genproto v0.0.0-20220324131243-acbaeb5b85eb // indirect
-	google.golang.org/grpc v1.45.0 // indirect
-	google.golang.org/protobuf v1.28.0 // indirect
 )

main.go

@@ -335,6 +335,7 @@ func main() {
 		Long:  regolithConfigDesc,
 		Run: func(cmd *cobra.Command, args []string) {
 			regolith.InitLogging(burrito.PrintStackTrace)
+			defer regolith.ShutdownLogging()
 			full, _ := cmd.Flags().GetBool("full")
 			delete, _ := cmd.Flags().GetBool("delete")
 			append, _ := cmd.Flags().GetBool("append")

regolith/compatibility_other_os.go

@@ -30,20 +30,52 @@ func copyFileSecurityInfo(source string, target string) error {
 	return nil
 }
 
-func FindStandardMojangDir() (string, error) {
-	comMojang := os.Getenv("COM_MOJANG")
+func findSomeMojangDir(
+	comMojangWordsVar,
+	comMojangPacksVar,
+	comMojangVar,
+	comMojangEnvUnsetError string,
+	pathType ComMojangPathType,
+) (string, error) {
+	// Try specific path environment variables first
+	switch pathType {
+	case WorldPath:
+		comMojang := os.Getenv(comMojangWordsVar)
+		if comMojang != "" {
+			return comMojang, nil
+		}
+	case PacksPath:
+		comMojang := os.Getenv(comMojangPacksVar)
+		if comMojang != "" {
+			return comMojang, nil
+		}
+	}
+	// Try general environment variable
+	comMojang := os.Getenv(comMojangVar)
 	if comMojang == "" {
 		return "", burrito.WrappedError(comMojangEnvUnsetError)
 	}
 	return comMojang, nil
 }
 
-func FindPreviewDir() (string, error) {
-	comMojangPreview := os.Getenv("COM_MOJANG_PREVIEW")
-	if comMojangPreview == "" {
-		return "", burrito.WrappedError(comMojangPreviewEnvUnsetError)
-	}
-	return comMojangPreview, nil
+func FindStandardMojangDir(pathType ComMojangPathType) (string, error) {
+	return findSomeMojangDir(
+		"COM_MOJANG_WORLDS",
+		"COM_MOJANG_PACKS",
+		"COM_MOJANG",
+		comMojangEnvUnsetError,
+		pathType,
+	)
+}
+
+func FindPreviewDir(pathType ComMojangPathType) (string, error) {
+	return findSomeMojangDir(
+		"COM_MOJANG_WORLDS_PREVIEW",
+		"COM_MOJANG_PACKS_PREVIEW",
+		"COM_MOJANG_PREVIEW",
+		comMojangPreviewEnvUnsetError,
+		pathType,
+	)
 }
 
 func FindEducationDir() (string, error) {

regolith/compatibility_windows.go

@@ -53,45 +53,116 @@ func copyFileSecurityInfo(source string, target string) error {
 	return nil
 }
 
-// FindStandardMojangDir returns path to the com.mojang folder in the standard
-// Minecraft build.
-func FindStandardMojangDir() (string, error) {
-	comMojang := os.Getenv("COM_MOJANG")
+// findSomeMojangDir is reused in FindStandardMojangDir and
+// FindPreviewMojangDir functions to avoid code duplication.
+func findSomeMojangDir(
+	comMojangWordsVar string,
+	comMojangPacksVar string,
+	comMojangVar string,
+	theSomeDirName string,
+	pathType ComMojangPathType,
+) (string, error) {
+	// Try specific path environment variables first
+	switch pathType {
+	case WorldPath:
+		comMojang := os.Getenv(comMojangWordsVar)
+		if comMojang != "" {
+			return comMojang, nil
+		}
+	case PacksPath:
+		comMojang := os.Getenv(comMojangPacksVar)
+		if comMojang != "" {
+			return comMojang, nil
+		}
+	}
+	// Try general environment variable
+	comMojang := os.Getenv(comMojangVar)
 	if comMojang != "" {
 		return comMojang, nil
 	}
-	result := filepath.Join(
-		os.Getenv("LOCALAPPDATA"), "Packages",
-		"Microsoft.MinecraftUWP_8wekyb3d8bbwe", "LocalState", "games",
-		"com.mojang")
-	if _, err := os.Stat(result); err != nil {
-		if os.IsNotExist(err) {
-			return "", burrito.WrapErrorf(err, osStatErrorIsNotExist, result)
+
+	var result string
+	checkResult := func() error {
+		if _, err := os.Stat(result); err != nil {
+			if os.IsNotExist(err) {
+				return burrito.WrapErrorf(err, osStatErrorIsNotExist, result)
+			}
+			return burrito.WrapErrorf(err, osStatErrorAny, result)
 		}
-		return "", burrito.WrapErrorf(err, osStatErrorAny, result)
+		return nil
 	}
-	return result, nil
+	switch pathType {
+	case WorldPath:
+		result = filepath.Join(os.Getenv("APPDATA"), theSomeDirName, "Users")
+		if err := checkResult(); err != nil {
+			return "", burrito.PassError(err)
+		}
+		// List directories in the Users folder and pick the first one that isn't
+		// "Shared". From that folder navigate to "games/com.mojang" and validate
+		// the path.
+		entries, err := os.ReadDir(result)
+		if err != nil {
+			return "", burrito.WrapErrorf(err, osReadDirError, result)
+		}
+		var chosen string
+		for _, e := range entries {
+			if !e.IsDir() {
+				continue
+			}
+			// Skip the shared folder (case insensitive)
+			if strings.EqualFold(e.Name(), "Shared") {
+				continue
+			}
+			chosen = e.Name()
+			break
+		}
+		if chosen == "" {
+			return "", burrito.WrappedErrorf(findMojangDirError)
+		}
+		result = filepath.Join(result, chosen, "games", "com.mojang")
+		if err := checkResult(); err != nil {
+			return "", burrito.PassError(err)
+		}
+		return result, nil
+	case PacksPath:
+		result = filepath.Join(
+			os.Getenv("APPDATA"), theSomeDirName, "Users", "Shared", "games",
+			"com.mojang")
+		if err := checkResult(); err != nil {
+			return "", burrito.PassError(err)
+		}
+		return result, nil
+	}
+	// Should never happen
+	return "", burrito.WrappedErrorf("Invalid path type")
+}
+
+// FindStandardMojangDir returns path to the com.mojang folder in the standard
+// Minecraft build.
+func FindStandardMojangDir(pathType ComMojangPathType) (string, error) {
+	return findSomeMojangDir(
+		// Environment variables
+		"COM_MOJANG_WORLDS",
+		"COM_MOJANG_PACKS",
+		"COM_MOJANG",
+		// The name of the folder in APPDATA
+		"Minecraft Bedrock",
+		pathType,
+	)
 }
 
 // FindPreviewDir returns path to the com.mojang folder in the preview
 // Minecraft build.
-func FindPreviewDir() (string, error) {
-	comMojang := os.Getenv("COM_MOJANG_PREVIEW")
-	if comMojang != "" {
-		return comMojang, nil
-	}
-	result := filepath.Join(
-		os.Getenv("LOCALAPPDATA"), "Packages",
-		"Microsoft.MinecraftWindowsBeta_8wekyb3d8bbwe", "LocalState", "games",
-		"com.mojang")
-	if _, err := os.Stat(result); err != nil {
-		if os.IsNotExist(err) {
-			return "", burrito.WrapErrorf(err, osStatErrorIsNotExist, result)
-		}
-		return "", burrito.WrapErrorf(
-			err, osStatErrorAny, result)
-	}
-	return result, nil
+func FindPreviewDir(pathType ComMojangPathType) (string, error) {
+	return findSomeMojangDir(
+		// Environment variables
+		"COM_MOJANG_WORLDS_PREVIEW",
+		"COM_MOJANG_PACKS_PREVIEW",
+		"COM_MOJANG_PREVIEW",
+		// The name of the folder in APPDATA
+		"Minecraft Bedrock Preview",
+		pathType,
+	)
 }
 
 // FindEducationDir returns path to the com.mojang folder in the education
@@ -114,13 +185,15 @@ func FindEducationDir() (string, error) {
 	return result, nil
 }
 
+// CheckSuspiciousLocation checks if the current working directory is within
+// one of directories not valid for a Regolith project.
 func CheckSuspiciousLocation() error {
 	path, err := os.Getwd()
 	if err != nil {
 		return burrito.WrapErrorf(err, osGetwdError)
 	}
 	// Check if project directory is within mojang dir
-	dir, err := FindStandardMojangDir()
+	dir, err := FindStandardMojangDir(PacksPath)
 	if err == nil {
 		dir1 := filepath.Join(dir, "development_behavior_packs")
 		if isPathWithinDirectory(path, dir1) {
@@ -132,7 +205,7 @@ func CheckSuspiciousLocation() error {
 		}
 	}
 	// Check if project directory is within mojang dir
-	dir, err = FindPreviewDir()
+	dir, err = FindPreviewDir(PacksPath)
 	if err == nil {
 		dir1 := filepath.Join(dir, "development_behavior_packs")
 		if isPathWithinDirectory(path, dir1) {

regolith/config.go

@@ -18,8 +18,8 @@ const GitIgnore = "/build\n/.regolith"
 type Config struct {
 	Name            string `json:"name,omitempty"`
 	Author          string `json:"author,omitempty"`
-	Packs           `json:"packs,omitempty"`
-	RegolithProject `json:"regolith,omitempty"`
+	Packs           `json:"packs,omitzero"`
+	RegolithProject `json:"regolith,omitzero"`
 }
 
 // ExportTarget is a part of "config.json" that contains export information
@@ -55,7 +55,7 @@ type RegolithProject struct {
 }
 
 // ConfigFromObject creates a "Config" object from map[string]interface{}
-func ConfigFromObject(obj map[string]interface{}) (*Config, error) {
+func ConfigFromObject(obj map[string]any) (*Config, error) {
 	result := &Config{}
 	// Name
 	name, ok := obj["name"].(string)
@@ -71,7 +71,7 @@ func ConfigFromObject(obj map[string]interface{}) (*Config, error) {
 	result.Author = author
 	// Packs
 	if packs, ok := obj["packs"]; ok {
-		packs, ok := packs.(map[string]interface{})
+		packs, ok := packs.(map[string]any)
 		if !ok {
 			return nil, burrito.WrappedErrorf(jsonPathTypeError, "packs", "object")
 		}
@@ -82,7 +82,7 @@ func ConfigFromObject(obj map[string]interface{}) (*Config, error) {
 	}
 	// Regolith
 	if regolith, ok := obj["regolith"]; ok {
-		regolith, ok := regolith.(map[string]interface{})
+		regolith, ok := regolith.(map[string]any)
 		if !ok {
 			return nil, burrito.WrappedErrorf(
 				jsonPathTypeError, "regolith", "object")
@@ -99,7 +99,7 @@ func ConfigFromObject(obj map[string]interface{}) (*Config, error) {
 }
 
 // ProfileFromObject creates a "Profile" object from map[string]interface{}
-func PacksFromObject(obj map[string]interface{}) Packs {
+func PacksFromObject(obj map[string]any) Packs {
 	result := Packs{}
 	// BehaviorPack
 	behaviorPack, _ := obj["behaviorPack"].(string)
@@ -113,7 +113,7 @@ func PacksFromObject(obj map[string]interface{}) Packs {
 // RegolithProjectFromObject creates a "RegolithProject" object from
 // map[string]interface{}
 func RegolithProjectFromObject(
-	obj map[string]interface{},
+	obj map[string]any,
 ) (RegolithProject, error) {
 	result := RegolithProject{
 		Profiles:          make(map[string]Profile),
@@ -166,10 +166,10 @@ func RegolithProjectFromObject(
 		}
 	}
 	// Filter definitions
-	filterDefinitions, ok := obj["filterDefinitions"].(map[string]interface{})
+	filterDefinitions, ok := obj["filterDefinitions"].(map[string]any)
 	if ok { // filter definitions are optional
 		for filterDefinitionName, filterDefinition := range filterDefinitions {
-			filterDefinitionMap, ok := filterDefinition.(map[string]interface{})
+			filterDefinitionMap, ok := filterDefinition.(map[string]any)
 			if !ok {
 				return result, burrito.WrappedErrorf(
 					jsonPropertyTypeError, "filterDefinitions",
@@ -185,12 +185,12 @@ func RegolithProjectFromObject(
 		}
 	}
 	// Profiles
-	profiles, ok := obj["profiles"].(map[string]interface{})
+	profiles, ok := obj["profiles"].(map[string]any)
 	if !ok {
 		return result, burrito.WrappedErrorf(jsonPropertyMissingError, "profiles")
 	}
 	for profileName, profile := range profiles {
-		profileMap, ok := profile.(map[string]interface{})
+		profileMap, ok := profile.(map[string]any)
 		if !ok {
 			return result, burrito.WrappedErrorf(
 				jsonPropertyTypeError,
@@ -209,7 +209,7 @@ func RegolithProjectFromObject(
 
 // ExportTargetFromObject creates a "ExportTarget" object from
 // map[string]interface{}
-func ExportTargetFromObject(obj map[string]interface{}) (ExportTarget, error) {
+func ExportTargetFromObject(obj map[string]any) (ExportTarget, error) {
 	result := ExportTarget{}
 	// Target
 	targetObj, ok := obj["target"]