TIL-23 Update readme for new configuration options

Signed-off-by: Chris Cummer <[email protected]>

Author: senorprogrammer

README.md

@@ -70,13 +70,17 @@ Open `~/.config/til/config.yml`, change the following entries, and save it:
     * committerEmail
     * committerName
     * editor
-    * targetDirectory
+    * targetDirectories
 
 `committerEmail` and `committerName` are the values `til` will use to commit changes with when you run `til -save`. 
 
 `editor` is the text editor `til` will open your file in when you run `til [some title here]`.
 
-`targetDirectory` is where `til` will write your files to. If the target directory does not exist, `til` will try to create it. 
+`targetDirectories` defines the locations that `til` will write your files to. If a specified target directory does not exist, `til` will try to create it. This is a map of key/value pairs, where the "key" defines the value to pass in using the `-target` flag, and the "value" is the path to the directory.
+
+If only one target directory is defined in the configuration, the `-target` flag can be ommitted from all commands. 
+If multiple target diretories are defined in the configuration, all commands must include the `-target` flag specifying 
+which target directory to operate against.
 
 ### Config Example
 
@@ -86,7 +90,9 @@ commitMessage: "build, save, push"
 committerEmail: [email protected]
 committerName: "TIL Autobot"
 editor: "mvim"
-targetDirectory: "~/Documents/til"
+targetDirectories: 
+    a: ~/Documents/notes
+    b: ~/Documents/blog
 ```
 
 ## Usage
@@ -95,34 +101,59 @@ targetDirectory: "~/Documents/til"
 
 ### Creating a new page
 
+With one target directory defined in the configuration:
+
 ```bash
 ❯ til New title here
 2020-04-20T14-52-57-new-title-here.md
 ```
 
+With multiple target directories defined:
+
+```bash
+❯ til -target a New title here
+2020-04-20T14-52-57-new-title-here.md
+```
+
 That new page will open in whichever editor you've defined in your config.
 
 ### Building static pages
 
+With one target directory defined in the configuration:
+
 ```bash
 ❯ til -build
 ```
 
+With multiple target directories defined:
+
+```bash
+❯ til -target a -build
+```
+
 Builds the index and tag pages, and leaves them uncommitted.
 
 <p align="center"><img src="images/til_build.png" width="600" height="213" alt="image of the build process" title="til -build" /></p>
 
 ### Building, saving, committing, and pushing
 
+With one target directory defined in the configuration:
+
 ```bash
 ❯ til -save [optional commit message]
 ```
 
+With multiple target directories defined:
+
+```bash
+❯ til -target a -save [optional commit message]
+```
+
 Builds the index and tag pages, commits everything to the git repo with the commit message you've defined in your config, and pushes it all up to the remote repo.
 
-`-save` makes a hard assumption that your `targetDirectory` is under version control, controlled by `git`. It is highly recommended that you do this.
+`-save` makes a hard assumption that your target directory is under version control, controlled by `git`. It is recommended that you do this.
 
-`-save` also makes a soft assumption that your `targetDirectory` has `remote` set to GitHub (but it should work with `remote` set to anywhere).
+`-save` also makes a soft assumption that your target directory has `remote` set to GitHub (but it should work with `remote` set to anywhere).
 
 `-save` takes an optional commit message. If that message is supplied, it will be used as the commit message. If that message is not supplied, the `commitMessage` value in the config file will be used. If that value is not supplied, an error will be raised.
 

til.go

@@ -257,7 +257,7 @@ func readConfigFile() {
 // the config file, exists and contains a /docs folder for writing pages to.
 // If these directories don't exist, it tries to create them
 func buildTargetDirectory() {
-	tDir := getTargetDir(true)
+	tDir := getTargetDir(globalConfig, true)
 
 	if _, err := os.Stat(tDir); os.IsNotExist(err) {
 		err := os.MkdirAll(tDir, os.ModePerm)
@@ -269,7 +269,7 @@ func buildTargetDirectory() {
 
 // getTargetDir returns the absolute string path to the directory that the
 // content will be written to
-func getTargetDir(withDocsDir bool) string {
+func getTargetDir(cfg *config.Config, withDocsDir bool) string {
 	docsBit := ""
 	if withDocsDir {
 		docsBit = "/docs"
@@ -281,7 +281,7 @@ func getTargetDir(withDocsDir bool) string {
 	//		targetDirectories:
 	//			a: ~/Documents/blog
 	//			b: ~/Documents/notes
-	uDirs, err := globalConfig.Map("targetDirectories")
+	uDirs, err := cfg.Map("targetDirectories")
 	if err != nil {
 		Defeat(err)
 	}
@@ -366,7 +366,7 @@ func buildIndexPage(pages []*Page, tagMap *TagMap) {
 	// And write the file to disk
 	filePath := fmt.Sprintf(
 		"%s/index.%s",
-		getTargetDir(true),
+		getTargetDir(globalConfig, true),
 		fileExtension,
 	)
 
@@ -404,7 +404,7 @@ func buildTagPages(pages []*Page) *TagMap {
 			// And write the file to disk
 			filePath := fmt.Sprintf(
 				"%s/%s.%s",
-				getTargetDir(true),
+				getTargetDir(globalConfig, true),
 				tagName,
 				fileExtension,
 			)
@@ -441,7 +441,7 @@ func createNewPage(title string) string {
 	// Write out the stub file, explode if we can't do that
 	filePath := fmt.Sprintf(
 		"%s/%s-%s.%s",
-		getTargetDir(true),
+		getTargetDir(globalConfig, true),
 		pathDate,
 		strings.ReplaceAll(strings.ToLower(title), " ", "-"),
 		fileExtension,
@@ -476,7 +476,7 @@ func loadPages() []*Page {
 	filePaths, _ := filepath.Glob(
 		fmt.Sprintf(
 			"%s/*.%s",
-			getTargetDir(true),
+			getTargetDir(globalConfig, true),
 			fileExtension,
 		),
 	)
@@ -526,7 +526,7 @@ func parseTitle(targetFlag string, args []string) string {
 func push() {
 	Info(statusRepoPush)
 
-	tDir := getTargetDir(false)
+	tDir := getTargetDir(globalConfig, false)
 
 	r, err := git.PlainOpen(tDir)
 	if err != nil {
@@ -563,7 +563,7 @@ func readPage(filePath string) *Page {
 func save(commitMsg string) {
 	Info(statusRepoSave)
 
-	tDir := getTargetDir(false)
+	tDir := getTargetDir(globalConfig, false)
 
 	r, err := git.PlainOpen(tDir)
 	if err != nil {

til_test.go

@@ -3,9 +3,50 @@ package main
 import (
 	"testing"
 
+	"github.com/olebedev/config"
 	"github.com/stretchr/testify/assert"
 )
 
+/* -------------------- Target Directory -------------------- */
+
+func Test_getTargetDir(t *testing.T) {
+	tests := []struct {
+		name         string
+		config       *config.Config
+		withDocsDir  bool
+		expectedPath string
+		expectedErr  error
+	}{
+		{
+			name: "with no targetDirectories config key",
+		},
+		{
+			name: "with no target directories defined",
+		},
+		{
+			name: "with one target directory defined",
+		},
+		{
+			name: "with multiple target directories defined and invalid key",
+		},
+		{
+			name: "with multiple target directories defined and valid key",
+		},
+		{
+			name: "with a home directory-relative path",
+		},
+		{
+			name: "with an absolute path",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+
+		})
+	}
+}
+
 /* -------------------- More Helper Functions -------------------- */
 
 func Test_Colour(t *testing.T) {