Skip to content

Commit 48d4b4b

Browse files
brianmcgeebrianmcgee
committed
feat: remove globals from stats package
Signed-off-by: Brian McGee <[email protected]>
1 parent 6824497 commit 48d4b4b

File tree

6 files changed

+193
-173
lines changed

6 files changed

+193
-173
lines changed

‎cache/cache.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ func putEntry(bucket *bolt.Bucket, path string, entry *Entry) error {
188188

189189
// ChangeSet is used to walk a filesystem, starting at root, and outputting any new or changed paths using pathsCh.
190190
// It determines if a path is new or has changed by comparing against cache entries.
191-
func ChangeSet(ctx context.Context, walker walk.Walker, filesCh chan<- *walk.File) error {
191+
func ChangeSet(ctx context.Context, statz *stats.Stats, walker walk.Walker, filesCh chan<- *walk.File) error {
192192
start := time.Now()
193193

194194
defer func() {
@@ -236,13 +236,13 @@ func ChangeSet(ctx context.Context, walker walk.Walker, filesCh chan<- *walk.Fil
236236

237237
changedOrNew := cached == nil || !(cached.Modified == file.Info.ModTime() && cached.Size == file.Info.Size())
238238

239-
stats.Add(stats.Traversed, 1)
239+
statz.Add(stats.Traversed, 1)
240240
if !changedOrNew {
241241
// no change
242242
return nil
243243
}
244244

245-
stats.Add(stats.Emitted, 1)
245+
statz.Add(stats.Emitted, 1)
246246

247247
// pass on the path
248248
select {

‎cmd/format/format.go

+27-17
Original file line numberDiff line numberDiff line change
@@ -33,17 +33,14 @@ const (
3333

3434
var ErrFailOnChange = errors.New("unexpected changes detected, --fail-on-change is enabled")
3535

36-
func Run(v *viper.Viper, cmd *cobra.Command, paths []string) error {
36+
func Run(v *viper.Viper, statz *stats.Stats, cmd *cobra.Command, paths []string) error {
3737
cmd.SilenceUsage = true
3838

3939
cfg, err := config.FromViper(v)
4040
if err != nil {
4141
return fmt.Errorf("failed to load config: %w", err)
4242
}
4343

44-
// initialise stats collection
45-
stats.Init()
46-
4744
if cfg.CI {
4845
log.Info("ci mode enabled")
4946

@@ -191,10 +188,10 @@ func Run(v *viper.Viper, cmd *cobra.Command, paths []string) error {
191188
processedCh := make(chan *format.Task, cap(filesCh))
192189

193190
// start concurrent processing tasks in reverse order
194-
eg.Go(updateCache(ctx, cfg, processedCh))
195-
eg.Go(detectFormatted(ctx, cfg, formattedCh, processedCh))
196-
eg.Go(applyFormatters(ctx, cfg, globalExcludes, formatters, filesCh, formattedCh))
197-
eg.Go(walkFilesystem(ctx, cfg, paths, filesCh))
191+
eg.Go(updateCache(ctx, cfg, statz, processedCh))
192+
eg.Go(detectFormatted(ctx, cfg, statz, formattedCh, processedCh))
193+
eg.Go(applyFormatters(ctx, cfg, statz, globalExcludes, formatters, filesCh, formattedCh))
194+
eg.Go(walkFilesystem(ctx, cfg, statz, paths, filesCh))
198195

199196
// wait for everything to complete
200197
return eg.Wait()
@@ -203,6 +200,7 @@ func Run(v *viper.Viper, cmd *cobra.Command, paths []string) error {
203200
func walkFilesystem(
204201
ctx context.Context,
205202
cfg *config.Config,
203+
statz *stats.Stats,
206204
paths []string,
207205
filesCh chan *walk.File,
208206
) func() error {
@@ -258,8 +256,8 @@ func walkFilesystem(
258256
case <-ctx.Done():
259257
return ctx.Err()
260258
default:
261-
stats.Add(stats.Traversed, 1)
262-
stats.Add(stats.Emitted, 1)
259+
statz.Add(stats.Traversed, 1)
260+
statz.Add(stats.Emitted, 1)
263261
filesCh <- file
264262
return nil
265263
}
@@ -268,7 +266,7 @@ func walkFilesystem(
268266

269267
// otherwise we pass the walker to the cache and have it generate files for processing based on whether or not
270268
// they have been added/changed since the last invocation
271-
if err = cache.ChangeSet(ctx, walker, filesCh); err != nil {
269+
if err = cache.ChangeSet(ctx, statz, walker, filesCh); err != nil {
272270
return fmt.Errorf("failed to generate change set: %w", err)
273271
}
274272
return nil
@@ -279,6 +277,7 @@ func walkFilesystem(
279277
func applyFormatters(
280278
ctx context.Context,
281279
cfg *config.Config,
280+
statz *stats.Stats,
282281
globalExcludes []glob.Glob,
283282
formatters map[string]*format.Formatter,
284283
filesCh chan *walk.File,
@@ -389,7 +388,7 @@ func applyFormatters(
389388
}
390389
} else {
391390
// record the match
392-
stats.Add(stats.Matched, 1)
391+
statz.Add(stats.Matched, 1)
393392
// create a new format task, add it to a batch based on its batch key and try to apply if the batch is full
394393
task := format.NewTask(file, matches)
395394
tryApply(&task)
@@ -409,7 +408,13 @@ func applyFormatters(
409408
}
410409
}
411410

412-
func detectFormatted(ctx context.Context, cfg *config.Config, formattedCh chan *format.Task, processedCh chan *format.Task) func() error {
411+
func detectFormatted(
412+
ctx context.Context,
413+
cfg *config.Config,
414+
statz *stats.Stats,
415+
formattedCh chan *format.Task,
416+
processedCh chan *format.Task,
417+
) func() error {
413418
return func() error {
414419
defer func() {
415420
// close formatted channel
@@ -438,7 +443,7 @@ func detectFormatted(ctx context.Context, cfg *config.Config, formattedCh chan *
438443

439444
if changed {
440445
// record the change
441-
stats.Add(stats.Formatted, 1)
446+
statz.Add(stats.Formatted, 1)
442447

443448
logMethod := log.Debug
444449
if cfg.FailOnChange {
@@ -466,7 +471,12 @@ func detectFormatted(ctx context.Context, cfg *config.Config, formattedCh chan *
466471
}
467472
}
468473

469-
func updateCache(ctx context.Context, cfg *config.Config, processedCh chan *format.Task) func() error {
474+
func updateCache(
475+
ctx context.Context,
476+
cfg *config.Config,
477+
statz *stats.Stats,
478+
processedCh chan *format.Task,
479+
) func() error {
470480
return func() error {
471481
// used to batch updates for more efficient txs
472482
batch := make([]*format.Task, 0, BatchSize)
@@ -544,13 +554,13 @@ func updateCache(ctx context.Context, cfg *config.Config, processedCh chan *form
544554
}
545555

546556
// if fail on change has been enabled, check that no files were actually formatted, throwing an error if so
547-
if cfg.FailOnChange && stats.Value(stats.Formatted) != 0 {
557+
if cfg.FailOnChange && statz.Value(stats.Formatted) != 0 {
548558
return ErrFailOnChange
549559
}
550560

551561
// print stats to stdout unless we are processing stdin and printing the results to stdout
552562
if !cfg.Stdin {
553-
stats.Print()
563+
statz.Print()
554564
}
555565

556566
return nil

‎cmd/root.go

+10-5
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ import (
55
"os"
66
"path/filepath"
77

8+
"github.com/numtide/treefmt/stats"
9+
810
"github.com/charmbracelet/log"
911
"github.com/numtide/treefmt/build"
1012
"github.com/numtide/treefmt/cmd/format"
@@ -14,7 +16,7 @@ import (
1416
"github.com/spf13/viper"
1517
)
1618

17-
func NewRoot() *cobra.Command {
19+
func NewRoot() (*cobra.Command, *stats.Stats) {
1820
var (
1921
treefmtInit bool
2022
configFile string
@@ -26,13 +28,16 @@ func NewRoot() *cobra.Command {
2628
cobra.CheckErr(fmt.Errorf("failed to create viper instance: %w", err))
2729
}
2830

31+
// create a new stats instance
32+
statz := stats.New()
33+
2934
// create out root command
3035
cmd := &cobra.Command{
3136
Use: "treefmt <paths...>",
3237
Short: "One CLI to format your repo",
3338
Version: build.Version,
3439
RunE: func(cmd *cobra.Command, args []string) error {
35-
return runE(v, cmd, args)
40+
return runE(v, &statz, cmd, args)
3641
},
3742
}
3843

@@ -62,10 +67,10 @@ func NewRoot() *cobra.Command {
6267
// conforms with https://github.com/numtide/prj-spec/blob/main/PRJ_SPEC.md
6368
cobra.CheckErr(v.BindPFlag("prj_root", fs.Lookup("tree-root")))
6469

65-
return cmd
70+
return cmd, &statz
6671
}
6772

68-
func runE(v *viper.Viper, cmd *cobra.Command, args []string) error {
73+
func runE(v *viper.Viper, statz *stats.Stats, cmd *cobra.Command, args []string) error {
6974
flags := cmd.Flags()
7075

7176
// change working directory if required
@@ -123,5 +128,5 @@ func runE(v *viper.Viper, cmd *cobra.Command, args []string) error {
123128
}
124129

125130
// format
126-
return format.Run(v, cmd, args)
131+
return format.Run(v, statz, cmd, args)
127132
}

0 commit comments

Comments
 (0)