Merge pull request #404 from twpayne/disable-autotemplate

Disable autotemplate by default

Author: twpayne

cmd/add.go

@@ -39,6 +39,7 @@ func init() {
 	persistentFlags.BoolVarP(&config.add.prompt, "prompt", "p", false, "prompt before adding")
 	persistentFlags.BoolVarP(&config.add.recursive, "recursive", "r", false, "recurse in to subdirectories")
 	persistentFlags.BoolVarP(&config.add.options.Template, "template", "T", false, "add files as templates")
+	persistentFlags.BoolVarP(&config.add.options.AutoTemplate, "autotemplate", "a", false, "auto generate the template when adding files as templates")
 }
 
 func (c *Config) runAddCmd(fs vfs.FS, args []string) (err error) {

cmd/add_test.go

@@ -72,7 +72,8 @@ func TestAddCommand(t *testing.T) {
 			args: []string{"/home/user/.gitconfig"},
 			add: addCmdConfig{
 				options: chezmoi.AddOptions{
-					Template: true,
+					Template:     true,
+					AutoTemplate: true,
 				},
 			},
 			root: map[string]interface{}{
@@ -87,6 +88,28 @@ func TestAddCommand(t *testing.T) {
 				),
 			},
 		},
+		{
+			// Test for PR #393
+			// Ensure that auto template generating is disabled by default
+			name: "add_autotemplate_off_by_default",
+			args: []string{"/home/user/.gitconfig"},
+			add: addCmdConfig{
+				options: chezmoi.AddOptions{
+					Template: true,
+				},
+			},
+			root: map[string]interface{}{
+				"/home/user":            &vfst.Dir{Perm: 0755},
+				"/home/user/.chezmoi":   &vfst.Dir{Perm: 0700},
+				"/home/user/.gitconfig": "[user]\n\tname = John Smith\n\temail = john.smith@company.com\n",
+			},
+			tests: []vfst.Test{
+				vfst.TestPath("/home/user/.chezmoi/dot_gitconfig.tmpl",
+					vfst.TestModeIsRegular,
+					vfst.TestContentsString("[user]\n\tname = John Smith\n\temail = john.smith@company.com\n"),
+				),
+			},
+		},
 		{
 			name: "add_recursive",
 			args: []string{"/home/user/.config"},

cmd/helps.gen.go

@@ -38,10 +38,10 @@ var helps = map[string]help{
 			"\n" +
 			"\"-T\", \"--template\"\n" +
 			"\n" +
-			"Set the \"template\" attribute on added files and symlinks. In addition, chezmoi\n" +
-			"attempts to automatically generate the template by replacing any template data\n" +
-			"values with the equivalent template data keys. Longer subsitutions occur before\n" +
-			"shorter ones.\n",
+			"Set the \"template\" attribute on added files and symlinks. In addition, \"if\n" +
+			"the \"--template-auto-generate\" flag is set, chezmoi attempts to automatically\n" +
+			"generate the template by replacing any template data values with the equivalent\n" +
+			"template data keys. Longer subsitutions occur before shorter ones.\n",
 		example: "" +
 			"  chezmoi add ~/.bashrc\n" +
 			"  chezmoi add ~/.gitconfig --template\n" +

completions/chezmoi-completion.bash

@@ -264,6 +264,8 @@ _chezmoi_add()
     flags_with_completion=()
     flags_completion=()
 
+    flags+=("--autotemplate")
+    flags+=("-a")
     flags+=("--empty")
     flags+=("-e")
     flags+=("--encrypt")

completions/chezmoi.fish

@@ -68,6 +68,7 @@ complete -c chezmoi -f -n '__fish_chezmoi_no_subcommand'  -s n -l dry-run -d 'dr
 complete -c chezmoi -f -n '__fish_chezmoi_no_subcommand'   -l remove -d 'remove targets'
 complete -c chezmoi -f -n '__fish_chezmoi_no_subcommand' -r -s S -l source -d 'source directory'
 complete -c chezmoi -f -n '__fish_chezmoi_no_subcommand'  -s v -l verbose -d 'verbose'
+complete -c chezmoi -f -n '__fish_chezmoi_seen_subcommand_path add'  -s a -l autotemplate -d 'auto generate the template when adding files as templates'
 complete -c chezmoi -f -n '__fish_chezmoi_seen_subcommand_path add'  -s e -l empty -d 'add empty files'
 complete -c chezmoi -f -n '__fish_chezmoi_seen_subcommand_path add'   -l encrypt -d 'encrypt files'
 complete -c chezmoi -f -n '__fish_chezmoi_seen_subcommand_path add'  -s x -l exact -d 'add directories exactly'

docs/REFERENCE.md

@@ -320,9 +320,10 @@ Recursively add all files, directories, and symlinks.
 
 #### `-T`, `--template`
 
-Set the `template` attribute on added files and symlinks. In addition, chezmoi
-attempts to automatically generate the template by replacing any template data
-values with the equivalent template data keys. Longer subsitutions occur before
+Set the `template` attribute on added files and symlinks. In addition, "if the
+`--template-auto-generate` flag is set, chezmoi attempts to automatically
+generate the template by replacing any template data values with the equivalent
+template data keys. Longer subsitutions occur before
 shorter ones.
 
 #### `add` examples

lib/chezmoi/targetstate.go

@@ -26,11 +26,12 @@ const (
 
 // An AddOptions contains options for TargetState.Add.
 type AddOptions struct {
-	Empty    bool
-	Encrypt  bool
-	Exact    bool
-	Follow   bool
-	Template bool
+	Empty        bool
+	Encrypt      bool
+	Exact        bool
+	Follow       bool
+	Template     bool
+	AutoTemplate bool
 }
 
 // An ImportTAROptions contains options for TargetState.ImportTAR.
@@ -153,7 +154,7 @@ func (ts *TargetState) Add(fs vfs.FS, addOptions AddOptions, targetPath string,
 		if err != nil {
 			return err
 		}
-		if addOptions.Template {
+		if addOptions.Template && addOptions.AutoTemplate {
 			contents = autoTemplate(contents, ts.Data)
 		}
 		if addOptions.Encrypt {