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/CLI.md b/CLI.md index c7c5a8d..0850bb6 100644 --- a/CLI.md +++ b/CLI.md @@ -32,10 +32,6 @@ Download a template **--branch, -b**="": Branch to clone (default: main) -## env - -Show tmpl environment variables - ## init Initialize a template @@ -48,10 +44,6 @@ List templates in the registry Remove a template -## restore - -Restore missing templates - ## save Save a local template diff --git a/DOCS.md b/DOCS.md index 7a3f2b9..57ffe31 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 @@ -112,20 +108,4 @@ I realize that many users will be using GitHub, and most will likely still be us 1. `tmpl source add https://github.com github` 2. Set the env variable `TMPL_SOURCE` to `github` 2. Set the env variable `TMPL_BRANCH` to `master` -3. Happy templating! `tmpl download user/repo repo` - -## Backup and Restore - -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 +3. Happy templating! `tmpl download user/repo repo` \ No newline at end of file diff --git a/Makefile b/Makefile index 9a94c1d..6023d00 100644 --- a/Makefile +++ b/Makefile @@ -17,10 +17,6 @@ fmt: test: $(GO) test -race ./... -.PHONY: lint -lint: - earth +lint - .PHONY: docs docs: $(GO) run docs.go diff --git a/cmd/app.go b/cmd/app.go index 71c130c..2c414c1 100644 --- a/cmd/app.go +++ b/cmd/app.go @@ -51,11 +51,9 @@ func NewApp() *cli.App { app.Commands = []*cli.Command{ Download, - Env, Init, List, Remove, - Restore, Save, Source, Test, diff --git a/cmd/env.go b/cmd/env.go deleted file mode 100644 index 3ecc12d..0000000 --- a/cmd/env.go +++ /dev/null @@ -1,34 +0,0 @@ -package cmd - -import ( - "os" - - "github.com/urfave/cli/v2" - "go.jolheiser.com/beaver" - "go.jolheiser.com/beaver/color" -) - -var Env = &cli.Command{ - Name: "env", - Usage: "Show tmpl environment variables", - Description: "Show tmpl environment variables and their configuration", - Action: runEnv, -} - -func runEnv(_ *cli.Context) error { - - // Source - beaver.Infof("TMPL_SOURCE: %s", getEnv("TMPL_SOURCE")) - - // Registry Path - beaver.Infof("TMPL_REGISTRY: %s", getEnv("TMPL_REGISTRY")) - - // Branch - beaver.Infof("TMPL_BRANCH: %s", getEnv("TMPL_BRANCH")) - - return nil -} - -func getEnv(key string) string { - return color.FgHiBlue.Format(os.Getenv(key)) -} diff --git a/cmd/list.go b/cmd/list.go index 4f7143d..ec4f5ed 100644 --- a/cmd/list.go +++ b/cmd/list.go @@ -25,7 +25,7 @@ func runList(_ *cli.Context) error { } wr := tabwriter.NewWriter(os.Stdout, 0, 8, 1, '\t', 0) - if _, err := fmt.Fprintf(wr, "NAME\tURL\tLOCAL\tLAST UPDATED\n"); err != nil { + if _, err := fmt.Fprintf(wr, "NAME\tURL\tLOCAL\tUPDATED\n"); err != nil { return err } for _, t := range reg.Templates { @@ -35,7 +35,7 @@ func runList(_ *cli.Context) error { u = t.Path local = true } - if _, err := fmt.Fprintf(wr, "%s\t%s\t%t\t%s\n", t.Name, u, local, t.LastUpdate.Format("01/02/2006")); err != nil { + if _, err := fmt.Fprintf(wr, "%s\t%s\t%t\t%s\n", t.Name, u, local, t.Created.Format("01/02/2006")); err != nil { return err } } diff --git a/cmd/restore.go b/cmd/restore.go deleted file mode 100644 index b6a1ecc..0000000 --- a/cmd/restore.go +++ /dev/null @@ -1,39 +0,0 @@ -package cmd - -import ( - "os" - - "go.jolheiser.com/tmpl/cmd/flags" - "go.jolheiser.com/tmpl/registry" - - "github.com/urfave/cli/v2" - "go.jolheiser.com/beaver" -) - -var Restore = &cli.Command{ - Name: "restore", - Usage: "Restore missing templates", - Description: "Restore templates that are listed in the registry, but are missing archives", - Action: runRestore, -} - -func runRestore(_ *cli.Context) error { - reg, err := registry.Open(flags.Registry) - if err != nil { - return err - } - - var num int - for _, tmpl := range reg.Templates { - if _, err := os.Lstat(tmpl.ArchivePath()); os.IsNotExist(err) { - beaver.Infof("Restoring %s...", tmpl.Name) - if err := reg.UpdateTemplate(tmpl.Name); err != nil { - return err - } - num++ - } - } - - beaver.Infof("Restored %d templates.", num) - return nil -} diff --git a/cmd/update.go b/cmd/update.go index f20ae94..38cff98 100644 --- a/cmd/update.go +++ b/cmd/update.go @@ -31,7 +31,16 @@ func runUpdate(ctx *cli.Context) error { return err } - if err := reg.UpdateTemplate(tmpl.Name); err != nil { + if err := reg.RemoveTemplate(tmpl.Name); err != nil { + return err + } + + if tmpl.Path != "" { + _, err = reg.SaveTemplate(tmpl.Name, tmpl.Path) + } else { + _, err = reg.DownloadTemplate(tmpl.Name, tmpl.Repository, tmpl.Branch) + } + if err != nil { return err } 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/go.mod b/go.mod index 2aca801..44fa718 100644 --- a/go.mod +++ b/go.mod @@ -6,11 +6,8 @@ require ( github.com/AlecAivazis/survey/v2 v2.2.2 github.com/go-git/go-git/v5 v5.2.0 github.com/huandu/xstrings v1.3.2 - github.com/mattn/go-isatty v0.0.12 // indirect github.com/mholt/archiver/v3 v3.5.0 github.com/pelletier/go-toml v1.8.1 github.com/urfave/cli/v2 v2.3.0 go.jolheiser.com/beaver v1.0.2 - golang.org/x/crypto v0.0.0-20201112155050-0c6587e931a9 // indirect - golang.org/x/sys v0.0.0-20201113135734-0a15ea8d9b02 // indirect ) diff --git a/go.sum b/go.sum index 08f2928..701e1fa 100644 --- a/go.sum +++ b/go.sum @@ -68,8 +68,6 @@ github.com/mattn/go-colorable v0.1.2 h1:/bC9yWikZXAL9uJdulbSfyVNIR3n3trXl+v8+1sx github.com/mattn/go-colorable v0.1.2/go.mod h1:U0ppj6V5qS13XJ6of8GYAs25YV2eR4EVcfRqFIhoBtE= github.com/mattn/go-isatty v0.0.8 h1:HLtExJ+uU2HOZ+wI0Tt5DtUDrx8yhUqDcp7fYERX4CE= github.com/mattn/go-isatty v0.0.8/go.mod h1:Iq45c/XA43vh69/j3iqttzPXn0bhXyGjM0Hdxcsrc5s= -github.com/mattn/go-isatty v0.0.12 h1:wuysRhFDzyxgEmMf5xjvJ2M9dZoWAXNNr5LSBS7uHXY= -github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU= github.com/mgutz/ansi v0.0.0-20170206155736-9520e82c474b h1:j7+1HpAFS1zy5+Q4qx1fWh90gTKwiN4QCGoY9TWyyO4= github.com/mgutz/ansi v0.0.0-20170206155736-9520e82c474b/go.mod h1:01TrycV0kFyexm33Z7vhZRXopbI8J3TDReVlkTgMUxE= github.com/mholt/archiver/v3 v3.5.0 h1:nE8gZIrw66cu4osS/U7UW7YDuGMHssxKutU8IfWxwWE= @@ -114,8 +112,6 @@ golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACk golang.org/x/crypto v0.0.0-20190530122614-20be4c3c3ed5/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= golang.org/x/crypto v0.0.0-20200302210943-78000ba7a073 h1:xMPOj6Pz6UipU1wXLkrtqpHbR0AVFnyPEQq/wRWz9lM= golang.org/x/crypto v0.0.0-20200302210943-78000ba7a073/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= -golang.org/x/crypto v0.0.0-20201112155050-0c6587e931a9 h1:umElSU9WZirRdgu2yFHY0ayQkEnKiOC1TtM3fWXFnoU= -golang.org/x/crypto v0.0.0-20201112155050-0c6587e931a9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= golang.org/x/net v0.0.0-20200301022130-244492dfa37a h1:GuSPYbZzB5/dcLNCwLQLsg3obCJtX9IJhpXkvY7kzk0= golang.org/x/net v0.0.0-20200301022130-244492dfa37a/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= @@ -126,11 +122,8 @@ golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7w golang.org/x/sys v0.0.0-20190530182044-ad28b68e88f1/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20190813064441-fde4db37ae7a h1:aYOabOQFp6Vj6W1F80affTUvO9UxmJRx8K0gsfABByQ= golang.org/x/sys v0.0.0-20190813064441-fde4db37ae7a/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= -golang.org/x/sys v0.0.0-20200116001909-b77594299b42/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200302150141-5c8b2ff67527 h1:uYVVQ9WP/Ds2ROhcaGPeIdVq0RIXVLwsHlnvJ+cT1So= golang.org/x/sys v0.0.0-20200302150141-5c8b2ff67527/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= -golang.org/x/sys v0.0.0-20201113135734-0a15ea8d9b02 h1:5Ftd3YbC/kANXWCBjvppvUmv1BMakgFcBKA7MpYYp4M= -golang.org/x/sys v0.0.0-20201113135734-0a15ea8d9b02/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.2 h1:tW2bmiBqwgJj/UpqtC8EpXEZVYOwU0yG4iWbprSVAcs= golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk= diff --git a/registry/error.go b/registry/error.go index f7950f4..d85f168 100644 --- a/registry/error.go +++ b/registry/error.go @@ -2,19 +2,6 @@ package registry import "fmt" -type ErrTemplateExists struct { - Name string -} - -func (e ErrTemplateExists) Error() string { - return fmt.Sprintf("template %s already exists", e.Name) -} - -func IsErrTemplateExists(err error) bool { - _, ok := err.(ErrTemplateExists) - return ok -} - type ErrTemplateNotFound struct { Name string } 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.go b/registry/registry.go index d2ddf01..f685756 100644 --- a/registry/registry.go +++ b/registry/registry.go @@ -50,16 +50,12 @@ func (r *Registry) GetTemplate(name string) (*Template, error) { // DownloadTemplate downloads and adds a new Template to the Registry func (r *Registry) DownloadTemplate(name, repo, branch string) (*Template, error) { - if _, err := r.GetTemplate(name); err == nil { - return nil, ErrTemplateExists{Name: name} - } - t := &Template{ reg: r, Name: name, Repository: repo, Branch: branch, - LastUpdate: time.Now(), + Created: time.Now(), } r.Templates = append(r.Templates, t) @@ -72,15 +68,11 @@ func (r *Registry) DownloadTemplate(name, repo, branch string) (*Template, error // SaveTemplate saves a local Template to the Registry func (r *Registry) SaveTemplate(name, path string) (*Template, error) { - if _, err := r.GetTemplate(name); err == nil { - return nil, ErrTemplateExists{Name: name} - } - t := &Template{ - reg: r, - Name: name, - Path: path, - LastUpdate: time.Now(), + reg: r, + Name: name, + Path: path, + Created: time.Now(), } r.Templates = append(r.Templates, t) @@ -97,48 +89,16 @@ func (r *Registry) RemoveTemplate(name string) error { if err != nil { return err } - for idx, t := range r.Templates { if strings.EqualFold(name, t.Name) { r.Templates = append(r.Templates[:idx], r.Templates[idx+1:]...) if err := os.Remove(t.ArchivePath()); err != nil { return err } - return r.save() } } - return nil -} - -// RemoveTemplate updates the Template on disk and in meta -func (r *Registry) UpdateTemplate(name string) error { - _, err := r.GetTemplate(name) - if err != nil { - return err - } - - for idx, t := range r.Templates { - if strings.EqualFold(name, t.Name) { - // If the path doesn't exist, we are replacing it regardless - if err := os.Remove(t.ArchivePath()); err != nil && !os.IsNotExist(err) { - return err - } - - // Cut it out of the template list so we don't get a duplicate - r.Templates = append(r.Templates[:idx], r.Templates[idx+1:]...) - - // If path exists, it is local - if t.Path != "" { - _, err = r.SaveTemplate(t.Name, t.Path) - } else { - _, err = r.DownloadTemplate(t.Name, t.Repository, t.Branch) - } - return err - } - } - - return nil + return r.save() } // GetSource retrieves a Source from the Registry @@ -199,16 +159,7 @@ func Open(dir string) (*Registry, error) { if err != nil { return nil, err } - - if err := tree.Unmarshal(®); err != nil { - return nil, err - } - - for _, tmpl := range reg.Templates { - tmpl.reg = ® - } - - return ®, nil + return ®, tree.Unmarshal(®) } func create(regFile string) error { @@ -235,12 +186,11 @@ func download(cloneURL, branch, dest string) error { ReferenceName: plumbing.NewBranchReferenceName(branch), SingleBranch: true, Depth: 1, - Progress: os.Stdout, }); err != nil { return err } - // Remove .git + // RemoveTemplate .git if err := os.RemoveAll(filepath.Join(tmp, ".git")); err != nil { return err } 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..6703f14 100644 --- a/registry/template.go +++ b/registry/template.go @@ -20,7 +20,7 @@ type Template struct { Path string `toml:"path"` Repository string `toml:"repository"` Branch string `toml:"branch"` - LastUpdate time.Time `toml:"last_update"` + Created time.Time `toml:"created"` } // ArchiveName is the name given to the archive for this Template @@ -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)