Improve naming, add tests

.github/benchmark.go

@@ -12,7 +12,7 @@ import (
 	"time"
 )
 
-var serialiser = app.NewSerialiser(tf.NewStyler(tf.NO_COLOUR), false)
+var serialiser = app.NewSerialiser(tf.NewStyler(tf.COLOUR_THEME_NO_COLOUR), false)
 
 func main() {
 	// Setup

klog.go

@@ -27,27 +27,27 @@ func main() {
 	klogFolder := func() app.File {
 		f, err := determineKlogConfigFolder()
 		if err != nil {
-			fail(util.PrettifyAppError(err, false), app.GENERAL_ERROR.ToInt())
+			fail(util.PrettifyAppError(err, false), app.CONFIG_ERROR.ToInt())
 		}
 		return f
 	}()
 
 	configFile := func() string {
 		c, err := readConfigFile(app.Join(klogFolder, app.CONFIG_FILE_NAME))
 		if err != nil {
-			fail(util.PrettifyAppError(err, false), app.GENERAL_ERROR.ToInt())
+			fail(util.PrettifyAppError(err, false), app.CONFIG_ERROR.ToInt())
 		}
 		return c
 	}()
 
 	config := func() app.Config {
 		c, err := app.NewConfig(
-			app.FromStaticValues{NumCpus: runtime.NumCPU()},
+			app.FromDeterminedValues{NumCpus: runtime.NumCPU()},
 			app.FromEnvVars{GetVar: os.Getenv},
 			app.FromConfigFile{FileContents: configFile},
 		)
 		if err != nil {
-			fail(util.PrettifyAppError(err, false), app.GENERAL_ERROR.ToInt())
+			fail(util.PrettifyAppError(err, false), app.CONFIG_ERROR.ToInt())
 		}
 		return c
 	}()

klog/app/cli/terminalformat/colour_theme.go

@@ -3,9 +3,9 @@ package terminalformat
 type ColourTheme string
 
 const (
-	NO_COLOUR = ColourTheme("no_colour")
-	DARK      = ColourTheme("dark")
-	LIGHT     = ColourTheme("light")
+	COLOUR_THEME_NO_COLOUR = ColourTheme("no_colour")
+	COLOUR_THEME_DARK      = ColourTheme("dark")
+	COLOUR_THEME_LIGHT     = ColourTheme("light")
 )
 
 func NewStyler(c ColourTheme) Styler {
@@ -21,7 +21,7 @@ func NewStyler(c ColourTheme) Styler {
 	}
 
 	switch c {
-	case NO_COLOUR:
+	case COLOUR_THEME_NO_COLOUR:
 		return Styler{
 			props:            StyleProps{},
 			colourCodes:      make(map[Colour]string),
@@ -32,7 +32,7 @@ func NewStyler(c ColourTheme) Styler {
 			underlined:       "",
 			bold:             "",
 		}
-	case DARK:
+	case COLOUR_THEME_DARK:
 		baseColouredStyler.colourCodes = map[Colour]string{
 			TEXT:         "015",
 			TEXT_INVERSE: "000",
@@ -45,7 +45,7 @@ func NewStyler(c ColourTheme) Styler {
 			YELLOW:       "221",
 		}
 		return baseColouredStyler
-	case LIGHT:
+	case COLOUR_THEME_LIGHT:
 		baseColouredStyler.colourCodes = map[Colour]string{
 			TEXT:         "000",
 			TEXT_INVERSE: "015",

klog/app/cli/terminalformat/table_test.go

@@ -7,7 +7,7 @@ import (
 
 func TestPrintTable(t *testing.T) {
 	result := ""
-	styler := NewStyler(DARK)
+	styler := NewStyler(COLOUR_THEME_DARK)
 	table := NewTable(3, " ")
 	table.
 		Cell("FIRST", Options{align: ALIGN_LEFT}).

klog/app/cli/testcontext_test.go

@@ -13,8 +13,8 @@ import (
 
 func NewTestingContext() TestingContext {
 	bc := app.NewEmptyBookmarksCollection()
-	config := app.NewDefaultConfig(tf.NO_COLOUR)
-	styler := tf.NewStyler(tf.NO_COLOUR)
+	config := app.NewDefaultConfig(tf.COLOUR_THEME_NO_COLOUR)
+	styler := tf.NewStyler(tf.COLOUR_THEME_NO_COLOUR)
 	return TestingContext{
 		State: State{
 			printBuffer:         "",

klog/app/cli/util/args.go

@@ -278,7 +278,7 @@ type NoStyleArgs struct {
 func (args *NoStyleArgs) Apply(ctx *app.Context) {
 	if args.NoStyle {
 		(*ctx).ConfigureSerialisation(func(styler tf.Styler, decimalDuration bool) (tf.Styler, bool) {
-			return tf.NewStyler(tf.NO_COLOUR), decimalDuration
+			return tf.NewStyler(tf.COLOUR_THEME_NO_COLOUR), decimalDuration
 		})
 	}
 }

klog/app/cli/util/prettifier.go

@@ -22,7 +22,7 @@ func PrettifyAppError(err app.Error, isDebug bool) error {
 }
 
 // PrettifyParsingError turns a parsing error into a coloured and well-structured form.
-func PrettifyParsingError(err app.ParserErrors, isDebug bool, styler tf.Styler) error {
+func PrettifyParsingError(err app.ParserErrors, styler tf.Styler) error {
 	message := ""
 	INDENT := "    "
 	for _, e := range err.All() {

klog/app/cli/util/prettifier_test.go

@@ -9,7 +9,7 @@ import (
 	"testing"
 )
 
-var styler = tf.NewStyler(tf.NO_COLOUR)
+var styler = tf.NewStyler(tf.COLOUR_THEME_NO_COLOUR)
 
 func TestFormatParserError(t *testing.T) {
 	block1, _ := txt.ParseBlock("Good text\nSome malformed text", 37)
@@ -18,7 +18,7 @@ func TestFormatParserError(t *testing.T) {
 		txt.NewError(block1, 1, 0, 4, "CODE", "Error", "Short explanation."),
 		txt.NewError(block2, 0, 8, 5, "CODE", "Problem", "More info.").SetOrigin("some-file.klg"),
 	})
-	text := PrettifyParsingError(err, false, styler).Error()
+	text := PrettifyParsingError(err, styler).Error()
 	assert.Equal(t, `
 [SYNTAX ERROR] in line 39
     Some malformed text
@@ -37,7 +37,7 @@ func TestReflowsLongMessages(t *testing.T) {
 	err := app.NewParserErrors([]txt.Error{
 		txt.NewError(block, 0, 4, 3, "CODE", "Some Title", "A verbose description with details, potentially spanning multiple lines with a comprehensive text and tremendously helpful information.\nBut\nit\nrespects\nnewlines."),
 	})
-	text := PrettifyParsingError(err, false, styler).Error()
+	text := PrettifyParsingError(err, styler).Error()
 	assert.Equal(t, `
 [SYNTAX ERROR] in line 2
     Foo bar
@@ -56,7 +56,7 @@ func TestConvertsTabToSpaces(t *testing.T) {
 	err := app.NewParserErrors([]txt.Error{
 		txt.NewError(block, 0, 0, 8, "CODE", "Error title", "Error details"),
 	})
-	text := PrettifyParsingError(err, false, styler).Error()
+	text := PrettifyParsingError(err, styler).Error()
 	assert.Equal(t, `
 [SYNTAX ERROR] in line 14
      Foo bar

klog/app/config.go

@@ -47,9 +47,12 @@ type Reader interface {
 	Apply(*Config) Error
 }
 
-func NewConfig(c1 FromStaticValues, c2 FromEnvVars, c3 FromConfigFile) (Config, Error) {
-	config := NewDefaultConfig(tf.DARK)
-	for _, c := range []Reader{c1, c2, c3} {
+// NewConfig creates a new application configuration by merging the config
+// based on the following precedence: (1) env variables, (2) config file,
+// (3) determined values.
+func NewConfig(determined FromDeterminedValues, env FromEnvVars, file FromConfigFile) (Config, Error) {
+	config := NewDefaultConfig(tf.COLOUR_THEME_DARK)
+	for _, c := range []Reader{determined, file, env} {
 		err := c.Apply(&config)
 		if err != nil {
 			return Config{}, err
@@ -132,13 +135,13 @@ func (p *OptionalParam[T]) set(value T, o configOrigin) {
 	p.origin = o
 }
 
-// FromStaticValues is the part of the configuration that is automatically
+// FromDeterminedValues is the part of the configuration that is automatically
 // determined, e.g. by constraints of the runtime environment.
-type FromStaticValues struct {
+type FromDeterminedValues struct {
 	NumCpus int
 }
 
-func (e FromStaticValues) Apply(config *Config) Error {
+func (e FromDeterminedValues) Apply(config *Config) Error {
 	config.CpuKernels.override(e.NumCpus, configOriginStaticValues)
 	return nil
 }
@@ -154,7 +157,7 @@ func (e FromEnvVars) Apply(config *Config) Error {
 		config.IsDebug.override(true, configOriginEnv)
 	}
 	if e.GetVar("NO_COLOR") != "" {
-		config.ColourScheme.override(tf.NO_COLOUR, configOriginEnv)
+		config.ColourScheme.override(tf.COLOUR_THEME_NO_COLOUR, configOriginEnv)
 	}
 	if e.GetVar("EDITOR") != "" {
 		config.Editor.set(e.GetVar("EDITOR"), configOriginEnv)
@@ -183,18 +186,18 @@ var CONFIG_FILE_ENTRIES = []ConfigFileEntries[any]{
 		Help: Help{
 			Summary: "The CLI command that shall be invoked when running `klog edit`.",
 			Value:   "The config property can be any valid CLI command, as you would type it on the terminal. klog will append the target file path as last input argument to that command. Note: you can use quotes in order to prevent undesired shell word-splitting, e.g. if the command name/path contains spaces.",
-			Default: "If absent/empty, `klog edit` tries to fall back to the $EDITOR environment variable (which you’d see below in that case).",
+			Default: "If absent/empty, `klog edit` tries to fall back to the $EDITOR environment variable (which, by the way, takes precedence, if set).",
 		},
 	}, {
 		Name: "colour_scheme",
 		reader: func(value string, config *Config) error {
 			switch value {
-			case string(tf.DARK):
-				config.ColourScheme.override(tf.DARK, configOriginFile)
-			case string(tf.NO_COLOUR):
-				config.ColourScheme.override(tf.NO_COLOUR, configOriginFile)
-			case string(tf.LIGHT):
-				config.ColourScheme.override(tf.LIGHT, configOriginFile)
+			case string(tf.COLOUR_THEME_DARK):
+				config.ColourScheme.override(tf.COLOUR_THEME_DARK, configOriginFile)
+			case string(tf.COLOUR_THEME_NO_COLOUR):
+				config.ColourScheme.override(tf.COLOUR_THEME_NO_COLOUR, configOriginFile)
+			case string(tf.COLOUR_THEME_LIGHT):
+				config.ColourScheme.override(tf.COLOUR_THEME_LIGHT, configOriginFile)
 			default:
 				return errors.New("The value must be `dark`, `light` or `no_colour`")
 			}
@@ -356,7 +359,7 @@ func (e FromConfigFile) Apply(config *Config) Error {
 		if rErr != nil {
 			return NewError(
 				"Invalid config file",
-				"The value for `"+key+"` is not valid: "+entry.Help.Value,
+				"The value for the `"+key+"` setting is not valid: "+entry.Help.Value,
 				rErr,
 			)
 		}