devshell: split into multiple packages

Make room for more extensions

Author: zimbatm

devshell/cmd/cmd.go

@@ -0,0 +1,21 @@
+package cmd
+
+import (
+	"os"
+
+	"github.com/urfave/cli/v2"
+)
+
+// Execute the main command
+func Execute() error {
+	app := &cli.App{
+		Name:        "devshell",
+		Description: "THE developer shell",
+		Commands: []*cli.Command{
+			Enter,
+			Init,
+		},
+	}
+
+	return app.Run(os.Args)
+}

devshell/cmd_enter.go devshell/cmd/enter.godevshell/cmd_enter.go renamed to devshell/cmd/enter.go

@@ -1,4 +1,4 @@
-package main
+package cmd
 
 import (
 	"fmt"
@@ -17,7 +17,8 @@ in
 pkgs.mkDevShell.fromTOML ./devshell.toml
 `
 
-var cmdEnter = &cli.Command{
+// Enter command
+var Enter = &cli.Command{
 	Name:    "enter",
 	Aliases: []string{"e"},
 	Usage:   "builds and enters the shell",

devshell/cmd_init.go devshell/cmd/init.godevshell/cmd_init.go renamed to devshell/cmd/init.go

@@ -1,19 +1,18 @@
-package main
+package cmd
 
 import (
 	"os"
 	"path/filepath"
 
+	"github.com/numtide/devshell/devshell/config"
+
 	"github.com/urfave/cli/v2"
 )
 
-const initHeader = `
-# See https://github.com/numtide/devshell
-`
-
-var cmdInit = &cli.Command{
+// Init command
+var Init = &cli.Command{
 	Name:  "init",
-	Usage: "creates a new " + configFile + " file",
+	Usage: "creates a new " + config.FileName + " file",
 	Flags: []cli.Flag{
 		&cli.StringFlag{
 			Name:  "name",
@@ -37,21 +36,6 @@ var cmdInit = &cli.Command{
 			name = filepath.Base(p2)
 		}
 
-		// Generate the config
-		cfg := &config{
-			Name: name,
-		}
-		cfgStr := initHeader + configPrint(cfg)
-
-		// Write the config file
-		w, err := os.Create(filepath.Join(p, configFile))
-		if err != nil {
-			return err
-		}
-		_, err = w.WriteString(cfgStr)
-		if err != nil {
-			return err
-		}
-		return w.Close()
+		return config.Init(p, name)
 	},
 }

devshell/path_utils.go devshell/cmd/path_utils.godevshell/path_utils.go renamed to devshell/cmd/path_utils.go

@@ -1,4 +1,4 @@
-package main
+package cmd
 
 import (
 	"os"

devshell/config.go devshell/config/config.godevshell/config.go renamed to devshell/config/config.go

@@ -1,42 +1,47 @@
-package main
+package config
 
 import (
 	"os"
 
 	"github.com/pelletier/go-toml"
 )
 
-const configFile = "devshell.toml"
+// FileName ...
+const FileName = "devshell.toml"
 
-type configBash struct {
+// Bash ...
+type Bash struct {
 	Extra       string `toml:"extra,omitempty"`
 	Interactive string `toml:"interactive,omitempty"`
 }
 
-type configCommand struct {
+// Command ...
+type Command struct {
 	Alias   string `toml:"alias,omitempty"`
 	Command string `toml:"command,omitempty"`
 	Help    string `toml:"help,omitempty"`
 	Name    string `toml:"name"`
 	Package string `toml:"package,omitempty"`
 }
 
-type config struct {
+// Config ...
+type Config struct {
 	Name     string                 `toml:"name"`
 	Packages []string               `toml:"packages"`
 	Motd     *string                `toml:"motd"`
 	Env      map[string]interface{} `toml:"env"`
-	Bash     configBash             `toml:"bash,omitempty"`
-	Commands []configCommand        `toml:"commands"`
+	Bash     Bash                   `toml:"bash,omitempty"`
+	Commands []Command              `toml:"commands"`
 }
 
-func configLoad(path string) (*config, error) {
+// Load ...
+func Load(path string) (*Config, error) {
 	r, err := os.Open(path)
 	if err != nil {
 		return nil, err
 	}
 
-	c := &config{}
+	c := &Config{}
 	err = toml.NewDecoder(r).Decode(c)
 	if err != nil {
 		return nil, err
@@ -45,7 +50,8 @@ func configLoad(path string) (*config, error) {
 	return c, err
 }
 
-func configPrint(c *config) string {
+// Print ...
+func Print(c *Config) string {
 	b, err := toml.Marshal(c)
 	if err != nil {
 		panic(err) // should never happen

devshell/config/init.go

@@ -0,0 +1,30 @@
+package config
+
+import (
+	"os"
+	"path/filepath"
+)
+
+const initHeader = `
+# See https://github.com/numtide/devshell
+`
+
+// Init ...
+func Init(path string, name string) error {
+	// Generate the config
+	cfg := &Config{
+		Name: name,
+	}
+	cfgStr := initHeader + Print(cfg)
+
+	// Write the config file
+	w, err := os.Create(filepath.Join(path, FileName))
+	if err != nil {
+		return err
+	}
+	_, err = w.WriteString(cfgStr)
+	if err != nil {
+		return err
+	}
+	return w.Close()
+}

devshell/go.mod

@@ -1,4 +1,4 @@
-module github.com/numtide/devshell/go/devshell
+module github.com/numtide/devshell/devshell
 
 go 1.15
 

devshell/go.sum

@@ -2,6 +2,8 @@ github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03
 github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d h1:U+s90UTSYgptZMwQh2aRr3LuazLJIa+Pg3Kc1ylSYVY=
 github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/numtide/devshell v0.0.0-20201009170333-4859a3846246 h1:B69NqAcy4dHvDgtUVrzSe0kZxp4g2JtfdmxKfqwNMBU=
+github.com/numtide/devshell/devshell v0.0.0-20201009170333-4859a3846246 h1:k4CTKrya/18Pl0FE2cJFLTRIN0zazmSA4LTi8dMukPs=
 github.com/pelletier/go-toml v1.8.1 h1:1Nf83orprkJyknT6h7zbuEGUEjcyVlCxSUGTENmNCRM=
 github.com/pelletier/go-toml v1.8.1/go.mod h1:T2/BmBdy8dvIRq1a/8aqjN41wvWlN4lrapLU/GW4pbc=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=

devshell/main.go

@@ -2,26 +2,12 @@ package main
 
 import (
 	"log"
-	"os"
 
-	"github.com/urfave/cli/v2"
+	"github.com/numtide/devshell/devshell/cmd"
 )
 
-func run() error {
-	app := &cli.App{
-		Name:        "devshell",
-		Description: "THE developer shell",
-		Commands: []*cli.Command{
-			cmdEnter,
-			cmdInit,
-		},
-	}
-
-	return app.Run(os.Args)
-}
-
 func main() {
-	err := run()
+	err := cmd.Execute()
 	if err != nil {
 		log.Fatal(err)
 	}