Skip to content

Commit b109358

Browse files
brianmcgeeJonas Chevalier
brianmcgee
authored and
Jonas Chevalier
committed
feat: create config package (#25)
Move all config related code into a config package. Signed-off-by: Brian McGee <[email protected]> Reviewed-on: https://git.numtide.com/numtide/treefmt/pulls/25 Reviewed-by: Jonas Chevalier <[email protected]> Co-authored-by: Brian McGee <[email protected]> Co-committed-by: Brian McGee <[email protected]>
1 parent 15db7f4 commit b109358

File tree

7 files changed

+92
-83
lines changed

7 files changed

+92
-83
lines changed

‎internal/cli/format.go

+14-12
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ import (
1010
"syscall"
1111
"time"
1212

13+
"git.numtide.com/numtide/treefmt/internal/config"
14+
1315
"git.numtide.com/numtide/treefmt/internal/cache"
1416
"git.numtide.com/numtide/treefmt/internal/format"
1517

@@ -39,7 +41,7 @@ func (f *Format) Run() error {
3941
defer cancel()
4042

4143
// read config
42-
cfg, err := format.ReadConfigFile(Cli.ConfigFile)
44+
cfg, err := config.ReadFile(Cli.ConfigFile)
4345
if err != nil {
4446
return fmt.Errorf("%w: failed to read config file", err)
4547
}
@@ -68,8 +70,8 @@ func (f *Format) Run() error {
6870
formatters := make(map[string]*format.Formatter)
6971

7072
// detect broken dependencies
71-
for name, config := range cfg.Formatters {
72-
before := config.Before
73+
for name, formatterCfg := range cfg.Formatters {
74+
before := formatterCfg.Before
7375
if before != "" {
7476
// check child formatter exists
7577
_, ok := cfg.Formatters[before]
@@ -80,40 +82,40 @@ func (f *Format) Run() error {
8082
}
8183

8284
// dependency cycle detection
83-
for name, config := range cfg.Formatters {
85+
for name, formatterCfg := range cfg.Formatters {
8486
var ok bool
8587
var history []string
8688
childName := name
8789
for {
8890
// add to history
8991
history = append(history, childName)
9092

91-
if config.Before == "" {
93+
if formatterCfg.Before == "" {
9294
break
93-
} else if config.Before == name {
95+
} else if formatterCfg.Before == name {
9496
return fmt.Errorf("formatter cycle detected %v", strings.Join(history, " -> "))
9597
}
9698

9799
// load child config
98-
childName = config.Before
99-
config, ok = cfg.Formatters[config.Before]
100+
childName = formatterCfg.Before
101+
formatterCfg, ok = cfg.Formatters[formatterCfg.Before]
100102
if !ok {
101-
return fmt.Errorf("formatter not found: %v", config.Before)
103+
return fmt.Errorf("formatter not found: %v", formatterCfg.Before)
102104
}
103105
}
104106
}
105107

106108
// init formatters
107-
for name, config := range cfg.Formatters {
109+
for name, formatterCfg := range cfg.Formatters {
108110
if !includeFormatter(name) {
109111
// remove this formatter
110112
delete(cfg.Formatters, name)
111113
l.Debugf("formatter %v is not in formatter list %v, skipping", name, Cli.Formatters)
112114
continue
113115
}
114116

115-
formatter, err := format.NewFormatter(name, config, globalExcludes)
116-
if errors.Is(err, format.ErrFormatterNotFound) && Cli.AllowMissingFormatter {
117+
formatter, err := format.NewFormatter(name, formatterCfg, globalExcludes)
118+
if errors.Is(err, format.ErrCommandNotFound) && Cli.AllowMissingFormatter {
117119
l.Debugf("formatter not found: %v", name)
118120
continue
119121
} else if err != nil {

‎internal/cli/format_test.go

+46-44
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ import (
88
"path/filepath"
99
"testing"
1010

11+
"git.numtide.com/numtide/treefmt/internal/config"
12+
1113
"git.numtide.com/numtide/treefmt/internal/test"
1214
"github.com/go-git/go-billy/v5/osfs"
1315
"github.com/go-git/go-git/v5"
@@ -24,16 +26,16 @@ func TestAllowMissingFormatter(t *testing.T) {
2426
tempDir := t.TempDir()
2527
configPath := tempDir + "/treefmt.toml"
2628

27-
test.WriteConfig(t, configPath, format.Config{
28-
Formatters: map[string]*format.FormatterConfig{
29+
test.WriteConfig(t, configPath, config.Config{
30+
Formatters: map[string]*config.Formatter{
2931
"foo-fmt": {
3032
Command: "foo-fmt",
3133
},
3234
},
3335
})
3436

3537
_, err := cmd(t, "--config-file", configPath, "--tree-root", tempDir)
36-
as.ErrorIs(err, format.ErrFormatterNotFound)
38+
as.ErrorIs(err, format.ErrCommandNotFound)
3739

3840
_, err = cmd(t, "--config-file", configPath, "--tree-root", tempDir, "--allow-missing-formatter")
3941
as.NoError(err)
@@ -45,8 +47,8 @@ func TestDependencyCycle(t *testing.T) {
4547
tempDir := t.TempDir()
4648
configPath := tempDir + "/treefmt.toml"
4749

48-
test.WriteConfig(t, configPath, format.Config{
49-
Formatters: map[string]*format.FormatterConfig{
50+
test.WriteConfig(t, configPath, config.Config{
51+
Formatters: map[string]*config.Formatter{
5052
"a": {Command: "echo", Before: "b"},
5153
"b": {Command: "echo", Before: "c"},
5254
"c": {Command: "echo", Before: "a"},
@@ -66,8 +68,8 @@ func TestSpecifyingFormatters(t *testing.T) {
6668
tempDir := test.TempExamples(t)
6769
configPath := tempDir + "/treefmt.toml"
6870

69-
test.WriteConfig(t, configPath, format.Config{
70-
Formatters: map[string]*format.FormatterConfig{
71+
test.WriteConfig(t, configPath, config.Config{
72+
Formatters: map[string]*config.Formatter{
7173
"elm": {
7274
Command: "echo",
7375
Includes: []string{"*.elm"},
@@ -115,66 +117,66 @@ func TestIncludesAndExcludes(t *testing.T) {
115117
configPath := tempDir + "/echo.toml"
116118

117119
// test without any excludes
118-
config := format.Config{
119-
Formatters: map[string]*format.FormatterConfig{
120+
cfg := config.Config{
121+
Formatters: map[string]*config.Formatter{
120122
"echo": {
121123
Command: "echo",
122124
Includes: []string{"*"},
123125
},
124126
},
125127
}
126128

127-
test.WriteConfig(t, configPath, config)
129+
test.WriteConfig(t, configPath, cfg)
128130
out, err := cmd(t, "-c", "--config-file", configPath, "--tree-root", tempDir)
129131
as.NoError(err)
130132
as.Contains(string(out), fmt.Sprintf("%d files changed", 29))
131133

132134
// globally exclude nix files
133-
config.Global.Excludes = []string{"*.nix"}
135+
cfg.Global.Excludes = []string{"*.nix"}
134136

135-
test.WriteConfig(t, configPath, config)
137+
test.WriteConfig(t, configPath, cfg)
136138
out, err = cmd(t, "-c", "--config-file", configPath, "--tree-root", tempDir)
137139
as.NoError(err)
138140
as.Contains(string(out), fmt.Sprintf("%d files changed", 28))
139141

140142
// add haskell files to the global exclude
141-
config.Global.Excludes = []string{"*.nix", "*.hs"}
143+
cfg.Global.Excludes = []string{"*.nix", "*.hs"}
142144

143-
test.WriteConfig(t, configPath, config)
145+
test.WriteConfig(t, configPath, cfg)
144146
out, err = cmd(t, "-c", "--config-file", configPath, "--tree-root", tempDir)
145147
as.NoError(err)
146148
as.Contains(string(out), fmt.Sprintf("%d files changed", 22))
147149

148-
echo := config.Formatters["echo"]
150+
echo := cfg.Formatters["echo"]
149151

150152
// remove python files from the echo formatter
151153
echo.Excludes = []string{"*.py"}
152154

153-
test.WriteConfig(t, configPath, config)
155+
test.WriteConfig(t, configPath, cfg)
154156
out, err = cmd(t, "-c", "--config-file", configPath, "--tree-root", tempDir)
155157
as.NoError(err)
156158
as.Contains(string(out), fmt.Sprintf("%d files changed", 20))
157159

158160
// remove go files from the echo formatter
159161
echo.Excludes = []string{"*.py", "*.go"}
160162

161-
test.WriteConfig(t, configPath, config)
163+
test.WriteConfig(t, configPath, cfg)
162164
out, err = cmd(t, "-c", "--config-file", configPath, "--tree-root", tempDir)
163165
as.NoError(err)
164166
as.Contains(string(out), fmt.Sprintf("%d files changed", 19))
165167

166168
// adjust the includes for echo to only include elm files
167169
echo.Includes = []string{"*.elm"}
168170

169-
test.WriteConfig(t, configPath, config)
171+
test.WriteConfig(t, configPath, cfg)
170172
out, err = cmd(t, "-c", "--config-file", configPath, "--tree-root", tempDir)
171173
as.NoError(err)
172174
as.Contains(string(out), fmt.Sprintf("%d files changed", 1))
173175

174176
// add js files to echo formatter
175177
echo.Includes = []string{"*.elm", "*.js"}
176178

177-
test.WriteConfig(t, configPath, config)
179+
test.WriteConfig(t, configPath, cfg)
178180
out, err = cmd(t, "-c", "--config-file", configPath, "--tree-root", tempDir)
179181
as.NoError(err)
180182
as.Contains(string(out), fmt.Sprintf("%d files changed", 2))
@@ -187,16 +189,16 @@ func TestCache(t *testing.T) {
187189
configPath := tempDir + "/echo.toml"
188190

189191
// test without any excludes
190-
config := format.Config{
191-
Formatters: map[string]*format.FormatterConfig{
192+
cfg := config.Config{
193+
Formatters: map[string]*config.Formatter{
192194
"echo": {
193195
Command: "echo",
194196
Includes: []string{"*"},
195197
},
196198
},
197199
}
198200

199-
test.WriteConfig(t, configPath, config)
201+
test.WriteConfig(t, configPath, cfg)
200202
out, err := cmd(t, "--config-file", configPath, "--tree-root", tempDir)
201203
as.NoError(err)
202204
as.Contains(string(out), fmt.Sprintf("%d files changed", 29))
@@ -222,16 +224,16 @@ func TestChangeWorkingDirectory(t *testing.T) {
222224
configPath := tempDir + "/treefmt.toml"
223225

224226
// test without any excludes
225-
config := format.Config{
226-
Formatters: map[string]*format.FormatterConfig{
227+
cfg := config.Config{
228+
Formatters: map[string]*config.Formatter{
227229
"echo": {
228230
Command: "echo",
229231
Includes: []string{"*"},
230232
},
231233
},
232234
}
233235

234-
test.WriteConfig(t, configPath, config)
236+
test.WriteConfig(t, configPath, cfg)
235237

236238
// by default, we look for ./treefmt.toml and use the cwd for the tree root
237239
// this should fail if the working directory hasn't been changed first
@@ -247,16 +249,16 @@ func TestFailOnChange(t *testing.T) {
247249
configPath := tempDir + "/echo.toml"
248250

249251
// test without any excludes
250-
config := format.Config{
251-
Formatters: map[string]*format.FormatterConfig{
252+
cfg := config.Config{
253+
Formatters: map[string]*config.Formatter{
252254
"echo": {
253255
Command: "echo",
254256
Includes: []string{"*"},
255257
},
256258
},
257259
}
258260

259-
test.WriteConfig(t, configPath, config)
261+
test.WriteConfig(t, configPath, cfg)
260262
_, err := cmd(t, "--fail-on-change", "--config-file", configPath, "--tree-root", tempDir)
261263
as.ErrorIs(err, ErrFailOnChange)
262264
}
@@ -283,8 +285,8 @@ func TestBustCacheOnFormatterChange(t *testing.T) {
283285
as.NoError(os.Setenv("PATH", binPath+":"+os.Getenv("PATH")))
284286

285287
// start with 2 formatters
286-
config := format.Config{
287-
Formatters: map[string]*format.FormatterConfig{
288+
cfg := config.Config{
289+
Formatters: map[string]*config.Formatter{
288290
"python": {
289291
Command: "black",
290292
Includes: []string{"*.py"},
@@ -297,7 +299,7 @@ func TestBustCacheOnFormatterChange(t *testing.T) {
297299
},
298300
}
299301

300-
test.WriteConfig(t, configPath, config)
302+
test.WriteConfig(t, configPath, cfg)
301303
args := []string{"--config-file", configPath, "--tree-root", tempDir}
302304
out, err := cmd(t, args...)
303305
as.NoError(err)
@@ -328,12 +330,12 @@ func TestBustCacheOnFormatterChange(t *testing.T) {
328330
as.Contains(string(out), "0 files changed")
329331

330332
// add go formatter
331-
config.Formatters["go"] = &format.FormatterConfig{
333+
cfg.Formatters["go"] = &config.Formatter{
332334
Command: "gofmt",
333335
Options: []string{"-w"},
334336
Includes: []string{"*.go"},
335337
}
336-
test.WriteConfig(t, configPath, config)
338+
test.WriteConfig(t, configPath, cfg)
337339

338340
out, err = cmd(t, args...)
339341
as.NoError(err)
@@ -345,8 +347,8 @@ func TestBustCacheOnFormatterChange(t *testing.T) {
345347
as.Contains(string(out), "0 files changed")
346348

347349
// remove python formatter
348-
delete(config.Formatters, "python")
349-
test.WriteConfig(t, configPath, config)
350+
delete(cfg.Formatters, "python")
351+
test.WriteConfig(t, configPath, cfg)
350352

351353
out, err = cmd(t, args...)
352354
as.NoError(err)
@@ -358,8 +360,8 @@ func TestBustCacheOnFormatterChange(t *testing.T) {
358360
as.Contains(string(out), "0 files changed")
359361

360362
// remove elm formatter
361-
delete(config.Formatters, "elm")
362-
test.WriteConfig(t, configPath, config)
363+
delete(cfg.Formatters, "elm")
364+
test.WriteConfig(t, configPath, cfg)
363365

364366
out, err = cmd(t, args...)
365367
as.NoError(err)
@@ -378,15 +380,15 @@ func TestGitWorktree(t *testing.T) {
378380
configPath := filepath.Join(tempDir, "/treefmt.toml")
379381

380382
// basic config
381-
config := format.Config{
382-
Formatters: map[string]*format.FormatterConfig{
383+
cfg := config.Config{
384+
Formatters: map[string]*config.Formatter{
383385
"echo": {
384386
Command: "echo",
385387
Includes: []string{"*"},
386388
},
387389
},
388390
}
389-
test.WriteConfig(t, configPath, config)
391+
test.WriteConfig(t, configPath, cfg)
390392

391393
// init a git repo
392394
repo, err := git.Init(
@@ -433,8 +435,8 @@ func TestOrderingFormatters(t *testing.T) {
433435
configPath := path.Join(tempDir, "treefmt.toml")
434436

435437
// missing child
436-
test.WriteConfig(t, configPath, format.Config{
437-
Formatters: map[string]*format.FormatterConfig{
438+
test.WriteConfig(t, configPath, config.Config{
439+
Formatters: map[string]*config.Formatter{
438440
"hs-a": {
439441
Command: "echo",
440442
Includes: []string{"*.hs"},
@@ -447,8 +449,8 @@ func TestOrderingFormatters(t *testing.T) {
447449
as.ErrorContains(err, "formatter hs-a is before hs-b but config for hs-b was not found")
448450

449451
// multiple roots
450-
test.WriteConfig(t, configPath, format.Config{
451-
Formatters: map[string]*format.FormatterConfig{
452+
test.WriteConfig(t, configPath, config.Config{
453+
Formatters: map[string]*config.Formatter{
452454
"hs-a": {
453455
Command: "echo",
454456
Includes: []string{"*.hs"},

‎internal/format/config.go ‎internal/config/config.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package format
1+
package config
22

33
import "github.com/BurntSushi/toml"
44

@@ -8,11 +8,11 @@ type Config struct {
88
// Excludes is an optional list of glob patterns used to exclude certain files from all formatters.
99
Excludes []string
1010
}
11-
Formatters map[string]*FormatterConfig `toml:"formatter"`
11+
Formatters map[string]*Formatter `toml:"formatter"`
1212
}
1313

14-
// ReadConfigFile reads from path and unmarshals toml into a Config instance.
15-
func ReadConfigFile(path string) (cfg *Config, err error) {
14+
// ReadFile reads from path and unmarshals toml into a Config instance.
15+
func ReadFile(path string) (cfg *Config, err error) {
1616
_, err = toml.DecodeFile(path, &cfg)
1717
return
1818
}

0 commit comments

Comments
 (0)