diff --git a/.gitea/pull_request_template.md b/.gitea/pull_request_template.md deleted file mode 100644 index f4def42..0000000 --- a/.gitea/pull_request_template.md +++ /dev/null @@ -1,6 +0,0 @@ - \ No newline at end of file diff --git a/DOCS.md b/DOCS.md index 7a3f2b9..5d70838 100644 --- a/DOCS.md +++ b/DOCS.md @@ -15,10 +15,6 @@ A "valid" tmpl template only requires two things The template.toml file will only expand environment variables with syntax `$USER` or `${USER}`. For full documentation on the syntax, see [os.ExpandEnv](https://golang.org/pkg/os/#ExpandEnv). -When using the `--defaults` flag, no prompts will be shown and only default values will be used. -As another alternative, any environment variable that matches a key will bypass the prompt. -For example, `author` would have the corresponding environment variable `TMPL_VAR_AUTHOR`. - ```toml # Key-value pairs can be simple # The user will receive a basic prompt asking them to fill out the variable @@ -119,13 +115,4 @@ I realize that many users will be using GitHub, and most will likely still be us 1. The simplest solution is to make a copy of your `registry.toml` (default: `~/.tmpl/registry.toml`). * Once in the new location, you will need to use `tmpl restore`. -2. Alternatively, you can copy/paste the entire registry (default: `~/.tmpl`) and skip the restore step. - -## `.tmplkeep` - -Perhaps you are familiar with `.gitkeep` and its unofficial status in git. Git does not like empty directories, so usually -a `.gitkeep` (or just `.keep`) file is added to retain the directory while keeping it effectively empty. - -tmpl instead uses `.tmplkeep` files for this purpose. The difference is, tmpl will **not** create the `.tmplkeep` file -when the template is executed. This allows you to set up directory structures (for staging, examples, etc.) that -will *actually* be empty after execution. \ No newline at end of file +2. Alternatively, you can copy/paste the entire registry (default: `~/.tmpl`) and skip the restore step. \ No newline at end of file diff --git a/docs.go b/docs.go index aa13bf6..3ca29f5 100644 --- a/docs.go +++ b/docs.go @@ -28,7 +28,7 @@ func main() { md = md[strings.Index(md, "#"):] // CLI is using real default instead of DefaultText - md = regexp.MustCompile(`[\/\\:\w]+\.tmpl`).ReplaceAllString(md, "~/.tmpl") + md = regexp.MustCompile(`[\/\w]+\.tmpl`).ReplaceAllString(md, "~/.tmpl") if _, err := fi.WriteString(md); err != nil { panic(err) diff --git a/registry/prompt.go b/registry/prompt.go index d0d34cf..62317c2 100644 --- a/registry/prompt.go +++ b/registry/prompt.go @@ -6,7 +6,6 @@ import ( "os" "path/filepath" "sort" - "strings" "text/template" "github.com/AlecAivazis/survey/v2" @@ -68,22 +67,15 @@ func prompt(dir string, defaults bool) (templatePrompts, error) { prompts[idx] = p } + // Return early if we only want defaults + if defaults { + return prompts, nil + } + // Sort the prompts so they are consistent sort.Sort(prompts) for idx, prompt := range prompts { - // Check for env variable - if e, ok := os.LookupEnv(fmt.Sprintf("TMPL_VAR_%s", strings.ToUpper(prompt.Key))); ok { - prompts[idx].Value = e - continue - } - - // Check if we are using defaults - if defaults { - prompts[idx].Value = prompt.Default - continue - } - var p survey.Prompt switch t := prompt.Default.(type) { case []string: @@ -127,7 +119,11 @@ type templatePrompts []templatePrompt func (t templatePrompts) ToMap() map[string]interface{} { m := make(map[string]interface{}) for _, p := range t { - m[p.Key] = p.Value + if p.Value != nil { + m[p.Key] = p.Value + continue + } + m[p.Key] = p.Default } return m } diff --git a/registry/registry_test.go b/registry/registry_test.go index 628e29d..5b3e217 100644 --- a/registry/registry_test.go +++ b/registry/registry_test.go @@ -17,7 +17,7 @@ var ( func TestMain(m *testing.M) { var err error - destDir, err = ioutil.TempDir(os.TempDir(), "tmpl-dest") + destDir, err = ioutil.TempDir(os.TempDir(), "tmpl") if err != nil { panic(err) } @@ -75,7 +75,7 @@ func testGetFail(t *testing.T) { func setupTemplate() { var err error - tmplDir, err = ioutil.TempDir(os.TempDir(), "tmpl-setup") + tmplDir, err = ioutil.TempDir(os.TempDir(), "tmpl") if err != nil { panic(err) } @@ -98,8 +98,7 @@ func setupTemplate() { if err := os.MkdirAll(pkgPath, os.ModePerm); err != nil { panic(err) } - // .tmplkeep file - fi, err = os.Create(filepath.Join(pkgPath, ".tmplkeep")) + fi, err = os.Create(filepath.Join(pkgPath, ".keep")) if err != nil { panic(err) } @@ -123,7 +122,7 @@ func setupTemplate() { func setupRegistry() { var err error - regDir, err = ioutil.TempDir(os.TempDir(), "tmpl-reg") + regDir, err = ioutil.TempDir(os.TempDir(), "tmpl") if err != nil { panic(err) } diff --git a/registry/template.go b/registry/template.go index 76bf84c..9f37184 100644 --- a/registry/template.go +++ b/registry/template.go @@ -67,7 +67,7 @@ func (t *Template) Execute(dest string, defaults, overwrite bool) error { return err } - newDest := strings.TrimPrefix(walkPath, base+string(filepath.Separator)) + newDest := strings.TrimPrefix(walkPath, base+"/") newDest = filepath.Join(dest, newDest) tmplDest, err := template.New("dest").Funcs(funcs).Parse(newDest) @@ -85,11 +85,6 @@ func (t *Template) Execute(dest string, defaults, overwrite bool) error { return err } - // Skip .tmplkeep files, after creating the directory structure - if strings.EqualFold(walkInfo.Name(), ".tmplkeep") { - return nil - } - oldFi, err := os.Lstat(walkPath) if err != nil { return err diff --git a/registry/template_test.go b/registry/template_test.go index a51717b..019d3b1 100644 --- a/registry/template_test.go +++ b/registry/template_test.go @@ -8,7 +8,7 @@ import ( ) var ( - tmplContents = `{{title name}} (@{{username}}) {{if .bool}}{{.year}}{{end}}` + tmplContents = `{{title name}} {{if .bool}}{{.year}}{{end}}` tmplTemplate = ` name = "john olheiser" @@ -20,11 +20,8 @@ default = "pkg" [bool] default = true - -[username] -default = "username" ` - tmplGold = "John Olheiser (@jolheiser) 2020" + tmplGold = "John Olheiser 2020" tmplNewGold = "DO NOT OVERWRITE!" ) @@ -34,10 +31,6 @@ func testExecute(t *testing.T) { t.Logf("could not set environment: %v", err) t.FailNow() } - if err := os.Setenv("TMPL_VAR_USERNAME", "jolheiser"); err != nil { - t.Logf("could not set environment: %v", err) - t.FailNow() - } // Get template tmpl, err := reg.GetTemplate("test") @@ -72,13 +65,6 @@ func testExecute(t *testing.T) { t.FailNow() } - // Check for .tmplkeep - tmplKeep := filepath.Join(pkgPath, ".tmplkeep") - if _, err := os.Lstat(tmplKeep); err == nil { - t.Logf(".tmplkeep files should NOT be retained upon execution: %s\n", tmplKeep) - t.FailNow() - } - // Change file to test non-overwrite if err := ioutil.WriteFile(testPath, []byte(tmplNewGold), os.ModePerm); err != nil { t.Logf("could not write file: %v\n", err)