initial commit

Author: marouni

README.md

@@ -0,0 +1,11 @@
+# ADR Go
+A minimalist command line tool written in Go to work with [Architecture Decision Records](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions) (ADRs).
+
+Greatly inspired by the [adr-tools](https://github.com/npryce/adr-tools) with all of the added benefits of using the Go instead of Bash.
+
+# Quick start
+## Installing adr
+
+## Initializing adr
+
+## Creating a new ADR

commands.go

@@ -0,0 +1,43 @@
+package main
+
+import (
+	"github.com/fatih/color"
+	"github.com/urfave/cli"
+)
+
+func setCommands(app *cli.App) {
+	app.Commands = []cli.Command{
+		{
+			Name:    "new",
+			Aliases: []string{"c"},
+			Usage:   "Create a new ADR",
+			Flags:   []cli.Flag{},
+			Action: func(c *cli.Context) error {
+				currentConfig := getConfig()
+				currentConfig.CurrentAdr++
+				updateConfig(currentConfig)
+				newAdr(currentConfig, c.Args())
+				return nil
+			},
+		},
+
+		{
+			Name:        "init",
+			Aliases:     []string{"i"},
+			Usage:       "Initializes the ADR configurations",
+			UsageText:   "adr init /home/user/adrs",
+			Description: "Initializes the ADR configuration with an optional ADR base directory\n This is a a prerequisite to running any other adr sub-command",
+			Action: func(c *cli.Context) error {
+				initDir := c.Args().First()
+				if initDir == "" {
+					initDir = adrDefaultBaseFolder
+				}
+				color.Green("Initializing ADR base at " + initDir)
+				initBaseDir(initDir)
+				initConfig(initDir)
+				initTemplate()
+				return nil
+			},
+		},
+	}
+}

context.go

@@ -0,0 +1,135 @@
+package main
+
+import (
+	"encoding/json"
+	"html/template"
+	"io/ioutil"
+	"os"
+	"os/user"
+	"path/filepath"
+	"strconv"
+	"strings"
+	"time"
+
+	"github.com/fatih/color"
+)
+
+// AdrConfig ADR configuration, loaded and used by each sub-command
+type AdrConfig struct {
+	BaseDir    string `json:"base_directory"`
+	CurrentAdr int    `json:"current_id"`
+}
+
+// Adr basic structure
+type Adr struct {
+	Number int
+	Title  string
+	Date   string
+	Status AdrStatus
+}
+
+// AdrStatus type
+type AdrStatus string
+
+// ADR status enums
+const (
+	PROPOSED   AdrStatus = "Proposed"
+	ACCEPTED   AdrStatus = "Accepted"
+	DEPRECATED AdrStatus = "Deprecated"
+	SUPERSEDED AdrStatus = "Superseded"
+)
+
+var usr, err = user.Current()
+var adrConfigFolderName = ".adr"
+var adrConfigFileName = "config.json"
+var adrConfigTemplateName = "template.md"
+var adrConfigFolderPath = filepath.Join(usr.HomeDir, adrConfigFolderName)
+var adrConfigFilePath = filepath.Join(adrConfigFolderPath, adrConfigFileName)
+var adrTemplateFilePath = filepath.Join(adrConfigFolderPath, adrConfigTemplateName)
+var adrDefaultBaseFolder = filepath.Join(usr.HomeDir, "adr")
+
+func initBaseDir(baseDir string) {
+	if _, err := os.Stat(baseDir); os.IsNotExist(err) {
+		os.Mkdir(baseDir, 0744)
+	} else {
+		color.Red(baseDir + " already exists, skipping folder creation")
+	}
+}
+
+func initConfig(baseDir string) {
+	if _, err := os.Stat(adrConfigFolderPath); os.IsNotExist(err) {
+		os.Mkdir(adrConfigFolderPath, 0744)
+	}
+	config := AdrConfig{baseDir, 0}
+	bytes, err := json.MarshalIndent(config, "", " ")
+	if err != nil {
+		panic(err)
+	}
+	ioutil.WriteFile(adrConfigFilePath, bytes, 0644)
+}
+
+func initTemplate() {
+	body := []byte(`
+# {{.Number}}. {{.Title}}
+======
+Date: {{.Date}}
+
+## Status
+======
+{{.Status}}
+
+## Context
+======
+
+## Decision
+======
+
+## Consequences
+======
+
+`)
+
+	ioutil.WriteFile(adrTemplateFilePath, body, 0644)
+}
+
+func updateConfig(config AdrConfig) {
+	bytes, err := json.MarshalIndent(config, "", " ")
+	if err != nil {
+		panic(err)
+	}
+	ioutil.WriteFile(adrConfigFilePath, bytes, 0644)
+}
+
+func getConfig() AdrConfig {
+	var currentConfig AdrConfig
+
+	bytes, err := ioutil.ReadFile(adrConfigFilePath)
+	if err != nil {
+		color.Red("No ADR configuration is found!")
+		color.HiGreen("Start by initializing ADR configuration, check 'adr init --help' for more help")
+		os.Exit(1)
+	}
+
+	json.Unmarshal(bytes, &currentConfig)
+	return currentConfig
+}
+
+func newAdr(config AdrConfig, adrName []string) {
+	adr := Adr{
+		Title:  strings.Join(adrName, " "),
+		Date:   time.Now().Format("02-01-2006 15:04:05"),
+		Number: config.CurrentAdr,
+		Status: PROPOSED,
+	}
+	template, err := template.ParseFiles(adrTemplateFilePath)
+	if err != nil {
+		panic(err)
+	}
+	adrFileName := strconv.Itoa(adr.Number) + "-" + strings.Join(strings.Split(strings.Trim(adr.Title, "\n \t"), " "), "-") + ".md"
+	f, err := os.Create(filepath.Join(config.BaseDir, adrFileName))
+	if err != nil {
+		panic(err)
+	}
+	template.Execute(f, adr)
+	f.Close()
+}

flags.go

@@ -0,0 +1,9 @@
+package main
+
+import (
+	"github.com/urfave/cli"
+)
+
+func setFlags(app *cli.App) {
+	app.Flags = []cli.Flag{}
+}

main.go

@@ -0,0 +1,24 @@
+package main
+
+import (
+	"log"
+	"os"
+
+	"github.com/urfave/cli"
+)
+
+func main() {
+
+	app := cli.NewApp()
+	app.Name = "adr"
+	app.Usage = "Work with Architecture Decision Records (ADRs)"
+	app.Version = "0.1.0"
+
+	setFlags(app)
+	setCommands(app)
+
+	err := app.Run(os.Args)
+	if err != nil {
+		log.Fatal(err)
+	}
+}