feat: config aliases

pkg/commands/install/install.go

@@ -29,13 +29,20 @@ func Execute(c *cli.Context) error {
 		return err
 	}
 
-	if c.Args().First() == "ekristen/distillery" {
-		_ = c.Set("include-pre-releases", "true")
+	inv := inventory.New(os.DirFS(cfg.BinPath), cfg.BinPath, cfg.GetOptPath(), cfg)
+
+	name := c.Args().First()
+	alias := cfg.GetAlias(c.Args().First())
+	if alias != nil {
+		name = alias.Name
+		_ = c.Set("version", alias.Version)
 	}
 
-	inv := inventory.New(os.DirFS(cfg.BinPath), cfg.BinPath, cfg.GetOptPath(), cfg)
+	if name == "ekristen/distillery" {
+		_ = c.Set("include-pre-releases", "true")
+	}
 
-	src, err := NewSource(c.Args().First(), &provider.Options{
+	src, err := NewSource(name, &provider.Options{
 		OS:     c.String("os"),
 		Arch:   c.String("arch"),
 		Config: cfg,
@@ -186,7 +193,7 @@ func Flags() []cli.Flag {
 			Aliases: []string{"c"},
 			Usage:   "Specify the configuration file to use",
 			EnvVars: []string{"DISTILLERY_CONFIG"},
-			Value:   filepath.Join(cfgDir, fmt.Sprintf("%s.toml", common.NAME)),
+			Value:   filepath.Join(cfgDir, fmt.Sprintf("%s.yaml", common.NAME)),
 		},
 		&cli.StringFlag{
 			Name:     "github-token",

pkg/commands/install/source.go

@@ -48,7 +48,7 @@ func NewSource(src string, opts *provider.Options) (provider.ISource, error) { /
 			}, nil
 		}
 
-		return nil, fmt.Errorf("invalid install source, expect format of owner/repo or owner/repo@version")
+		return nil, fmt.Errorf("invalid install source, expect alias or format of owner/repo or owner/repo@version")
 	}
 
 	if len(parts) == 2 {
@@ -95,7 +95,7 @@ func NewSource(src string, opts *provider.Options) (provider.ISource, error) { /
 			}, nil
 		}
 
-		return nil, fmt.Errorf("invalid install source, expect format of owner/repo or owner/repo@version")
+		return nil, fmt.Errorf("invalid install source, expect alias	 or format of owner/repo or owner/repo@version")
 	} else if len(parts) >= 3 {
 		if strings.HasPrefix(parts[0], "github") {
 			if parts[1] == source.HashicorpSource {

pkg/config/alias.go

@@ -0,0 +1,44 @@
+package config
+
+import (
+	"strings"
+
+	"github.com/ekristen/distillery/pkg/common"
+)
+
+type Aliases map[string]*Alias
+
+type Alias struct {
+	Name    string `yaml:"name" toml:"name"`
+	Version string `yaml:"version" toml:"version"`
+	Bin     string `yaml:"bin" toml:"bin"`
+}
+
+func (a *Alias) UnmarshalYAML(unmarshal func(interface{}) error) error {
+	var value string
+	if unmarshal(&value) == nil {
+		p := strings.Split(value, "@")
+		a.Name = p[0]
+		a.Version = common.Latest
+		if len(p) > 1 {
+			a.Version = p[1]
+		}
+		return nil
+	}
+
+	type alias Alias
+	aux := (*alias)(a)
+	if err := unmarshal(aux); err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func (a *Alias) UnmarshalText(b []byte) error {
+	*a = Alias{
+		Name:    string(b),
+		Version: "latest",
+	}
+	return nil
+}

pkg/config/config.go

@@ -34,7 +34,7 @@ type Config struct {
 
 	// Aliases - Allow for creating shorthand aliases for source locations that you use frequently. A good example
 	// of this is `distillery` -> `ekristen/distillery`
-	Aliases map[string]string `yaml:"aliases" toml:"aliases"`
+	Aliases *Aliases `yaml:"aliases" toml:"aliases"`
 
 	// Language - the language to use for the output of the application
 	Language string `yaml:"language" toml:"language"`
@@ -56,6 +56,20 @@ func (c *Config) GetOptPath() string {
 	return filepath.Join(c.Path, "opt")
 }
 
+func (c *Config) GetAlias(name string) *Alias {
+	if c.Aliases == nil {
+		return nil
+	}
+
+	for short, alias := range *c.Aliases {
+		if short == name {
+			return alias
+		}
+	}
+
+	return nil
+}
+
 func (c *Config) MkdirAll() error {
 	paths := []string{c.BinPath, c.GetOptPath(), c.CachePath, c.GetMetadataPath(), c.GetDownloadsPath()}
 
@@ -85,7 +99,7 @@ func (c *Config) Load(path string) error {
 		return toml.Unmarshal(data, c)
 	}
 
-	return nil
+	return fmt.Errorf("unknown configuration file suffix")
 }
 
 // New - create a new configuration object

pkg/config/config_test.go

@@ -0,0 +1,49 @@
+package config
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestConfigNewYAML(t *testing.T) {
+	cfg, err := New("testdata/base.yaml")
+	assert.NoError(t, err)
+
+	assert.Equal(t, "/home/test/.distillery", cfg.Path)
+	assert.Equal(t, "/home/test/.cache", cfg.CachePath)
+
+	aliases := &Aliases{
+		"dist": &Alias{
+			Name:    "ekristen/distillery",
+			Version: "latest",
+		},
+		"aws-nuke": &Alias{
+			Name:    "ekristen/aws-nuke",
+			Version: "3.29.3",
+		},
+	}
+
+	assert.EqualValues(t, aliases, cfg.Aliases)
+}
+
+func TestConfigNewTOML(t *testing.T) {
+	cfg, err := New("testdata/base.toml")
+	assert.NoError(t, err)
+
+	assert.Equal(t, "/home/test/.distillery", cfg.Path)
+	assert.Equal(t, "/home/test/.cache", cfg.CachePath)
+
+	aliases := &Aliases{
+		"dist": &Alias{
+			Name:    "ekristen/distillery",
+			Version: "latest",
+		},
+		"aws-nuke": &Alias{
+			Name:    "ekristen/aws-nuke",
+			Version: "3.29.3",
+		},
+	}
+
+	assert.EqualValues(t, aliases, cfg.Aliases)
+}

pkg/config/testdata/base.toml

@@ -0,0 +1,9 @@
+path = "/home/test/.distillery"
+cache_path = "/home/test/.cache"
+
+[aliases]
+dist = "ekristen/distillery"
+
+  [aliases.aws-nuke]
+  name = "ekristen/aws-nuke"
+  version = "3.29.3"

pkg/config/testdata/base.yaml

@@ -0,0 +1,7 @@
+path: /home/test/.distillery
+cache_path: /home/test/.cache
+aliases:
+  dist: ekristen/distillery
+  aws-nuke:
+    name: ekristen/aws-nuke
+    version: 3.29.3