Merge pull request #525 from twpayne/add-template

twpayne · web-flow · commit 0f2dcffe69d0 · 2019-12-19T19:58:23.000+01:00
Don't add files if template would be overwritten
diff --git a/cmd/add.go b/cmd/add.go
@@ -24,6 +24,7 @@ var addCmd = &cobra.Command{
 }
 
 type addCmdConfig struct {
+	force     bool
 	recursive bool
 	prompt    bool
 	options   chezmoi.AddOptions
@@ -35,6 +36,7 @@ func init() {
 	persistentFlags := addCmd.PersistentFlags()
 	persistentFlags.BoolVarP(&config.add.options.Empty, "empty", "e", false, "add empty files")
 	persistentFlags.BoolVar(&config.add.options.Encrypt, "encrypt", false, "encrypt files")
+	persistentFlags.BoolVarP(&config.add.force, "force", "f", false, "overwrite source state, even if template would be lost")
 	persistentFlags.BoolVarP(&config.add.options.Exact, "exact", "x", false, "add directories exactly")
 	persistentFlags.BoolVarP(&config.add.prompt, "prompt", "p", false, "prompt before adding")
 	persistentFlags.BoolVarP(&config.add.recursive, "recursive", "r", false, "recurse in to subdirectories")
@@ -75,6 +77,16 @@ func (c *Config) runAddCmd(cmd *cobra.Command, args []string) (err error) {
 					fmt.Fprintf(c.Stderr(), "warning: skipping file ignored by .chezmoiignore: %s\n", path)
 					return nil
 				}
+				if !c.add.force {
+					entry, err := ts.Get(c.fs, path)
+					if err != nil && !os.IsNotExist(err) {
+						return err
+					}
+					if file, ok := entry.(*chezmoi.File); ok && file.Template {
+						fmt.Fprintf(c.Stderr(), "warning: skipping file generated by template, use --force to force: %s\n", path)
+						return nil
+					}
+				}
 				if c.add.prompt {
 					choice, err := c.prompt(fmt.Sprintf("Add %s", path), "ynqa")
 					if err != nil {
@@ -99,6 +111,16 @@ func (c *Config) runAddCmd(cmd *cobra.Command, args []string) (err error) {
 				fmt.Fprintf(c.Stderr(), "warning: skipping file ignored by .chezmoiignore: %s\n", path)
 				continue
 			}
+			if !c.add.force {
+				entry, err := ts.Get(c.fs, path)
+				if err != nil && !os.IsNotExist(err) {
+					return err
+				}
+				if file, ok := entry.(*chezmoi.File); ok && file.Template {
+					fmt.Fprintf(c.Stderr(), "warning: skipping file generated by template, use --force to force: %s\n", path)
+					continue
+				}
+			}
 			if c.add.prompt {
 				choice, err := c.prompt(fmt.Sprintf("Add %s", path), "ynqa")
 				if err != nil {
diff --git a/cmd/helps.gen.go b/cmd/helps.gen.go
diff --git a/completions/chezmoi-completion.bash b/completions/chezmoi-completion.bash
@@ -277,6 +277,8 @@ _chezmoi_add()
     flags+=("--encrypt")
     flags+=("--exact")
     flags+=("-x")
+    flags+=("--force")
+    flags+=("-f")
     flags+=("--prompt")
     flags+=("-p")
     flags+=("--recursive")
diff --git a/completions/chezmoi.fish b/completions/chezmoi.fish
@@ -74,6 +74,7 @@ complete -c chezmoi -f -n '__fish_chezmoi_seen_subcommand_path add'  -s a -l aut
 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'
+complete -c chezmoi -f -n '__fish_chezmoi_seen_subcommand_path add'  -s f -l force -d 'overwrite source state, even if template would be lost'
 complete -c chezmoi -f -n '__fish_chezmoi_seen_subcommand_path add'  -s p -l prompt -d 'prompt before adding'
 complete -c chezmoi -f -n '__fish_chezmoi_seen_subcommand_path add'  -s r -l recursive -d 'recurse in to subdirectories'
 complete -c chezmoi -f -n '__fish_chezmoi_seen_subcommand_path add'  -s T -l template -d 'add files as templates'
diff --git a/completions/chezmoi.zsh b/completions/chezmoi.zsh
@@ -143,6 +143,7 @@ function _chezmoi_add {
     '(-e --empty)'{-e,--empty}'[add empty files]' \
     '--encrypt[encrypt files]' \
     '(-x --exact)'{-x,--exact}'[add directories exactly]' \
+    '(-f --force)'{-f,--force}'[overwrite source state, even if template would be lost]' \
     '(-p --prompt)'{-p,--prompt}'[prompt before adding]' \
     '(-r --recursive)'{-r,--recursive}'[recurse in to subdirectories]' \
     '(-T --template)'{-T,--template}'[add files as templates]' \
diff --git a/docs/CHANGES.md b/docs/CHANGES.md
@@ -2,7 +2,7 @@
 
 <!--- toc --->
 * [Upcoming](#upcoming)
-  * [`gpgRecipient` config variable changing to `gpg.recipient`](#gpgrecipient-config-variable-changing-to-gpgrecipient)
+  * [gpgRecipient config variable changing to gpg.recipient](#gpgrecipient-config-variable-changing-to-gpgrecipient)
 
 ## Upcoming
 
diff --git a/docs/FAQ.md b/docs/FAQ.md
@@ -2,18 +2,18 @@
 
 <!--- toc --->
 * [How can I quickly check for problems with chezmoi on my machine?](#how-can-i-quickly-check-for-problems-with-chezmoi-on-my-machine)
-* [What are the consequences of "bare" modifications to the target files? If my `.zshrc` is managed by chezmoi and I edit `~/.zshrc` without using `chezmoi edit`, what happens?](#what-are-the-consequences-of-bare-modifications-to-the-target-files-if-my-zshrc-is-managed-by-chezmoi-and-i-edit-zshrc-without-using-chezmoi-edit-what-happens)
+* [What are the consequences of &quot;bare&quot; modifications to the target files? If my .zshrc is managed by chezmoi and I edit ~/.zshrc without using chezmoi edit, what happens?](#what-are-the-consequences-of-quotbarequot-modifications-to-the-target-files-if-my-zshrc-is-managed-by-chezmoi-and-i-edit-zshrc-without-using-chezmoi-edit-what-happens)
 * [How can I tell what dotfiles in my home directory aren't managed by chezmoi? Is there an easy way to have chezmoi manage a subset of them?](#how-can-i-tell-what-dotfiles-in-my-home-directory-arent-managed-by-chezmoi-is-there-an-easy-way-to-have-chezmoi-manage-a-subset-of-them)
 * [If there's a mechanism in place for the above, is there also a way to tell chezmoi to ignore specific files or groups of files (e.g. by directory name or by glob)?](#if-theres-a-mechanism-in-place-for-the-above-is-there-also-a-way-to-tell-chezmoi-to-ignore-specific-files-or-groups-of-files-eg-by-directory-name-or-by-glob)
-* [If the target already exists, but is "behind" the source, can chezmoi be configured to preserve the target version before replacing it with one derived from the source?](#if-the-target-already-exists-but-is-behind-the-source-can-chezmoi-be-configured-to-preserve-the-target-version-before-replacing-it-with-one-derived-from-the-source)
+* [If the target already exists, but is &quot;behind&quot; the source, can chezmoi be configured to preserve the target version before replacing it with one derived from the source?](#if-the-target-already-exists-but-is-quotbehindquot-the-source-can-chezmoi-be-configured-to-preserve-the-target-version-before-replacing-it-with-one-derived-from-the-source)
 * [How do I only run a script when a file has changed?](#how-do-i-only-run-a-script-when-a-file-has-changed)
 * [I've made changes to both the destination state and the source state that I want to keep. How can I keep them both?](#ive-made-changes-to-both-the-destination-state-and-the-source-state-that-i-want-to-keep-how-can-i-keep-them-both)
 * [chezmoi's source file naming system cannot handle all possible filenames](#chezmois-source-file-naming-system-cannot-handle-all-possible-filenames)
 * [gpg encryption fails. What could be wrong?](#gpg-encryption-fails-what-could-be-wrong)
 * [I'm getting errors trying to build chezmoi from source](#im-getting-errors-trying-to-build-chezmoi-from-source)
 * [What inspired chezmoi?](#what-inspired-chezmoi)
 * [Can I use chezmoi outside my home directory?](#can-i-use-chezmoi-outside-my-home-directory)
-* [Where does the name "chezmoi" come from?](#where-does-the-name-chezmoi-come-from)
+* [Where does the name &quot;chezmoi&quot; come from?](#where-does-the-name-quotchezmoiquot-come-from)
 * [What other questions have been asked about chezmoi?](#what-other-questions-have-been-asked-about-chezmoi)
 * [Where do I ask a question that isn't answered here?](#where-do-i-ask-a-question-that-isnt-answered-here)
 
diff --git a/docs/REFERENCE.md b/docs/REFERENCE.md
@@ -5,71 +5,71 @@ Manage your dotfiles securely across multiple machines.
 <!--- toc --->
 * [Concepts](#concepts)
 * [Global command line flags](#global-command-line-flags)
-  * [`--color` *value*](#--color-value)
-  * [`-c`, `--config` *filename*](#-c---config-filename)
-  * [`--debug`](#--debug)
-  * [`-D`, `--destination` *directory*](#-d---destination-directory)
-  * [`-f`, `--follow`](#-f---follow)
-  * [`-n`, `--dry-run`](#-n---dry-run)
-  * [`-h`, `--help`](#-h---help)
-  * [`-r`. `--remove`](#-r---remove)
-  * [`-S`, `--source` *directory*](#-s---source-directory)
-  * [`-v`, `--verbose`](#-v---verbose)
-  * [`--version`](#--version)
+  * [--color value](#--color-value)
+  * [-c, --config filename](#-c---config-filename)
+  * [--debug](#--debug)
+  * [-D, --destination directory](#-d---destination-directory)
+  * [-f, --follow](#-f---follow)
+  * [-n, --dry-run](#-n---dry-run)
+  * [-h, --help](#-h---help)
+  * [-r. --remove](#-r---remove)
+  * [-S, --source directory](#-s---source-directory)
+  * [-v, --verbose](#-v---verbose)
+  * [--version](#--version)
 * [Configuration file](#configuration-file)
   * [Configuration variables](#configuration-variables)
 * [Source state attributes](#source-state-attributes)
 * [Special files and directories](#special-files-and-directories)
-  * [`.chezmoi.<format>.tmpl`](#chezmoiformattmpl)
-  * [`.chezmoiignore`](#chezmoiignore)
-  * [`.chezmoiremove`](#chezmoiremove)
-  * [`.chezmoitemplates`](#chezmoitemplates)
-  * [`.chezmoiversion`](#chezmoiversion)
+  * [.chezmoi.&lt;format&gt;.tmpl](#chezmoiltformatgttmpl)
+  * [.chezmoiignore](#chezmoiignore)
+  * [.chezmoiremove](#chezmoiremove)
+  * [.chezmoitemplates](#chezmoitemplates)
+  * [.chezmoiversion](#chezmoiversion)
 * [Commands](#commands)
-  * [`add` *targets*](#add-targets)
-  * [`apply` [*targets*]](#apply-targets)
-  * [`archive`](#archive)
-  * [`cat` targets](#cat-targets)
-  * [`cd`](#cd)
-  * [`chattr` *attributes* *targets*](#chattr-attributes-targets)
-  * [`completion` *shell*](#completion-shell)
-  * [`data`](#data)
-  * [`diff` [*targets*]](#diff-targets)
-  * [`docs` [*regexp*]](#docs-regexp)
-  * [`doctor`](#doctor)
-  * [`dump` [*targets*]](#dump-targets)
-  * [`edit` [*targets*]](#edit-targets)
-  * [`edit-config`](#edit-config)
-  * [`forget` *targets*](#forget-targets)
-  * [`help` *command*](#help-command)
-  * [`init` [*repo*]](#init-repo)
-  * [`import` *filename*](#import-filename)
-  * [`merge` *targets*](#merge-targets)
-  * [`remove` *targets*](#remove-targets)
-  * [`secret`](#secret)
-  * [`source` [*args*]](#source-args)
-  * [`source-path` [*targets*]](#source-path-targets)
-  * [`unmanaged`](#unmanaged)
-  * [`update`](#update)
-  * [`upgrade`](#upgrade)
-  * [`verify` [*targets*]](#verify-targets)
+  * [add targets](#add-targets)
+  * [apply [targets]](#apply-targets)
+  * [archive](#archive)
+  * [cat targets](#cat-targets)
+  * [cd](#cd)
+  * [chattr attributes targets](#chattr-attributes-targets)
+  * [completion shell](#completion-shell)
+  * [data](#data)
+  * [diff [targets]](#diff-targets)
+  * [docs [regexp]](#docs-regexp)
+  * [doctor](#doctor)
+  * [dump [targets]](#dump-targets)
+  * [edit [targets]](#edit-targets)
+  * [edit-config](#edit-config)
+  * [forget targets](#forget-targets)
+  * [help command](#help-command)
+  * [init [repo]](#init-repo)
+  * [import filename](#import-filename)
+  * [merge targets](#merge-targets)
+  * [remove targets](#remove-targets)
+  * [secret](#secret)
+  * [source [args]](#source-args)
+  * [source-path [targets]](#source-path-targets)
+  * [unmanaged](#unmanaged)
+  * [update](#update)
+  * [upgrade](#upgrade)
+  * [verify [targets]](#verify-targets)
 * [Editor configuration](#editor-configuration)
 * [Umask configuration](#umask-configuration)
 * [Template variables](#template-variables)
 * [Template functions](#template-functions)
-  * [`bitwarden` [*args*]](#bitwarden-args)
-  * [`gopass` *gopass-name*](#gopass-gopass-name)
-  * [`keepassxc` *entry*](#keepassxc-entry)
-  * [`keepassxcAttribute` *entry* *attribute*](#keepassxcattribute-entry-attribute)
-  * [`keyring` *service* *user*](#keyring-service-user)
-  * [`lastpass` *id*](#lastpass-id)
-  * [`onepassword` *uuid*](#onepassword-uuid)
-  * [`onepasswordDocument` *uuid*](#onepassworddocument-uuid)
-  * [`pass` *pass-name*](#pass-pass-name)
-  * [`promptString` *prompt*](#promptstring-prompt)
-  * [`secret` [*args*]](#secret-args)
-  * [`secretJSON` [*args*]](#secretjson-args)
-  * [`vault` *key*](#vault-key)
+  * [bitwarden [args]](#bitwarden-args)
+  * [gopass gopass-name](#gopass-gopass-name)
+  * [keepassxc entry](#keepassxc-entry)
+  * [keepassxcAttribute entry attribute](#keepassxcattribute-entry-attribute)
+  * [keyring service user](#keyring-service-user)
+  * [lastpass id](#lastpass-id)
+  * [onepassword uuid](#onepassword-uuid)
+  * [onepasswordDocument uuid](#onepassworddocument-uuid)
+  * [pass pass-name](#pass-pass-name)
+  * [promptString prompt](#promptstring-prompt)
+  * [secret [args]](#secret-args)
+  * [secretJSON [args]](#secretjson-args)
+  * [vault key](#vault-key)
 
 ## Concepts
 
@@ -322,6 +322,10 @@ directory. The `add` command accepts additional flags:
 
 Set the `empty` attribute on added files.
 
+#### `-f`, `--force`
+
+Add *targets*, even if doing so would cause a source template to be overwritten.
+
 #### `-x`, `--exact`
 
 Set the `exact` attribute on added directories.
