1.8.0

CREDITS.csv

@@ -22,6 +22,6 @@ go.uber.org/zap,https://github.com/uber-go/zap/blob/v1.23.0/LICENSE.txt,MIT
 golang.org/x/crypto,https://cs.opensource.google/go/x/crypto/+/v0.1.0:LICENSE,BSD-3-Clause
 golang.org/x/exp,https://cs.opensource.google/go/x/exp/+/aae9b4e6:LICENSE,BSD-3-Clause
 golang.org/x/mod/semver,https://cs.opensource.google/go/x/mod/+/v0.6.0:LICENSE,BSD-3-Clause
-golang.org/x/sync,https://cs.opensource.google/go/x/sync/+/v0.8.0:LICENSE,BSD-3-Clause
+golang.org/x/sync,https://cs.opensource.google/go/x/sync/+/v0.20.0:LICENSE,BSD-3-Clause
 golang.org/x/sys/unix,https://cs.opensource.google/go/x/sys/+/v0.24.0:LICENSE,BSD-3-Clause
 golang.org/x/text,https://cs.opensource.google/go/x/text/+/v0.6.0:LICENSE,BSD-3-Clause

go.mod

@@ -37,6 +37,6 @@ require (
 	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/sync v0.8.0 // indirect
+	golang.org/x/sync v0.20.0 // indirect
 	golang.org/x/text v0.6.0 // indirect
 )

go.sum

@@ -81,6 +81,8 @@ golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v
 golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U=
 golang.org/x/sync v0.8.0 h1:3NFvSEYkUoMifnESzZl15y791HH1qU2xm6eCJU5ZPXQ=
 golang.org/x/sync v0.8.0/go.mod h1:Czt+wKu1gCyEFDUtn0jG5QVvpJ6rzVqr5aXyt9drQfk=
+golang.org/x/sync v0.20.0 h1:e0PTpb7pjO8GAtTs2dQ6jYa5BWYlMuX047Dco/pItO4=
+golang.org/x/sync v0.20.0/go.mod h1:9xrNwdLfx4jkKbNva9FpL6vEN7evnE43NNNJQ2LF3+0=
 golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
 golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
 golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=

main.go

@@ -3,7 +3,6 @@ package main
 import (
 	"fmt"
 	"os"
-	"strings"
 
 	"github.com/Bedrock-OSS/go-burrito/burrito"
 	"github.com/stirante/go-simple-eval/eval"
@@ -148,12 +147,14 @@ The behavior of the command changes based on the used flags and the number of pr
 The cheatsheet below shows the possible combinations of flags and arguments and what they do:
 
 Printing all properties:                        regolith config
-Printing specified property:                    regolith config <key>
-Setting property value:                         regolith config <key> <value>
-Deleting a property:                            regolith config <key> --delete
-Appending to a list property:                   regolith config <key> <value> --append
-Replacing item in a list property:              regolith config <key> <value> --index <index>
-Deleting item in a list property:               regolith config <key> --index <index> --delete
+Printing specified property:                    regolith config <setting>
+Setting property value:                         regolith config <setting> <value>
+Deleting a property:                            regolith config <setting> --delete
+Appending to a list property:                   regolith config <setting> <value> --append
+Replacing item in a list property:              regolith config <setting> <value> --index <index>
+Deleting item in a list property:               regolith config <setting> --index <index> --delete
+Setting a value in a map property:             	regolith config <setting> <key> <value>
+Deleting a value in a map property:            	regolith config <setting> <key> --delete
 
 The printing commands can take the --full flag to print configuration with the default values
 included (if they're not defined in the config file). Without the flag, the undefined properties
@@ -226,6 +227,7 @@ func main() {
 	rootCmd.PersistentFlags().StringVar(&envFile, "env", "", "Path to a custom .env file to load")
 
 	var force bool
+	forceDesc := "Force the operation, overriding potential safeguards."
 	// regolith init
 	cmdInit := &cobra.Command{
 		Use:   "init",
@@ -237,10 +239,13 @@ func main() {
 		},
 	}
 	cmdInit.Flags().BoolVarP(
-		&force, "force", "f", false, "Force the operation, overriding potential safeguards.")
+		&force, "force", "f", false, forceDesc)
 	subcommands = append(subcommands, cmdInit)
 
 	profiles := []string{}
+	// Messages for common flags in 'regolith install' and 'regolith install-all'
+	forceFilterRefreshDesc := "Force filter cache refresh."
+
 	// regolith install
 	var update, resolverRefresh, filterRefresh bool
 	cmdInstall := &cobra.Command{
@@ -260,11 +265,11 @@ func main() {
 		},
 	}
 	cmdInstall.Flags().BoolVarP(
-		&force, "force", "f", false, "Force the operation, overriding potential safeguards.")
+		&force, "force", "f", false, forceDesc)
 	cmdInstall.Flags().BoolVar(
 		&resolverRefresh, "force-resolver-refresh", false, "Force resolvers refresh.")
 	cmdInstall.Flags().BoolVar(
-		&filterRefresh, "force-filter-refresh", false, "Force filter cache refresh.")
+		&filterRefresh, "force-filter-refresh", false, forceFilterRefreshDesc)
 	cmdInstall.Flags().BoolVarP(
 		&force, "update", "u", false, "An alias for --force flag. Use this flag to update filters.")
 	cmdInstall.Flags().StringSliceVarP(&profiles, "profile", "p", profiles, "Adds installed filters to the specified profiles. If no profile is provided, the filter will be added to the default profile.")
@@ -282,14 +287,20 @@ func main() {
 		},
 	}
 	cmdInstallAll.Flags().BoolVarP(
-		&force, "force", "f", false, "Force the operation, overriding potential safeguards.")
+		&force, "force", "f", false, forceDesc)
 	cmdInstallAll.Flags().BoolVarP(
 		&update, "update", "u", false, "Updates the remote filters to the latest stable version available.")
 	cmdInstallAll.Flags().BoolVar(
-		&filterRefresh, "force-filter-refresh", false, "Force filter cache refresh.")
+		&filterRefresh, "force-filter-refresh", false, forceFilterRefreshDesc)
 	subcommands = append(subcommands, cmdInstallAll)
 
+	// Messages for common flags in 'regolith run' and 'regolith watch'
+	unsafeDesc := "Disables file protection safety checks for faster exports."
+	symlinkExportDesc := "Creates links from the tmp directory to the export target so that files written to tmp are immediately reflected in the export location."
+	disableSizeTimeCheckDesc := "Disables the size and modification time check optimization for file exporting."
+
 	// regolith run
+	var symlinkExport, disableSizeTimeCheck bool
 	cmdRun := &cobra.Command{
 		Use:   "run [profile_name]",
 		Short: "Runs Regolith using specified profile",
@@ -302,9 +313,15 @@ func main() {
 				extraFilterArgs = args[1:]
 			}
 			env, _ := cmd.Flags().GetString("env")
-			err = regolith.Run(profile, extraFilterArgs, burrito.PrintStackTrace, env)
+			unsafe, _ := cmd.Flags().GetBool("unsafe")
+			symlink, _ := cmd.Flags().GetBool("symlink-export")
+			disableStc, _ := cmd.Flags().GetBool("disable-size-time-check")
+			err = regolith.Run(profile, extraFilterArgs, burrito.PrintStackTrace, env, unsafe, symlink, disableStc)
 		},
 	}
+	cmdRun.Flags().Bool("unsafe", false, unsafeDesc)
+	cmdRun.Flags().BoolVar(&symlinkExport, "symlink-export", false, symlinkExportDesc)
+	cmdRun.Flags().BoolVar(&disableSizeTimeCheck, "disable-size-time-check", false, disableSizeTimeCheckDesc)
 	subcommands = append(subcommands, cmdRun)
 
 	// regolith watch
@@ -320,9 +337,15 @@ func main() {
 				extraFilterArgs = args[1:]
 			}
 			env, _ := cmd.Flags().GetString("env")
-			err = regolith.Watch(profile, extraFilterArgs, burrito.PrintStackTrace, env)
+			unsafe, _ := cmd.Flags().GetBool("unsafe")
+			symlink, _ := cmd.Flags().GetBool("symlink-export")
+			disableStc, _ := cmd.Flags().GetBool("disable-size-time-check")
+			err = regolith.Watch(profile, extraFilterArgs, burrito.PrintStackTrace, env, unsafe, symlink, disableStc)
 		},
 	}
+	cmdWatch.Flags().Bool("unsafe", false, unsafeDesc)
+	cmdWatch.Flags().BoolVar(&symlinkExport, "symlink-export", false, symlinkExportDesc)
+	cmdWatch.Flags().BoolVar(&disableSizeTimeCheck, "disable-size-time-check", false, disableSizeTimeCheckDesc)
 	subcommands = append(subcommands, cmdWatch)
 
 	// regolith apply-filter
@@ -394,20 +417,20 @@ func main() {
 	}
 	subcommands = append(subcommands, cmdUpdateResolvers)
 
-	// Generate the description for the experiments
-	experimentDescs := make([]string, len(regolith.AvailableExperiments))
-	for i, experiment := range regolith.AvailableExperiments {
-		experimentDescs[i] = "- " + experiment.Name + " - " + strings.Trim(experiment.Description, "\n")
-	}
+	// // Generate the description for the experiments
+	// experimentDescs := make([]string, len(regolith.AvailableExperiments))
+	// for i, experiment := range regolith.AvailableExperiments {
+	// 	experimentDescs[i] = "- " + experiment.Name + " - " + strings.Trim(experiment.Description, "\n")
+	// }
 
 	// add --debug, --timings and --experiment flag to every command
 	for _, cmd := range subcommands {
 		cmd.Flags().BoolVarP(&burrito.PrintStackTrace, "debug", "", false, "Enables debugging")
 		cmd.Flags().BoolVarP(&regolith.EnableTimings, "timings", "", false, "Enables timing information")
-		cmd.Flags().StringSliceVar(
-			&regolith.EnabledExperiments, "experiments", nil,
-			"Enables experimental features. Currently supported experiments:\n"+
-				strings.Join(experimentDescs, "\n"))
+		// cmd.Flags().StringSliceVar(
+		// 	&regolith.EnabledExperiments, "experiments", nil,
+		// 	"Enables experimental features. Currently supported experiments:\n"+
+		// 		strings.Join(experimentDescs, "\n"))
 	}
 
 	// Build and run CLI

regolith/config.go

@@ -1,13 +1,14 @@
 package regolith
 
 import (
+	"encoding/json"
 	"fmt"
 
 	"github.com/Bedrock-OSS/go-burrito/burrito"
 	"golang.org/x/mod/semver"
 )
 
-const latestCompatibleVersion = "1.7.0"
+const latestCompatibleVersion = "1.8.0"
 
 const StandardLibraryUrl = "github.com/Bedrock-OSS/regolith-filters"
 const ConfigFilePath = "config.json"
@@ -37,6 +38,37 @@ type ExportTarget struct {
 	Build     string `json:"build,omitempty"` // The type of Minecraft build for the 'develop'
 }
 
+// ExportTargets is the config representation of a profile's "export" value.
+// It accepts both the single-object form and the multi-target array
+// form. When marshaling, a single target is written as an object to keep newly
+// generated configs backward compatible with older Regolith versions.
+type ExportTargets []ExportTarget
+
+// IsZero lets json:",omitzero" omit an unset target list.
+func (et ExportTargets) IsZero() bool {
+	return len(et) == 0
+}
+
+func (et ExportTargets) MarshalJSON() ([]byte, error) {
+	if len(et) == 1 {
+		return json.Marshal(et[0])
+	}
+	return json.Marshal([]ExportTarget(et))
+}
+
+func (et *ExportTargets) UnmarshalJSON(data []byte) error {
+	var raw any
+	if err := json.Unmarshal(data, &raw); err != nil {
+		return err
+	}
+	targets, err := ExportTargetsFromObject(raw)
+	if err != nil {
+		return err
+	}
+	*et = targets
+	return nil
+}
+
 // Packs is a part of "config.json" that points to the source behavior and
 // resource packs.
 type Packs struct {
@@ -176,7 +208,7 @@ func RegolithProjectFromObject(
 					"object")
 			}
 			filterInstaller, err := FilterInstallerFromObject(
-				filterDefinitionName, filterDefinitionMap)
+				filterDefinitionName, filterDefinitionName, filterDefinitionMap)
 			if err != nil {
 				return result, burrito.WrapErrorf(
 					err, jsonPropertyParseError, "filterDefinitions")
@@ -207,6 +239,42 @@ func RegolithProjectFromObject(
 	return result, nil
 }
 
+// ExportTargetsFromObject parses the "export" value which can be either a
+// single object (backward compatible) or an array of objects.
+func ExportTargetsFromObject(exportValue any) (ExportTargets, error) {
+	switch v := exportValue.(type) {
+	case map[string]any:
+		et, err := ExportTargetFromObject(v)
+		if err != nil {
+			return nil, burrito.WrapErrorf(err, jsonPropertyParseError, "export")
+		}
+		return ExportTargets{et}, nil
+	case []any:
+		if len(v) == 0 {
+			return nil, burrito.WrappedErrorf(
+				"The \"export\" array must contain at least one entry")
+		}
+		targets := make(ExportTargets, 0, len(v))
+		for i, item := range v {
+			obj, ok := item.(map[string]any)
+			if !ok {
+				return nil, burrito.WrappedErrorf(
+					jsonPathTypeError, fmt.Sprintf("export->%d", i), "object")
+			}
+			et, err := ExportTargetFromObject(obj)
+			if err != nil {
+				return nil, burrito.WrapErrorf(
+					err, jsonPropertyParseError, fmt.Sprintf("export->%d", i))
+			}
+			targets = append(targets, et)
+		}
+		return targets, nil
+	default:
+		return nil, burrito.WrappedErrorf(
+			jsonPropertyTypeError, "export", "object or array")
+	}
+}
+
 // ExportTargetFromObject creates a "ExportTarget" object from
 // map[string]interface{}
 func ExportTargetFromObject(obj map[string]any) (ExportTarget, error) {

regolith/errors.go

@@ -194,7 +194,7 @@ const (
 	// Error used on attempt to access user config property that is not known
 	// to Regolith.
 	invalidUserConfigPropertyError = "Invalid user configuration property:\n" +
-		"Property name: %s\n"
+		"Property name: %s"
 
 	// Error used when the getGlobalUserConfigPath function fails
 	getGlobalUserConfigPathError = "Failed to get global user_config.json path"
@@ -259,6 +259,8 @@ const (
 		"Resource pack export path: %s\n" +
 		"Behavior pack export path: %s"
 
+	updatedFilesUpdateError = "Failed to create a list of files edited by Regolith."
+
 	updatedFilesDumpError = "Failed to update the list of the files edited by Regolith." +
 		"This may cause the next run to fail."
 
@@ -268,4 +270,16 @@ const (
 
 	loadEnvFileFromArgError = "Failed to the file with environment variables:\n" +
 		"File path: %s"
+
+	getAbsoluteWorkingDirectoryError = "Failed to get the absolute path of the working directory for filter execution."
+
+	// userSettingIncorrectIndexUseError is used when the user tries to use the --index flag with a non-array property
+	// when changing the user settings.
+	userSettingIncorrectIndexUseError = "Cannot use --index with non-array property."
+
+	// userSettingIncorrectKeyUseError is used when the user tries to use the --key flag with a non-map property
+	// when changing the user settings.
+	userSettingIncorrectKeyUseError = "Cannot use <key> with non-map property."
+
+	getRunnerError = "Failed to get the path to filter runner."
 )

regolith/experiments.go

@@ -4,36 +4,12 @@ import "slices"
 
 type Experiment int
 
-const (
-	// SizeTimeCheck is an experiment that checks the size and modification time when exporting
-	SizeTimeCheck Experiment = iota
-	// SymlinkExport links the temporary build directory with the export
-	// target using hard links when possible.
-	SymlinkExport
-)
-
-// The descriptions shouldn't be too wide, the text with their description is
-// indented a lot.
-const sizeTimeCheckDesc = `
-Activates optimization for file exporting by checking the size and
-modification time of files before exporting, and only exporting if
-the file has changed. This experiment applies to 'run' and 'watch'
-commands.
-`
-
-const symlinkExportDesc = `
-Creates links from the tmp directory to the export target so that files
-written to tmp are immediately reflected in the export location.`
-
 type ExperimentInfo struct {
 	Name        string
 	Description string
 }
 
-var AvailableExperiments = map[Experiment]ExperimentInfo{
-	SizeTimeCheck: {"size_time_check", sizeTimeCheckDesc},
-	SymlinkExport: {"symlink_export", symlinkExportDesc},
-}
+var AvailableExperiments = map[Experiment]ExperimentInfo{}
 
 var EnabledExperiments []string