refactor: change "config" -> settings

The name "config" for the settings for `nixos-cli` is rather confusing. Change it to `settings`
water-sucks · Feb 22, 2025 · 0f2b0d9 · 0f2b0d9
1 parent 3e6af52
commit 0f2b0d9
Show file tree

Hide file tree

Showing 22 changed files with 121 additions and 121 deletions.
diff --git a/cmd/apply/apply.go b/cmd/apply/apply.go
@@ -13,16 +13,16 @@ import (
 	"github.com/water-sucks/nixos/internal/cmd/nixopts"
 	cmdTypes "github.com/water-sucks/nixos/internal/cmd/types"
 	cmdUtils "github.com/water-sucks/nixos/internal/cmd/utils"
-	"github.com/water-sucks/nixos/internal/config"
 	"github.com/water-sucks/nixos/internal/configuration"
 	"github.com/water-sucks/nixos/internal/constants"
 	"github.com/water-sucks/nixos/internal/generation"
 	"github.com/water-sucks/nixos/internal/logger"
+	"github.com/water-sucks/nixos/internal/settings"
 	"github.com/water-sucks/nixos/internal/system"
 	"github.com/water-sucks/nixos/internal/utils"
 )
 
-func ApplyCommand(cfg *config.Config) *cobra.Command {
+func ApplyCommand(cfg *settings.Settings) *cobra.Command {
 	opts := cmdTypes.ApplyOpts{}
 
 	usage := "apply"
@@ -144,7 +144,7 @@ Check the Nix manual page for more details on what options are available.
 
 func applyMain(cmd *cobra.Command, opts *cmdTypes.ApplyOpts) error {
 	log := logger.FromContext(cmd.Context())
-	cfg := config.FromContext(cmd.Context())
+	cfg := settings.FromContext(cmd.Context())
 	s := system.NewLocalSystem()
 
 	if !s.IsNixOS() {

diff --git a/cmd/enter/enter.go b/cmd/enter/enter.go
@@ -11,9 +11,9 @@ import (
 
 	cmdTypes "github.com/water-sucks/nixos/internal/cmd/types"
 	cmdUtils "github.com/water-sucks/nixos/internal/cmd/utils"
-	"github.com/water-sucks/nixos/internal/config"
 	"github.com/water-sucks/nixos/internal/constants"
 	"github.com/water-sucks/nixos/internal/logger"
+	"github.com/water-sucks/nixos/internal/settings"
 	"github.com/water-sucks/nixos/internal/system"
 )
 
@@ -58,7 +58,7 @@ double dash (--) is required. Otherwise, unexpected behavior may occur.
 
 func enterMain(cmd *cobra.Command, opts *cmdTypes.EnterOpts) error {
 	log := logger.FromContext(cmd.Context())
-	cfg := config.FromContext(cmd.Context())
+	cfg := settings.FromContext(cmd.Context())
 
 	nixosMarker := filepath.Join(opts.RootLocation, constants.NixOSMarker)
 	if _, err := os.Stat(nixosMarker); err != nil {

diff --git a/cmd/generation/delete/delete.go b/cmd/generation/delete/delete.go
@@ -14,10 +14,10 @@ import (
 	buildOpts "github.com/water-sucks/nixos/internal/build"
 	cmdTypes "github.com/water-sucks/nixos/internal/cmd/types"
 	cmdUtils "github.com/water-sucks/nixos/internal/cmd/utils"
-	"github.com/water-sucks/nixos/internal/config"
 	"github.com/water-sucks/nixos/internal/constants"
 	"github.com/water-sucks/nixos/internal/generation"
 	"github.com/water-sucks/nixos/internal/logger"
+	"github.com/water-sucks/nixos/internal/settings"
 	"github.com/water-sucks/nixos/internal/system"
 	timeUtils "github.com/water-sucks/nixos/internal/time"
 	"github.com/water-sucks/nixos/internal/utils"
@@ -120,7 +120,7 @@ The 'period' parameter in --older-than is a systemd.time(7) span
 
 func generationDeleteMain(cmd *cobra.Command, genOpts *cmdTypes.GenerationOpts, opts *cmdTypes.GenerationDeleteOpts) error {
 	log := logger.FromContext(cmd.Context())
-	cfg := config.FromContext(cmd.Context())
+	cfg := settings.FromContext(cmd.Context())
 	s := system.NewLocalSystem()
 
 	if !s.IsNixOS() {

diff --git a/cmd/generation/diff/diff.go b/cmd/generation/diff/diff.go
@@ -9,10 +9,10 @@ import (
 
 	cmdTypes "github.com/water-sucks/nixos/internal/cmd/types"
 	cmdUtils "github.com/water-sucks/nixos/internal/cmd/utils"
-	"github.com/water-sucks/nixos/internal/config"
 	"github.com/water-sucks/nixos/internal/constants"
 	"github.com/water-sucks/nixos/internal/generation"
 	"github.com/water-sucks/nixos/internal/logger"
+	"github.com/water-sucks/nixos/internal/settings"
 	"github.com/water-sucks/nixos/internal/system"
 )
 
@@ -62,7 +62,7 @@ Arguments:
 
 func generationDiffMain(cmd *cobra.Command, genOpts *cmdTypes.GenerationOpts, opts *cmdTypes.GenerationDiffOpts) error {
 	log := logger.FromContext(cmd.Context())
-	cfg := config.FromContext(cmd.Context())
+	cfg := settings.FromContext(cmd.Context())
 	s := system.NewLocalSystem()
 
 	profileDirectory := constants.NixProfileDirectory

diff --git a/cmd/generation/rollback/rollback.go b/cmd/generation/rollback/rollback.go
@@ -12,10 +12,10 @@ import (
 	"github.com/water-sucks/nixos/internal/activation"
 	cmdTypes "github.com/water-sucks/nixos/internal/cmd/types"
 	cmdUtils "github.com/water-sucks/nixos/internal/cmd/utils"
-	"github.com/water-sucks/nixos/internal/config"
 	"github.com/water-sucks/nixos/internal/constants"
 	"github.com/water-sucks/nixos/internal/generation"
 	"github.com/water-sucks/nixos/internal/logger"
+	"github.com/water-sucks/nixos/internal/settings"
 	"github.com/water-sucks/nixos/internal/system"
 	"github.com/water-sucks/nixos/internal/utils"
 )
@@ -44,7 +44,7 @@ func GenerationRollbackCommand(genOpts *cmdTypes.GenerationOpts) *cobra.Command
 
 func generationRollbackMain(cmd *cobra.Command, genOpts *cmdTypes.GenerationOpts, opts *cmdTypes.GenerationRollbackOpts) error {
 	log := logger.FromContext(cmd.Context())
-	cfg := config.FromContext(cmd.Context())
+	cfg := settings.FromContext(cmd.Context())
 	s := system.NewLocalSystem()
 
 	if os.Geteuid() != 0 {

diff --git a/cmd/generation/switch/switch.go b/cmd/generation/switch/switch.go
@@ -11,10 +11,10 @@ import (
 	"github.com/water-sucks/nixos/internal/activation"
 	cmdTypes "github.com/water-sucks/nixos/internal/cmd/types"
 	cmdUtils "github.com/water-sucks/nixos/internal/cmd/utils"
-	"github.com/water-sucks/nixos/internal/config"
 	"github.com/water-sucks/nixos/internal/constants"
 	"github.com/water-sucks/nixos/internal/generation"
 	"github.com/water-sucks/nixos/internal/logger"
+	"github.com/water-sucks/nixos/internal/settings"
 	"github.com/water-sucks/nixos/internal/system"
 	"github.com/water-sucks/nixos/internal/utils"
 )
@@ -62,7 +62,7 @@ Arguments:
 
 func generationSwitchMain(cmd *cobra.Command, genOpts *cmdTypes.GenerationOpts, opts *cmdTypes.GenerationSwitchOpts) error {
 	log := logger.FromContext(cmd.Context())
-	cfg := config.FromContext(cmd.Context())
+	cfg := settings.FromContext(cmd.Context())
 	s := system.NewLocalSystem()
 
 	if os.Geteuid() != 0 {

diff --git a/cmd/init/generate.go b/cmd/init/generate.go
@@ -10,8 +10,8 @@ import (
 
 	buildOpts "github.com/water-sucks/nixos/internal/build"
 	cmdTypes "github.com/water-sucks/nixos/internal/cmd/types"
-	"github.com/water-sucks/nixos/internal/config"
 	"github.com/water-sucks/nixos/internal/logger"
+	"github.com/water-sucks/nixos/internal/settings"
 	"github.com/water-sucks/nixos/internal/system"
 )
 
@@ -24,7 +24,7 @@ var configurationNixTemplate string
 //go:embed flake.nix.txt
 var flakeNixTemplate string
 
-func generateHwConfigNix(s system.CommandRunner, log *logger.Logger, cfg *config.Config, virtType VirtualisationType, opts *cmdTypes.InitOpts) (string, error) {
+func generateHwConfigNix(s system.CommandRunner, log *logger.Logger, cfg *settings.Settings, virtType VirtualisationType, opts *cmdTypes.InitOpts) (string, error) {
 	imports := []string{}
 	initrdAvailableModules := []string{}
 	initrdModules := []string{}
@@ -169,7 +169,7 @@ func generateHwConfigNix(s system.CommandRunner, log *logger.Logger, cfg *config
 	), nil
 }
 
-func generateConfigNix(log *logger.Logger, cfg *config.Config, virtType VirtualisationType) (string, error) {
+func generateConfigNix(log *logger.Logger, cfg *settings.Settings, virtType VirtualisationType) (string, error) {
 	var bootloaderConfig string
 
 	if _, err := os.Stat("/sys/firmware/efi/efivars"); err == nil {

diff --git a/cmd/init/init.go b/cmd/init/init.go
@@ -9,8 +9,8 @@ import (
 	buildOpts "github.com/water-sucks/nixos/internal/build"
 	cmdTypes "github.com/water-sucks/nixos/internal/cmd/types"
 	cmdUtils "github.com/water-sucks/nixos/internal/cmd/utils"
-	"github.com/water-sucks/nixos/internal/config"
 	"github.com/water-sucks/nixos/internal/logger"
+	"github.com/water-sucks/nixos/internal/settings"
 	"github.com/water-sucks/nixos/internal/system"
 )
 
@@ -45,7 +45,7 @@ func InitCommand() *cobra.Command {
 
 func initMain(cmd *cobra.Command, opts *cmdTypes.InitOpts) error {
 	log := logger.FromContext(cmd.Context())
-	cfg := config.FromContext(cmd.Context())
+	cfg := settings.FromContext(cmd.Context())
 	s := system.NewLocalSystem()
 
 	virtType := determineVirtualisationType(s, log)

diff --git a/cmd/option/completion.go b/cmd/option/completion.go
@@ -6,14 +6,14 @@ import (
 
 	"github.com/spf13/cobra"
 	cmdTypes "github.com/water-sucks/nixos/internal/cmd/types"
-	"github.com/water-sucks/nixos/internal/config"
 	"github.com/water-sucks/nixos/internal/configuration"
 	"github.com/water-sucks/nixos/internal/logger"
 	"github.com/water-sucks/nixos/internal/option"
+	"github.com/water-sucks/nixos/internal/settings"
 	"github.com/water-sucks/nixos/internal/system"
 )
 
-func loadOptions(log *logger.Logger, cfg *config.Config, includes []string) (option.NixosOptionSource, error) {
+func loadOptions(log *logger.Logger, cfg *settings.Settings, includes []string) (option.NixosOptionSource, error) {
 	s := system.NewLocalSystem()
 
 	nixosConfig, err := configuration.FindConfiguration(log, cfg, includes, false)
@@ -53,7 +53,7 @@ func loadOptions(log *logger.Logger, cfg *config.Config, includes []string) (opt
 func OptionsCompletionFunc(opts *cmdTypes.OptionOpts) cmdTypes.CompletionFunc {
 	return func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) {
 		log := logger.FromContext(cmd.Context())
-		cfg := config.FromContext(cmd.Context())
+		cfg := settings.FromContext(cmd.Context())
 
 		if len(args) != 0 {
 			return []string{}, cobra.ShellCompDirectiveNoFileComp

diff --git a/cmd/option/option.go b/cmd/option/option.go
@@ -15,10 +15,10 @@ import (
 	"github.com/water-sucks/nixos/internal/cmd/nixopts"
 	cmdTypes "github.com/water-sucks/nixos/internal/cmd/types"
 	cmdUtils "github.com/water-sucks/nixos/internal/cmd/utils"
-	"github.com/water-sucks/nixos/internal/config"
 	"github.com/water-sucks/nixos/internal/configuration"
 	"github.com/water-sucks/nixos/internal/logger"
 	"github.com/water-sucks/nixos/internal/option"
+	"github.com/water-sucks/nixos/internal/settings"
 	"github.com/water-sucks/nixos/internal/system"
 )
 
@@ -71,7 +71,7 @@ Arguments:
 
 func optionMain(cmd *cobra.Command, opts *cmdTypes.OptionOpts) error {
 	log := logger.FromContext(cmd.Context())
-	cfg := config.FromContext(cmd.Context())
+	cfg := settings.FromContext(cmd.Context())
 	s := system.NewLocalSystem()
 
 	minScore := cfg.Option.MinScore

diff --git a/cmd/repl/repl.go b/cmd/repl/repl.go
@@ -11,9 +11,9 @@ import (
 	"github.com/water-sucks/nixos/internal/cmd/nixopts"
 	cmdTypes "github.com/water-sucks/nixos/internal/cmd/types"
 	cmdUtils "github.com/water-sucks/nixos/internal/cmd/utils"
-	"github.com/water-sucks/nixos/internal/config"
 	"github.com/water-sucks/nixos/internal/configuration"
 	"github.com/water-sucks/nixos/internal/logger"
+	"github.com/water-sucks/nixos/internal/settings"
 
 	buildOpts "github.com/water-sucks/nixos/internal/build"
 )
@@ -121,7 +121,7 @@ Use %s to see all available repl commands.
 
 func replMain(cmd *cobra.Command, opts *cmdTypes.ReplOpts) error {
 	log := logger.FromContext(cmd.Context())
-	cfg := config.FromContext(cmd.Context())
+	cfg := settings.FromContext(cmd.Context())
 
 	var nixConfig configuration.Configuration
 	if opts.FlakeRef != "" {

diff --git a/cmd/root/root.go b/cmd/root/root.go
@@ -8,9 +8,9 @@ import (
 	"github.com/fatih/color"
 	"github.com/spf13/cobra"
 	buildVars "github.com/water-sucks/nixos/internal/build"
-	"github.com/water-sucks/nixos/internal/config"
 	"github.com/water-sucks/nixos/internal/constants"
 	"github.com/water-sucks/nixos/internal/logger"
+	"github.com/water-sucks/nixos/internal/settings"
 
 	cmdTypes "github.com/water-sucks/nixos/internal/cmd/types"
 
@@ -61,19 +61,19 @@ func mainCommand() (*cobra.Command, error) {
 		configLocation = constants.DefaultConfigLocation
 	}
 
-	cfg, err := config.ParseConfig(configLocation)
+	cfg, err := settings.ParseSettings(configLocation)
 	if err != nil {
 		log.Error(err)
 		log.Warn("proceeding with defaults only, you have been warned")
-		cfg = config.NewConfig()
+		cfg = settings.NewSettings()
 	}
 
 	errs := cfg.Validate()
 	for _, err := range errs {
 		log.Warn(err.Error())
 	}
 
-	cmdCtx = config.WithConfig(cmdCtx, cfg)
+	cmdCtx = settings.WithConfig(cmdCtx, cfg)
 
 	cmd := cobra.Command{
 		Use:                        "nixos {command} [flags]",
@@ -131,7 +131,7 @@ func mainCommand() (*cobra.Command, error) {
 	cmd.PersistentFlags().BoolVar(&opts.ColorAlways, "color-always", false, "Always color output when possible")
 	cmd.PersistentFlags().StringToStringVar(&opts.ConfigValues, "config", map[string]string{}, "Set a configuration `key=value`")
 
-	err = cmd.RegisterFlagCompletionFunc("config", config.CompleteConfigFlag)
+	err = cmd.RegisterFlagCompletionFunc("config", settings.CompleteConfigFlag)
 	if err != nil {
 		return nil, err
 	}

diff --git a/internal/activation/activation.go b/internal/activation/activation.go
@@ -7,18 +7,18 @@ import (
 	"regexp"
 	"strconv"
 
-	"github.com/water-sucks/nixos/internal/config"
 	"github.com/water-sucks/nixos/internal/constants"
 	"github.com/water-sucks/nixos/internal/generation"
 	"github.com/water-sucks/nixos/internal/logger"
+	"github.com/water-sucks/nixos/internal/settings"
 	"github.com/water-sucks/nixos/internal/system"
 )
 
 // Parse the generation's `nixos-cli` configuration to find the default specialisation
 // for that generation.
 func FindDefaultSpecialisationFromConfig(generationDirname string) (string, error) {
 	generationCfgFilename := filepath.Join(generationDirname, constants.DefaultConfigLocation)
-	generationCfg, err := config.ParseConfig(generationCfgFilename)
+	generationCfg, err := settings.ParseSettings(generationCfgFilename)
 	if err != nil {
 		return "", err
 	}

diff --git a/internal/config/context.go b/internal/config/context.go
diff --git a/internal/config/errors.go b/internal/config/errors.go
diff --git a/internal/configuration/configuration.go b/internal/configuration/configuration.go
@@ -9,8 +9,8 @@ import (
 	"strings"
 
 	buildOpts "github.com/water-sucks/nixos/internal/build"
-	"github.com/water-sucks/nixos/internal/config"
 	"github.com/water-sucks/nixos/internal/logger"
+	"github.com/water-sucks/nixos/internal/settings"
 )
 
 type Configuration interface {
@@ -139,7 +139,7 @@ func FindLegacyConfiguration(log *logger.Logger, includes []string, verbose bool
 	return configuration, nil
 }
 
-func FindConfiguration(log *logger.Logger, cfg *config.Config, includes []string, verbose bool) (Configuration, error) {
+func FindConfiguration(log *logger.Logger, cfg *settings.Settings, includes []string, verbose bool) (Configuration, error) {
 	if buildOpts.Flake == "true" {
 		if verbose {
 			log.Info("looking for flake configuration")

diff --git a/internal/config/completion.go → internal/settings/completion.go b/internal/config/completion.go → internal/settings/completion.go
@@ -1,4 +1,4 @@
-package config
+package settings
 
 import (
 	"fmt"
@@ -141,7 +141,7 @@ func CompleteConfigFlag(_ *cobra.Command, args []string, toComplete string) ([]s
 }
 
 func completeKeys(candidate string) ([]string, cobra.ShellCompDirective) {
-	completionCandidates, complete := findFieldCompletions(NewConfig(), candidate)
+	completionCandidates, complete := findFieldCompletions(NewSettings(), candidate)
 
 	// There are three cases of completions where extra actions need to be taken:
 	// 1. Multiple candidates remaining