-
Notifications
You must be signed in to change notification settings - Fork 467
/
config.go
2910 lines (2672 loc) · 94.2 KB
/
config.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package cmd
import (
"bufio"
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"io/fs"
"log/slog"
"maps"
"net/http"
"os"
"os/exec"
"os/user"
"path/filepath"
"reflect"
"regexp"
"runtime"
"runtime/pprof"
"slices"
"sort"
"strconv"
"strings"
"text/template"
"time"
"unicode"
"github.com/Masterminds/sprig/v3"
"github.com/coreos/go-semver/semver"
"github.com/go-git/go-git/v5"
"github.com/go-git/go-git/v5/plumbing/format/diff"
"github.com/gregjones/httpcache"
"github.com/gregjones/httpcache/diskcache"
"github.com/mitchellh/mapstructure"
"github.com/muesli/termenv"
"github.com/spf13/cobra"
"github.com/spf13/pflag"
"github.com/twpayne/go-shell"
"github.com/twpayne/go-vfs/v5"
"github.com/twpayne/go-xdg/v6"
"github.com/zricethezav/gitleaks/v8/detect"
"golang.org/x/term"
"mvdan.cc/sh/v3/expand"
"mvdan.cc/sh/v3/syntax"
"github.com/twpayne/chezmoi/v2/assets/templates"
"github.com/twpayne/chezmoi/v2/internal/chezmoi"
"github.com/twpayne/chezmoi/v2/internal/chezmoierrors"
"github.com/twpayne/chezmoi/v2/internal/chezmoigit"
"github.com/twpayne/chezmoi/v2/internal/chezmoilog"
"github.com/twpayne/chezmoi/v2/internal/chezmoiset"
)
// defaultSentinel is a string value used to indicate that the default value
// should be used. It is a string unlikely to be an actual value set by the
// user.
const defaultSentinel = "\x00"
const (
logComponentKey = "component"
logComponentValueEncryption = "encryption"
logComponentValuePersistentState = "persistentState"
logComponentValueSourceState = "sourceState"
logComponentValueSystem = "system"
)
type doPurgeOptions struct {
binary bool
cache bool
config bool
persistentState bool
sourceDir bool
workingTree bool
}
type commandConfig struct {
Command string `json:"command" mapstructure:"command" yaml:"command"`
Args []string `json:"args" mapstructure:"args" yaml:"args"`
}
type hookConfig struct {
Pre commandConfig `json:"pre" mapstructure:"pre" yaml:"pre"`
Post commandConfig `json:"post" mapstructure:"post" yaml:"post"`
}
type templateConfig struct {
Options []string `json:"options" mapstructure:"options" yaml:"options"`
}
type warningsConfig struct {
ConfigFileTemplateHasChanged bool `json:"configFileTemplateHasChanged" mapstructure:"configFileTemplateHasChanged" yaml:"configFileTemplateHasChanged"`
}
// ConfigFile contains all data settable in the config file.
type ConfigFile struct {
// Global configuration.
CacheDirAbsPath chezmoi.AbsPath `json:"cacheDir" mapstructure:"cacheDir" yaml:"cacheDir"`
Color autoBool `json:"color" mapstructure:"color" yaml:"color"`
Data map[string]any `json:"data" mapstructure:"data" yaml:"data"`
Env map[string]string `json:"env" mapstructure:"env" yaml:"env"`
Format writeDataFormat `json:"format" mapstructure:"format" yaml:"format"`
DestDirAbsPath chezmoi.AbsPath `json:"destDir" mapstructure:"destDir" yaml:"destDir"`
GitHub gitHubConfig `json:"gitHub" mapstructure:"gitHub" yaml:"gitHub"`
Hooks map[string]hookConfig `json:"hooks" mapstructure:"hooks" yaml:"hooks"`
Interpreters map[string]chezmoi.Interpreter `json:"interpreters" mapstructure:"interpreters" yaml:"interpreters"`
Mode chezmoi.Mode `json:"mode" mapstructure:"mode" yaml:"mode"`
Pager string `json:"pager" mapstructure:"pager" yaml:"pager"`
PersistentStateAbsPath chezmoi.AbsPath `json:"persistentState" mapstructure:"persistentState" yaml:"persistentState"`
PINEntry pinEntryConfig `json:"pinentry" mapstructure:"pinentry" yaml:"pinentry"`
Progress autoBool `json:"progress" mapstructure:"progress" yaml:"progress"`
Safe bool `json:"safe" mapstructure:"safe" yaml:"safe"`
ScriptEnv map[string]string `json:"scriptEnv" mapstructure:"scriptEnv" yaml:"scriptEnv"`
ScriptTempDir chezmoi.AbsPath `json:"scriptTempDir" mapstructure:"scriptTempDir" yaml:"scriptTempDir"`
SourceDirAbsPath chezmoi.AbsPath `json:"sourceDir" mapstructure:"sourceDir" yaml:"sourceDir"`
Template templateConfig `json:"template" mapstructure:"template" yaml:"template"`
TextConv textConv `json:"textConv" mapstructure:"textConv" yaml:"textConv"`
Umask fs.FileMode `json:"umask" mapstructure:"umask" yaml:"umask"`
UseBuiltinAge autoBool `json:"useBuiltinAge" mapstructure:"useBuiltinAge" yaml:"useBuiltinAge"`
UseBuiltinGit autoBool `json:"useBuiltinGit" mapstructure:"useBuiltinGit" yaml:"useBuiltinGit"`
Verbose bool `json:"verbose" mapstructure:"verbose" yaml:"verbose"`
Warnings warningsConfig `json:"warnings" mapstructure:"warnings" yaml:"warnings"`
WorkingTreeAbsPath chezmoi.AbsPath `json:"workingTree" mapstructure:"workingTree" yaml:"workingTree"`
// Password manager configurations.
AWSSecretsManager awsSecretsManagerConfig `json:"awsSecretsManager" mapstructure:"awsSecretsManager" yaml:"awsSecretsManager"`
AzureKeyVault azureKeyVaultConfig `json:"azureKeyVault" mapstructure:"azureKeyVault" yaml:"azureKeyVault"`
Bitwarden bitwardenConfig `json:"bitwarden" mapstructure:"bitwarden" yaml:"bitwarden"`
BitwardenSecrets bitwardenSecretsConfig `json:"bitwardenSecrets" mapstructure:"bitwardenSecrets" yaml:"bitwardenSecrets"`
Dashlane dashlaneConfig `json:"dashlane" mapstructure:"dashlane" yaml:"dashlane"`
Doppler dopplerConfig `json:"doppler" mapstructure:"doppler" yaml:"doppler"`
Ejson ejsonConfig `json:"ejson" mapstructure:"ejson" yaml:"ejson"`
Gopass gopassConfig `json:"gopass" mapstructure:"gopass" yaml:"gopass"`
HCPVaultSecrets hcpVaultSecretConfig `json:"hcpVaultSecrets" mapstructure:"hcpVaultSecrets" yaml:"hcpVaultSecrets"`
Keepassxc keepassxcConfig `json:"keepassxc" mapstructure:"keepassxc" yaml:"keepassxc"`
Keeper keeperConfig `json:"keeper" mapstructure:"keeper" yaml:"keeper"`
Lastpass lastpassConfig `json:"lastpass" mapstructure:"lastpass" yaml:"lastpass"`
Onepassword onepasswordConfig `json:"onepassword" mapstructure:"onepassword" yaml:"onepassword"`
Pass passConfig `json:"pass" mapstructure:"pass" yaml:"pass"`
Passhole passholeConfig `json:"passhole" mapstructure:"passhole" yaml:"passhole"`
RBW rbwConfig `json:"rbw" mapstructure:"rbw" yaml:"rbw"`
Secret secretConfig `json:"secret" mapstructure:"secret" yaml:"secret"`
Vault vaultConfig `json:"vault" mapstructure:"vault" yaml:"vault"`
// Encryption configurations.
Encryption string `json:"encryption" mapstructure:"encryption" yaml:"encryption"`
Age chezmoi.AgeEncryption `json:"age" mapstructure:"age" yaml:"age"`
GPG chezmoi.GPGEncryption `json:"gpg" mapstructure:"gpg" yaml:"gpg"`
// Command configurations.
Add addCmdConfig `json:"add" mapstructure:"add" yaml:"add"`
CD cdCmdConfig `json:"cd" mapstructure:"cd" yaml:"cd"`
Completion completionCmdConfig `json:"completion" mapstructure:"completion" yaml:"completion"`
Diff diffCmdConfig `json:"diff" mapstructure:"diff" yaml:"diff"`
Edit editCmdConfig `json:"edit" mapstructure:"edit" yaml:"edit"`
Git gitCmdConfig `json:"git" mapstructure:"git" yaml:"git"`
Merge mergeCmdConfig `json:"merge" mapstructure:"merge" yaml:"merge"`
Status statusCmdConfig `json:"status" mapstructure:"status" yaml:"status"`
Update updateCmdConfig `json:"update" mapstructure:"update" yaml:"update"`
Verify verifyCmdConfig `json:"verify" mapstructure:"verify" yaml:"verify"`
}
// A Config represents a configuration.
type Config struct {
ConfigFile
// Global configuration.
configFormat readDataFormat
cpuProfile chezmoi.AbsPath
debug bool
dryRun bool
force bool
homeDir string
interactive bool
keepGoing bool
noPager bool
noTTY bool
outputAbsPath chezmoi.AbsPath
refreshExternals chezmoi.RefreshExternals
sourcePath bool
templateFuncs template.FuncMap
useBuiltinDiff bool
// Password manager data.
gitHub gitHubData
keyring keyringData
// Command configurations, not settable in the config file.
age ageCmdConfig
apply applyCmdConfig
archive archiveCmdConfig
chattr chattrCmdConfig
dump dumpCmdConfig
executeTemplate executeTemplateCmdConfig
_import importCmdConfig
init initCmdConfig
managed managedCmdConfig
mergeAll mergeAllCmdConfig
purge purgeCmdConfig
reAdd reAddCmdConfig
remove removeCmdConfig
secret secretCmdConfig
state stateCmdConfig
unmanaged unmanagedCmdConfig
upgrade upgradeCmdConfig
// Common configuration.
interactiveTemplateFuncs interactiveTemplateFuncsConfig
// Version information.
version semver.Version
versionInfo VersionInfo
versionStr string
// Configuration.
fileSystem vfs.FS
bds *xdg.BaseDirectorySpecification
defaultConfigFileAbsPath chezmoi.AbsPath
defaultConfigFileAbsPathErr error
customConfigFileAbsPath chezmoi.AbsPath
baseSystem chezmoi.System
sourceSystem chezmoi.System
destSystem chezmoi.System
persistentState chezmoi.PersistentState
httpClient *http.Client
logger *slog.Logger
// Computed configuration.
commandDirAbsPath chezmoi.AbsPath
homeDirAbsPath chezmoi.AbsPath
encryption chezmoi.Encryption
sourceDirAbsPath chezmoi.AbsPath
sourceDirAbsPathErr error
sourceState *chezmoi.SourceState
sourceStateErr error
templateData *templateData
gitleaksDetector *detect.Detector
gitleaksDetectorErr error
stdin io.Reader
stdout io.Writer
stderr io.Writer
bufioReader *bufio.Reader
diffPagerCmdStdin io.WriteCloser
diffPagerCmd *exec.Cmd
tempDirs map[string]chezmoi.AbsPath
ioregData ioregData
restoreWindowsConsole func() error
}
type templateData struct {
arch string
args []string
cacheDir chezmoi.AbsPath
command string
commandDir chezmoi.AbsPath
config map[string]any
configFile chezmoi.AbsPath
executable chezmoi.AbsPath
fqdnHostname string
gid string
group string
homeDir chezmoi.AbsPath
hostname string
kernel map[string]any
os string
osRelease map[string]any
pathListSeparator string
pathSeparator string
sourceDir chezmoi.AbsPath
uid string
username string
version map[string]any
windowsVersion map[string]any
workingTree chezmoi.AbsPath
}
// A configOption sets and option on a Config.
type configOption func(*Config) error
type configState struct {
ConfigTemplateContentsSHA256 chezmoi.HexBytes `json:"configTemplateContentsSHA256" yaml:"configTemplateContentsSHA256"` //nolint:tagliatelle
}
var (
chezmoiRelPath = chezmoi.NewRelPath("chezmoi")
persistentStateFileRelPath = chezmoi.NewRelPath("chezmoistate.boltdb")
httpCacheDirRelPath = chezmoi.NewRelPath("httpcache")
configStateKey = []byte("configState")
defaultAgeEncryptionConfig = chezmoi.AgeEncryption{
Command: "age",
Suffix: ".age",
}
defaultGPGEncryptionConfig = chezmoi.GPGEncryption{
Command: "gpg",
Suffix: ".asc",
}
whitespaceRx = regexp.MustCompile(`\s+`)
commonFlagCompletionFuncs = map[string]func(*cobra.Command, []string, string) ([]string, cobra.ShellCompDirective){
"exclude": chezmoi.EntryTypeSetFlagCompletionFunc,
"format": writeDataFormatFlagCompletionFunc,
"include": chezmoi.EntryTypeSetFlagCompletionFunc,
"path-style": chezmoi.PathStyleFlagCompletionFunc,
"secrets": severityFlagCompletionFunc,
}
)
// newConfig creates a new Config with the given options.
func newConfig(options ...configOption) (*Config, error) {
userHomeDir, err := chezmoi.UserHomeDir()
if err != nil {
return nil, err
}
homeDirAbsPath, err := chezmoi.NormalizePath(userHomeDir)
if err != nil {
return nil, err
}
bds, err := xdg.NewBaseDirectorySpecification()
if err != nil {
return nil, err
}
logger := slog.Default()
c := &Config{
ConfigFile: newConfigFile(bds),
// Global configuration.
homeDir: userHomeDir,
templateFuncs: sprig.TxtFuncMap(),
// Command configurations.
apply: applyCmdConfig{
filter: chezmoi.NewEntryTypeFilter(chezmoi.EntryTypesAll, chezmoi.EntryTypesNone),
recursive: true,
},
archive: archiveCmdConfig{
filter: chezmoi.NewEntryTypeFilter(chezmoi.EntryTypesAll, chezmoi.EntryTypesNone),
recursive: true,
},
dump: dumpCmdConfig{
filter: chezmoi.NewEntryTypeFilter(chezmoi.EntryTypesAll, chezmoi.EntryTypesNone),
recursive: true,
},
executeTemplate: executeTemplateCmdConfig{
stdinIsATTY: true,
},
_import: importCmdConfig{
destination: homeDirAbsPath,
filter: chezmoi.NewEntryTypeFilter(chezmoi.EntryTypesAll, chezmoi.EntryTypesNone),
},
init: initCmdConfig{
data: true,
filter: chezmoi.NewEntryTypeFilter(chezmoi.EntryTypesAll, chezmoi.EntryTypesNone),
guessRepoURL: true,
recurseSubmodules: true,
},
managed: managedCmdConfig{
filter: chezmoi.NewEntryTypeFilter(chezmoi.EntryTypesAll, chezmoi.EntryTypesNone),
pathStyle: chezmoi.PathStyleRelative,
},
mergeAll: mergeAllCmdConfig{
recursive: true,
},
reAdd: reAddCmdConfig{
filter: chezmoi.NewEntryTypeFilter(chezmoi.EntryTypesAll, chezmoi.EntryTypesNone),
recursive: true,
},
unmanaged: unmanagedCmdConfig{
pathStyle: chezmoi.PathStyleRelative,
},
// Configuration.
fileSystem: vfs.OSFS,
bds: bds,
logger: logger,
// Computed configuration.
homeDirAbsPath: homeDirAbsPath,
tempDirs: make(map[string]chezmoi.AbsPath),
stdin: os.Stdin,
stdout: os.Stdout,
stderr: os.Stderr,
}
// Override sprig template functions. Delete them from the template function
// map first to avoid a duplicate function panic.
delete(c.templateFuncs, "fromJson")
delete(c.templateFuncs, "splitList")
delete(c.templateFuncs, "toPrettyJson")
// The completion template function is added in persistentPreRunRootE as
// it needs a *cobra.Command, which we don't yet have.
for key, value := range map[string]any{
"awsSecretsManager": c.awsSecretsManagerTemplateFunc,
"awsSecretsManagerRaw": c.awsSecretsManagerRawTemplateFunc,
"azureKeyVault": c.azureKeyVaultTemplateFunc,
"bitwarden": c.bitwardenTemplateFunc,
"bitwardenAttachment": c.bitwardenAttachmentTemplateFunc,
"bitwardenAttachmentByRef": c.bitwardenAttachmentByRefTemplateFunc,
"bitwardenFields": c.bitwardenFieldsTemplateFunc,
"bitwardenSecrets": c.bitwardenSecretsTemplateFunc,
"comment": c.commentTemplateFunc,
"dashlaneNote": c.dashlaneNoteTemplateFunc,
"dashlanePassword": c.dashlanePasswordTemplateFunc,
"decrypt": c.decryptTemplateFunc,
"deleteValueAtPath": c.deleteValueAtPathTemplateFunc,
"doppler": c.dopplerTemplateFunc,
"dopplerProjectJson": c.dopplerProjectJSONTemplateFunc,
"ejsonDecrypt": c.ejsonDecryptTemplateFunc,
"ejsonDecryptWithKey": c.ejsonDecryptWithKeyTemplateFunc,
"encrypt": c.encryptTemplateFunc,
"eqFold": c.eqFoldTemplateFunc,
"findExecutable": c.findExecutableTemplateFunc,
"findOneExecutable": c.findOneExecutableTemplateFunc,
"fromIni": c.fromIniTemplateFunc,
"fromJson": c.fromJsonTemplateFunc,
"fromJsonc": c.fromJsoncTemplateFunc,
"fromToml": c.fromTomlTemplateFunc,
"fromYaml": c.fromYamlTemplateFunc,
"gitHubKeys": c.gitHubKeysTemplateFunc,
"gitHubLatestRelease": c.gitHubLatestReleaseTemplateFunc,
"gitHubLatestTag": c.gitHubLatestTagTemplateFunc,
"gitHubReleases": c.gitHubReleasesTemplateFunc,
"gitHubTags": c.gitHubTagsTemplateFunc,
"glob": c.globTemplateFunc,
"gopass": c.gopassTemplateFunc,
"gopassRaw": c.gopassRawTemplateFunc,
"hcpVaultSecret": c.hcpVaultSecretTemplateFunc,
"hcpVaultSecretJson": c.hcpVaultSecretJSONTemplateFunc,
"hexDecode": c.hexDecodeTemplateFunc,
"hexEncode": c.hexEncodeTemplateFunc,
"include": c.includeTemplateFunc,
"includeTemplate": c.includeTemplateTemplateFunc,
"ioreg": c.ioregTemplateFunc,
"isExecutable": c.isExecutableTemplateFunc,
"joinPath": c.joinPathTemplateFunc,
"jq": c.jqTemplateFunc,
"keepassxc": c.keepassxcTemplateFunc,
"keepassxcAttachment": c.keepassxcAttachmentTemplateFunc,
"keepassxcAttribute": c.keepassxcAttributeTemplateFunc,
"keeper": c.keeperTemplateFunc,
"keeperDataFields": c.keeperDataFieldsTemplateFunc,
"keeperFindPassword": c.keeperFindPasswordTemplateFunc,
"keyring": c.keyringTemplateFunc,
"lastpass": c.lastpassTemplateFunc,
"lastpassRaw": c.lastpassRawTemplateFunc,
"lookPath": c.lookPathTemplateFunc,
"lstat": c.lstatTemplateFunc,
"mozillaInstallHash": c.mozillaInstallHashTemplateFunc,
"onepassword": c.onepasswordTemplateFunc,
"onepasswordDetailsFields": c.onepasswordDetailsFieldsTemplateFunc,
"onepasswordDocument": c.onepasswordDocumentTemplateFunc,
"onepasswordItemFields": c.onepasswordItemFieldsTemplateFunc,
"onepasswordRead": c.onepasswordReadTemplateFunc,
"output": c.outputTemplateFunc,
"pass": c.passTemplateFunc,
"passFields": c.passFieldsTemplateFunc,
"passhole": c.passholeTemplateFunc,
"passRaw": c.passRawTemplateFunc,
"pruneEmptyDicts": c.pruneEmptyDictsTemplateFunc,
"quoteList": c.quoteListTemplateFunc,
"rbw": c.rbwTemplateFunc,
"rbwFields": c.rbwFieldsTemplateFunc,
"replaceAllRegex": c.replaceAllRegexTemplateFunc,
"secret": c.secretTemplateFunc,
"secretJSON": c.secretJSONTemplateFunc,
"setValueAtPath": c.setValueAtPathTemplateFunc,
"splitList": c.splitListTemplateFunc,
"stat": c.statTemplateFunc,
"toIni": c.toIniTemplateFunc,
"toPrettyJson": c.toPrettyJsonTemplateFunc,
"toToml": c.toTomlTemplateFunc,
"toYaml": c.toYamlTemplateFunc,
"vault": c.vaultTemplateFunc,
} {
c.addTemplateFunc(key, value)
}
for _, option := range options {
if err := option(c); err != nil {
return nil, err
}
}
wd, err := os.Getwd()
if err != nil {
return nil, err
}
c.commandDirAbsPath, err = chezmoi.NormalizePath(wd)
if err != nil {
return nil, err
}
c.homeDirAbsPath, err = chezmoi.NormalizePath(c.homeDir)
if err != nil {
return nil, err
}
c.defaultConfigFileAbsPath, c.defaultConfigFileAbsPathErr = c.defaultConfigFile(c.fileSystem, c.bds)
c.SourceDirAbsPath, err = c.defaultSourceDir(c.fileSystem, c.bds)
if err != nil {
return nil, err
}
c.DestDirAbsPath = c.homeDirAbsPath
c._import.destination = c.homeDirAbsPath
return c, nil
}
func (c *Config) getConfigFileAbsPath() chezmoi.AbsPath {
if c.customConfigFileAbsPath.Empty() {
return c.defaultConfigFileAbsPath
}
return c.customConfigFileAbsPath
}
// Close closes resources associated with c.
func (c *Config) Close() error {
errs := make([]error, 0, len(c.tempDirs))
for _, tempDirAbsPath := range c.tempDirs {
err := os.RemoveAll(tempDirAbsPath.String())
chezmoilog.InfoOrError(c.logger, "RemoveAll", err,
chezmoilog.Stringer("tempDir", tempDirAbsPath),
)
errs = append(errs, err)
}
pprof.StopCPUProfile()
return chezmoierrors.Combine(errs...)
}
// addTemplateFunc adds the template function with the given key and value
// to c. It panics if there is already an existing template function with the
// same key.
func (c *Config) addTemplateFunc(key string, value any) {
if _, ok := c.templateFuncs[key]; ok {
panic(key + ": already defined")
}
c.templateFuncs[key] = value
}
type applyArgsOptions struct {
cmd *cobra.Command
filter *chezmoi.EntryTypeFilter
init bool
recursive bool
umask fs.FileMode
preApplyFunc chezmoi.PreApplyFunc
}
// applyArgs is the core of all commands that make changes to a target system.
// It checks config file freshness, reads the source state, and then applies the
// source state for each target entry in args. If args is empty then the source
// state is applied to all target entries.
func (c *Config) applyArgs(
ctx context.Context,
targetSystem chezmoi.System,
targetDirAbsPath chezmoi.AbsPath,
args []string,
options applyArgsOptions,
) error {
if options.init {
if err := c.createAndReloadConfigFile(options.cmd); err != nil {
return err
}
}
var currentConfigTemplateContentsSHA256 []byte
configTemplate, err := c.findConfigTemplate()
if err != nil {
return err
}
if configTemplate != nil {
currentConfigTemplateContentsSHA256 = chezmoi.SHA256Sum(configTemplate.contents)
}
var previousConfigTemplateContentsSHA256 []byte
if configStateData, err := c.persistentState.Get(chezmoi.ConfigStateBucket, configStateKey); err != nil {
return err
} else if configStateData != nil {
var configState configState
if err := json.Unmarshal(configStateData, &configState); err != nil {
return err
}
previousConfigTemplateContentsSHA256 = []byte(configState.ConfigTemplateContentsSHA256)
}
configTemplatesEmpty := currentConfigTemplateContentsSHA256 == nil && previousConfigTemplateContentsSHA256 == nil
configTemplateContentsUnchanged := configTemplatesEmpty ||
bytes.Equal(currentConfigTemplateContentsSHA256, previousConfigTemplateContentsSHA256)
if !configTemplateContentsUnchanged {
if c.force {
if configTemplate == nil {
if err := c.persistentState.Delete(chezmoi.ConfigStateBucket, configStateKey); err != nil {
return err
}
} else {
configStateValue, err := chezmoi.FormatJSON.Marshal(configState{
ConfigTemplateContentsSHA256: chezmoi.HexBytes(currentConfigTemplateContentsSHA256),
})
if err != nil {
return err
}
if err := c.persistentState.Set(chezmoi.ConfigStateBucket, configStateKey, configStateValue); err != nil {
return err
}
}
} else if c.Warnings.ConfigFileTemplateHasChanged {
c.errorf("warning: config file template has changed, run chezmoi init to regenerate config file\n")
}
}
sourceState, err := c.getSourceState(ctx, options.cmd)
if err != nil {
return err
}
var targetRelPaths chezmoi.RelPaths
switch {
case len(args) == 0:
targetRelPaths = sourceState.TargetRelPaths()
case c.sourcePath:
targetRelPaths, err = c.targetRelPathsBySourcePath(sourceState, args)
if err != nil {
return err
}
default:
targetRelPaths, err = c.targetRelPaths(sourceState, args, &targetRelPathsOptions{
recursive: options.recursive,
})
if err != nil {
return err
}
}
applyOptions := chezmoi.ApplyOptions{
Filter: options.filter,
PreApplyFunc: options.preApplyFunc,
Umask: options.umask,
}
keptGoingAfterErr := false
for _, targetRelPath := range targetRelPaths {
switch err := sourceState.Apply(targetSystem, c.destSystem, c.persistentState, targetDirAbsPath, targetRelPath, applyOptions); {
case errors.Is(err, fs.SkipDir):
continue
case err != nil:
err = fmt.Errorf("%s: %w", targetRelPath, err)
if c.keepGoing {
c.errorf("%v\n", err)
keptGoingAfterErr = true
} else {
return err
}
}
}
switch err := sourceState.PostApply(targetSystem, c.persistentState, targetDirAbsPath, targetRelPaths); {
case err != nil && c.keepGoing:
c.errorf("%v\n", err)
keptGoingAfterErr = true
case err != nil:
return err
}
if keptGoingAfterErr {
return chezmoi.ExitCodeError(1)
}
return nil
}
// checkVersion checks that chezmoi is at least the required version for the
// source state.
func (c *Config) checkVersion() error {
versionAbsPath := c.SourceDirAbsPath.JoinString(chezmoi.VersionName)
switch data, err := c.baseSystem.ReadFile(versionAbsPath); {
case errors.Is(err, fs.ErrNotExist):
case err != nil:
return err
default:
minVersion, err := semver.NewVersion(strings.TrimSpace(string(data)))
if err != nil {
return fmt.Errorf("%s: %q: %w", versionAbsPath, data, err)
}
var zeroVersion semver.Version
if c.version != zeroVersion && c.version.LessThan(*minVersion) {
return &chezmoi.TooOldError{
Need: *minVersion,
Have: c.version,
}
}
}
return nil
}
// cmdOutput returns the of running the command name with args in dirAbsPath.
func (c *Config) cmdOutput(dirAbsPath chezmoi.AbsPath, name string, args []string) ([]byte, error) {
cmd := exec.Command(name, args...)
cmd.Stderr = os.Stderr
if !dirAbsPath.Empty() {
dirRawAbsPath, err := c.baseSystem.RawPath(dirAbsPath)
if err != nil {
return nil, err
}
cmd.Dir = dirRawAbsPath.String()
}
return chezmoilog.LogCmdOutput(slog.Default(), cmd)
}
// colorAutoFunc detects whether color should be used.
func (c *Config) colorAutoFunc() bool {
if _, ok := os.LookupEnv("NO_COLOR"); ok {
return false
}
if stdout, ok := c.stdout.(*os.File); ok {
return term.IsTerminal(int(stdout.Fd()))
}
return false
}
// createAndReloadConfigFile creates a config file if it there is a config file
// template and reloads it.
func (c *Config) createAndReloadConfigFile(cmd *cobra.Command) error {
// Refresh the source directory, as there might be a .chezmoiroot file and
// the template data is set before .chezmoiroot is read.
sourceDirAbsPath, err := c.getSourceDirAbsPath(&getSourceDirAbsPathOptions{
refresh: true,
})
if err != nil {
return err
}
c.templateData.sourceDir = sourceDirAbsPath
os.Setenv("CHEZMOI_SOURCE_DIR", sourceDirAbsPath.String())
// Find config template, execute it, and create config file.
configTemplate, err := c.findConfigTemplate()
if err != nil {
return err
}
if configTemplate == nil {
return c.persistentState.Delete(chezmoi.ConfigStateBucket, configStateKey)
}
configFileContents, err := c.createConfigFile(configTemplate.targetRelPath, configTemplate.contents, cmd)
if err != nil {
return err
}
// Validate the config file.
var configFile ConfigFile
if err := c.decodeConfigBytes(configTemplate.format, configFileContents, &configFile); err != nil {
return fmt.Errorf("%s: %w", configTemplate.sourceAbsPath, err)
}
// Write the config.
configPath := c.init.configPath
if c.init.configPath.Empty() {
if c.customConfigFileAbsPath.Empty() {
configPath = chezmoi.NewAbsPath(c.bds.ConfigHome).Join(chezmoiRelPath, configTemplate.targetRelPath)
} else {
configPath = c.customConfigFileAbsPath
}
}
if err := chezmoi.MkdirAll(c.baseSystem, configPath.Dir(), fs.ModePerm); err != nil {
return err
}
if err := c.baseSystem.WriteFile(configPath, configFileContents, 0o600); err != nil {
return err
}
configStateValue, err := chezmoi.FormatJSON.Marshal(configState{
ConfigTemplateContentsSHA256: chezmoi.HexBytes(chezmoi.SHA256Sum(configTemplate.contents)),
})
if err != nil {
return err
}
if err := c.persistentState.Set(chezmoi.ConfigStateBucket, configStateKey, configStateValue); err != nil {
return err
}
// Reload the config.
if err := c.decodeConfigBytes(configTemplate.format, configFileContents, &c.ConfigFile); err != nil {
return fmt.Errorf("%s: %w", configTemplate.sourceAbsPath, err)
}
if err := c.setEncryption(); err != nil {
return err
}
if err := c.setEnvironmentVariables(); err != nil {
return err
}
return nil
}
// createConfigFile creates a config file using a template and returns its
// contents.
func (c *Config) createConfigFile(filename chezmoi.RelPath, data []byte, cmd *cobra.Command) ([]byte, error) {
funcMap := make(template.FuncMap)
chezmoi.RecursiveMerge(funcMap, c.templateFuncs)
initTemplateFuncs := map[string]any{
"exit": c.exitInitTemplateFunc,
"promptBool": c.promptBoolInteractiveTemplateFunc,
"promptBoolOnce": c.promptBoolOnceInteractiveTemplateFunc,
"promptChoice": c.promptChoiceInteractiveTemplateFunc,
"promptChoiceOnce": c.promptChoiceOnceInteractiveTemplateFunc,
"promptInt": c.promptIntInteractiveTemplateFunc,
"promptIntOnce": c.promptIntOnceInteractiveTemplateFunc,
"promptString": c.promptStringInteractiveTemplateFunc,
"promptStringOnce": c.promptStringOnceInteractiveTemplateFunc,
"stdinIsATTY": c.stdinIsATTYInitTemplateFunc,
"writeToStdout": c.writeToStdout,
}
chezmoi.RecursiveMerge(funcMap, initTemplateFuncs)
tmpl, err := chezmoi.ParseTemplate(filename.String(), data, funcMap, chezmoi.TemplateOptions{
Options: slices.Clone(c.Template.Options),
})
if err != nil {
return nil, err
}
templateData := c.getTemplateDataMap(cmd)
if c.init.data {
chezmoi.RecursiveMerge(templateData, c.Data)
}
return tmpl.Execute(templateData)
}
// defaultConfigFile returns the default config file according to the XDG Base
// Directory Specification.
func (c *Config) defaultConfigFile(fileSystem vfs.FS, bds *xdg.BaseDirectorySpecification) (chezmoi.AbsPath, error) {
// Search XDG Base Directory Specification config directories first.
CONFIG_DIR:
for _, configDir := range bds.ConfigDirs {
configDirAbsPath, err := chezmoi.NewAbsPathFromExtPath(configDir, c.homeDirAbsPath)
if err != nil {
return chezmoi.EmptyAbsPath, err
}
dirEntries, err := fileSystem.ReadDir(configDirAbsPath.JoinString("chezmoi").String())
switch {
case errors.Is(err, fs.ErrNotExist):
continue CONFIG_DIR
case err != nil:
return chezmoi.EmptyAbsPath, err
}
dirEntryNames := chezmoiset.NewWithCapacity[string](len(dirEntries))
for _, dirEntry := range dirEntries {
dirEntryNames.Add(dirEntry.Name())
}
var names []string
for _, extension := range chezmoi.FormatExtensions {
name := "chezmoi." + extension
if dirEntryNames.Contains(name) {
names = append(names, name)
}
}
switch len(names) {
case 0:
// Do nothing.
case 1:
return configDirAbsPath.JoinString("chezmoi", names[0]), nil
default:
configFileAbsPathStrs := make([]string, 0, len(names))
for _, name := range names {
configFileAbsPathStr := configDirAbsPath.JoinString("chezmoi", name)
configFileAbsPathStrs = append(configFileAbsPathStrs, configFileAbsPathStr.String())
}
return chezmoi.EmptyAbsPath, fmt.Errorf("multiple config files: %s", englishList(configFileAbsPathStrs))
}
}
// Fallback to XDG Base Directory Specification default.
configHomeAbsPath, err := chezmoi.NewAbsPathFromExtPath(bds.ConfigHome, c.homeDirAbsPath)
if err != nil {
return chezmoi.EmptyAbsPath, err
}
return configHomeAbsPath.JoinString("chezmoi", "chezmoi.toml"), nil
}
// decodeConfigBytes decodes data in format into configFile.
func (c *Config) decodeConfigBytes(format chezmoi.Format, data []byte, configFile *ConfigFile) error {
var configMap map[string]any
if err := format.Unmarshal(data, &configMap); err != nil {
return err
}
return c.decodeConfigMap(configMap, configFile)
}
// decodeConfigFile decodes the config file at configFileAbsPath into
// configFile.
func (c *Config) decodeConfigFile(configFileAbsPath chezmoi.AbsPath, configFile *ConfigFile) error {
var format chezmoi.Format
if c.configFormat == "" {
var err error
format, err = chezmoi.FormatFromAbsPath(configFileAbsPath)
if err != nil {
return err
}
} else {
format = c.configFormat.Format()
}
configFileContents, err := c.fileSystem.ReadFile(configFileAbsPath.String())
if err != nil {
return fmt.Errorf("%s: %w", configFileAbsPath, err)
}
if err := c.decodeConfigBytes(format, configFileContents, configFile); err != nil {
return fmt.Errorf("%s: %w", configFileAbsPath, err)
}
if configFile.Git.CommitMessageTemplate != "" && configFile.Git.CommitMessageTemplateFile != "" {
return fmt.Errorf(
"%s: cannot specify both git.commitMessageTemplate and git.commitMessageTemplateFile",
configFileAbsPath,
)
}
return nil
}
// decodeConfigMap decodes configMap into configFile.
func (c *Config) decodeConfigMap(configMap map[string]any, configFile *ConfigFile) error {
decoder, err := mapstructure.NewDecoder(&mapstructure.DecoderConfig{
DecodeHook: mapstructure.ComposeDecodeHookFunc(
mapstructure.StringToTimeDurationHookFunc(),
mapstructure.StringToSliceHookFunc(","),
chezmoi.StringSliceToEntryTypeSetHookFunc(),
chezmoi.StringToAbsPathHookFunc(),
StringOrBoolToAutoBoolHookFunc(),
),
Result: configFile,
})
if err != nil {
return err
}
return decoder.Decode(configMap)
}
// defaultPreApplyFunc is the default pre-apply function. If the target entry
// has changed since chezmoi last wrote it then it prompts the user for the
// action to take.
func (c *Config) defaultPreApplyFunc(
targetRelPath chezmoi.RelPath,
targetEntryState, lastWrittenEntryState, actualEntryState *chezmoi.EntryState,
) error {
c.logger.Info("defaultPreApplyFunc",
chezmoilog.Stringer("targetRelPath", targetRelPath),
slog.Any("targetEntryState", targetEntryState),
slog.Any("lastWrittenEntryState", lastWrittenEntryState),
slog.Any("actualEntryState", actualEntryState),
)
switch {
case c.force:
return nil
case targetEntryState.Equivalent(actualEntryState):
return nil
}
if c.interactive {
prompt := fmt.Sprintf("Apply %s", targetRelPath)
var choices []string
actualContents := actualEntryState.Contents()
targetContents := targetEntryState.Contents()
if actualContents != nil || targetContents != nil {
choices = append(choices, "diff")
}
choices = append(choices, choicesYesNoAllQuit...)
for {
switch choice, err := c.promptChoice(prompt, choices); {
case err != nil:
return err
case choice == "diff":
err := c.diffFile(targetRelPath, actualContents, actualEntryState.Mode, targetContents, targetEntryState.Mode)
if err != nil {
return err
}
case choice == "yes":
return nil
case choice == "no":
return fs.SkipDir
case choice == "all":
c.interactive = false