fix: Make execute-template --init not read .chezmoitemplates

assets/chezmoi.io/docs/reference/special-files-and-directories/chezmoi-format-tmpl.md

@@ -1,8 +1,10 @@
 # `.chezmoi.$FORMAT.tmpl`
 
 If a file called `.chezmoi.$FORMAT.tmpl` exists then `chezmoi init` will use it
-to create an initial config file. `$FORMAT` must be one of the supported
-config file formats, e.g. `json`, `jsonc`, `toml`, or `yaml`.
+to create an initial config file. `$FORMAT` must be one of the supported config
+file formats, e.g. `json`, `jsonc`, `toml`, or `yaml`. Templates defined in
+`.chezmoitemplates` are not available because the template is executed before
+the source state is read.
 
 !!! example
 

internal/chezmoi/sourcestate.go

@@ -131,6 +131,7 @@ type SourceState struct {
 	defaultTemplateDataFunc func() map[string]any
 	templateDataOnly        bool
 	readTemplateData        bool
+	readTemplates           bool
 	defaultTemplateData     map[string]any
 	userTemplateData        map[string]any
 	priorityTemplateData    map[string]any
@@ -222,6 +223,13 @@ func WithReadTemplateData(readTemplateData bool) SourceStateOption {
 	}
 }
 
+// WithReadTemplates sets whether to read .chezmoitemplates directories.
+func WithReadTemplates(readTemplates bool) SourceStateOption {
+	return func(s *SourceState) {
+		s.readTemplates = readTemplates
+	}
+}
+
 // WithSourceDir sets the source directory.
 func WithSourceDir(sourceDirAbsPath AbsPath) SourceStateOption {
 	return func(s *SourceState) {
@@ -286,6 +294,7 @@ func NewSourceState(options ...SourceStateOption) *SourceState {
 		httpClient:           http.DefaultClient,
 		logger:               &log.Logger,
 		readTemplateData:     true,
+		readTemplates:        true,
 		priorityTemplateData: make(map[string]any),
 		userTemplateData:     make(map[string]any),
 		templateOptions:      DefaultTemplateOptions,
@@ -945,8 +954,10 @@ func (s *SourceState) Read(ctx context.Context, options *ReadOptions) error {
 			}
 			return s.addTemplateData(sourceAbsPath)
 		case fileInfo.Name() == TemplatesDirName:
-			if err := s.addTemplatesDir(ctx, sourceAbsPath); err != nil {
-				return err
+			if s.readTemplates {
+				if err := s.addTemplatesDir(ctx, sourceAbsPath); err != nil {
+					return err
+				}
 			}
 			return fs.SkipDir
 		case s.templateDataOnly:

internal/cmd/executetemplatecmd.go

@@ -99,6 +99,7 @@ func (c *Config) newExecuteTemplateCmd() *cobra.Command {
 func (c *Config) runExecuteTemplateCmd(cmd *cobra.Command, args []string) error {
 	options := []chezmoi.SourceStateOption{
 		chezmoi.WithTemplateDataOnly(true),
+		chezmoi.WithReadTemplates(!c.executeTemplate.init),
 	}
 	if c.executeTemplate.init {
 		options = append(options, chezmoi.WithReadTemplateData(false))

internal/cmd/testdata/scripts/issue3418.txtar

@@ -0,0 +1,14 @@
+# test that chezmoi execute-template --init does read .chezmoitemplates
+stdin $CHEZMOISOURCEDIR/.chezmoi.toml.tmpl
+exec chezmoi execute-template
+stdout 'contents of template'
+
+# test that chezmoi execute-template --init does not read .chezmoitemplates
+stdin $CHEZMOISOURCEDIR/.chezmoi.toml.tmpl
+! exec chezmoi execute-template --init
+! stdout 'contents of template'
+
+-- home/user/.local/share/chezmoi/.chezmoi.toml.tmpl --
+{{ template "template" }}
+-- home/user/.local/share/chezmoi/.chezmoitemplates/template --
+# contents of template