support formatter ordering #20
|
@ -6,6 +6,7 @@ import (
|
||||||
"fmt"
|
"fmt"
|
||||||
"os"
|
"os"
|
||||||
"os/signal"
|
"os/signal"
|
||||||
|
"strings"
|
||||||
"syscall"
|
"syscall"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
@ -64,8 +65,46 @@ func (f *Format) Run() error {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
formatters := make(map[string]*format.Formatter)
|
||||||
|
|
||||||
|
// detect broken dependencies
|
||||||
|
for name, config := range cfg.Formatters {
|
||||||
|
before := config.Before
|
||||||
|
if before != "" {
|
||||||
|
// check child formatter exists
|
||||||
|
_, ok := cfg.Formatters[before]
|
||||||
brianmcgee marked this conversation as resolved
Outdated
|
|||||||
|
if !ok {
|
||||||
|
return fmt.Errorf("formatter %v is before %v but config for %v was not found", name, before, before)
|
||||||
brianmcgee marked this conversation as resolved
Outdated
zimbatm
commented
You need a second for loop here to check for the dependency cycle. You need a second for loop here to check for the dependency cycle.
brianmcgee
commented
Yeah I haven't done the dependency cycle check yet Yeah I haven't done the dependency cycle check yet
brianmcgee
commented
Addressed in Addressed in 23c86cee027e133181577f749f7716e1ad0986cb
|
|||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// dependency cycle detection
|
||||||
|
for name, config := range cfg.Formatters {
|
||||||
|
var ok bool
|
||||||
|
var history []string
|
||||||
|
childName := name
|
||||||
|
for {
|
||||||
|
// add to history
|
||||||
|
history = append(history, childName)
|
||||||
|
|
||||||
|
if config.Before == "" {
|
||||||
|
break
|
||||||
|
} else if config.Before == name {
|
||||||
|
return fmt.Errorf("formatter cycle detected %v", strings.Join(history, " -> "))
|
||||||
|
}
|
||||||
|
|
||||||
|
// load child config
|
||||||
|
childName = config.Before
|
||||||
|
config, ok = cfg.Formatters[config.Before]
|
||||||
|
if !ok {
|
||||||
|
return fmt.Errorf("formatter not found: %v", config.Before)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
// init formatters
|
// init formatters
|
||||||
for name, formatter := range cfg.Formatters {
|
for name, config := range cfg.Formatters {
|
||||||
if !includeFormatter(name) {
|
if !includeFormatter(name) {
|
||||||
// remove this formatter
|
// remove this formatter
|
||||||
delete(cfg.Formatters, name)
|
delete(cfg.Formatters, name)
|
||||||
|
@ -73,24 +112,36 @@ func (f *Format) Run() error {
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
|
|
||||||
err = formatter.Init(name, globalExcludes)
|
formatter, err := format.NewFormatter(name, config, globalExcludes)
|
||||||
if errors.Is(err, format.ErrFormatterNotFound) && Cli.AllowMissingFormatter {
|
if errors.Is(err, format.ErrFormatterNotFound) && Cli.AllowMissingFormatter {
|
||||||
l.Debugf("formatter not found: %v", name)
|
l.Debugf("formatter not found: %v", name)
|
||||||
// remove this formatter
|
continue
|
||||||
delete(cfg.Formatters, name)
|
|
||||||
} else if err != nil {
|
} else if err != nil {
|
||||||
return fmt.Errorf("%w: failed to initialise formatter: %v", err, name)
|
return fmt.Errorf("%w: failed to initialise formatter: %v", err, name)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
formatters[name] = formatter
|
||||||
}
|
}
|
||||||
|
|
||||||
ctx = format.RegisterFormatters(ctx, cfg.Formatters)
|
// iterate the initialised formatters configuring parent/child relationships
|
||||||
|
for _, formatter := range formatters {
|
||||||
|
if formatter.Before() != "" {
|
||||||
|
child, ok := formatters[formatter.Before()]
|
||||||
|
if !ok {
|
||||||
|
// formatter has been filtered out by the user
|
||||||
|
formatter.ResetBefore()
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
formatter.SetChild(child)
|
||||||
|
child.SetParent(formatter)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
if err = cache.Open(Cli.TreeRoot, Cli.ClearCache, cfg.Formatters); err != nil {
|
if err = cache.Open(Cli.TreeRoot, Cli.ClearCache, formatters); err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
//
|
//
|
||||||
pendingCh := make(chan string, 1024)
|
|
||||||
completedCh := make(chan string, 1024)
|
completedCh := make(chan string, 1024)
|
||||||
|
|
||||||
ctx = format.SetCompletedChannel(ctx, completedCh)
|
ctx = format.SetCompletedChannel(ctx, completedCh)
|
||||||
|
@ -99,8 +150,8 @@ func (f *Format) Run() error {
|
||||||
eg, ctx := errgroup.WithContext(ctx)
|
eg, ctx := errgroup.WithContext(ctx)
|
||||||
|
|
||||||
// start the formatters
|
// start the formatters
|
||||||
for name := range cfg.Formatters {
|
for name := range formatters {
|
||||||
formatter := cfg.Formatters[name]
|
formatter := formatters[name]
|
||||||
eg.Go(func() error {
|
eg.Go(func() error {
|
||||||
return formatter.Run(ctx)
|
return formatter.Run(ctx)
|
||||||
})
|
})
|
||||||
|
@ -114,20 +165,13 @@ func (f *Format) Run() error {
|
||||||
batchSize := 1024
|
batchSize := 1024
|
||||||
batch := make([]string, 0, batchSize)
|
batch := make([]string, 0, batchSize)
|
||||||
|
|
||||||
var pending, completed, changes int
|
var changes int
|
||||||
|
|
||||||
LOOP:
|
LOOP:
|
||||||
for {
|
for {
|
||||||
select {
|
select {
|
||||||
case <-ctx.Done():
|
case <-ctx.Done():
|
||||||
return ctx.Err()
|
return ctx.Err()
|
||||||
case _, ok := <-pendingCh:
|
|
||||||
if ok {
|
|
||||||
pending += 1
|
|
||||||
} else if pending == completed {
|
|
||||||
break LOOP
|
|
||||||
}
|
|
||||||
|
|
||||||
case path, ok := <-completedCh:
|
case path, ok := <-completedCh:
|
||||||
if !ok {
|
if !ok {
|
||||||
break LOOP
|
break LOOP
|
||||||
|
@ -141,12 +185,6 @@ func (f *Format) Run() error {
|
||||||
changes += count
|
changes += count
|
||||||
batch = batch[:0]
|
batch = batch[:0]
|
||||||
}
|
}
|
||||||
|
|
||||||
completed += 1
|
|
||||||
|
|
||||||
if completed == pending {
|
|
||||||
close(completedCh)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -166,26 +204,32 @@ func (f *Format) Run() error {
|
||||||
})
|
})
|
||||||
|
|
||||||
eg.Go(func() error {
|
eg.Go(func() error {
|
||||||
count := 0
|
// pass paths to each formatter
|
||||||
|
|
||||||
for path := range pathsCh {
|
for path := range pathsCh {
|
||||||
for _, formatter := range cfg.Formatters {
|
for _, formatter := range formatters {
|
||||||
if formatter.Wants(path) {
|
if formatter.Wants(path) {
|
||||||
pendingCh <- path
|
|
||||||
count += 1
|
|
||||||
formatter.Put(path)
|
formatter.Put(path)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, formatter := range cfg.Formatters {
|
// indicate no more paths for each formatter
|
||||||
|
for _, formatter := range formatters {
|
||||||
|
if formatter.Parent() != nil {
|
||||||
|
// this formatter is not a root, it will be closed by a parent
|
||||||
|
continue
|
||||||
|
}
|
||||||
formatter.Close()
|
formatter.Close()
|
||||||
}
|
}
|
||||||
|
|
||||||
if count == 0 {
|
// await completion
|
||||||
close(completedCh)
|
for _, formatter := range formatters {
|
||||||
|
formatter.AwaitCompletion()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// indicate no more completion events
|
||||||
|
close(completedCh)
|
||||||
|
|
||||||
return nil
|
return nil
|
||||||
})
|
})
|
||||||
|
|
||||||
|
|
|
@ -25,7 +25,7 @@ func TestAllowMissingFormatter(t *testing.T) {
|
||||||
configPath := tempDir + "/treefmt.toml"
|
configPath := tempDir + "/treefmt.toml"
|
||||||
|
|
||||||
test.WriteConfig(t, configPath, format.Config{
|
test.WriteConfig(t, configPath, format.Config{
|
||||||
Formatters: map[string]*format.Formatter{
|
Formatters: map[string]*format.FormatterConfig{
|
||||||
"foo-fmt": {
|
"foo-fmt": {
|
||||||
Command: "foo-fmt",
|
Command: "foo-fmt",
|
||||||
},
|
},
|
||||||
|
@ -39,6 +39,27 @@ func TestAllowMissingFormatter(t *testing.T) {
|
||||||
as.NoError(err)
|
as.NoError(err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestDependencyCycle(t *testing.T) {
|
||||||
|
as := require.New(t)
|
||||||
|
|
||||||
|
tempDir := t.TempDir()
|
||||||
|
configPath := tempDir + "/treefmt.toml"
|
||||||
|
|
||||||
|
test.WriteConfig(t, configPath, format.Config{
|
||||||
|
Formatters: map[string]*format.FormatterConfig{
|
||||||
|
"a": {Command: "echo", Before: "b"},
|
||||||
|
"b": {Command: "echo", Before: "c"},
|
||||||
|
"c": {Command: "echo", Before: "a"},
|
||||||
|
"d": {Command: "echo", Before: "e"},
|
||||||
|
"e": {Command: "echo", Before: "f"},
|
||||||
|
"f": {Command: "echo"},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
_, err := cmd(t, "--config-file", configPath, "--tree-root", tempDir)
|
||||||
|
as.ErrorContains(err, "formatter cycle detected a -> b -> c")
|
||||||
|
}
|
||||||
|
|
||||||
func TestSpecifyingFormatters(t *testing.T) {
|
func TestSpecifyingFormatters(t *testing.T) {
|
||||||
as := require.New(t)
|
as := require.New(t)
|
||||||
|
|
||||||
|
@ -46,7 +67,7 @@ func TestSpecifyingFormatters(t *testing.T) {
|
||||||
configPath := tempDir + "/treefmt.toml"
|
configPath := tempDir + "/treefmt.toml"
|
||||||
|
|
||||||
test.WriteConfig(t, configPath, format.Config{
|
test.WriteConfig(t, configPath, format.Config{
|
||||||
Formatters: map[string]*format.Formatter{
|
Formatters: map[string]*format.FormatterConfig{
|
||||||
"elm": {
|
"elm": {
|
||||||
Command: "echo",
|
Command: "echo",
|
||||||
Includes: []string{"*.elm"},
|
Includes: []string{"*.elm"},
|
||||||
|
@ -95,7 +116,7 @@ func TestIncludesAndExcludes(t *testing.T) {
|
||||||
|
|
||||||
// test without any excludes
|
// test without any excludes
|
||||||
config := format.Config{
|
config := format.Config{
|
||||||
Formatters: map[string]*format.Formatter{
|
Formatters: map[string]*format.FormatterConfig{
|
||||||
"echo": {
|
"echo": {
|
||||||
Command: "echo",
|
Command: "echo",
|
||||||
Includes: []string{"*"},
|
Includes: []string{"*"},
|
||||||
|
@ -167,7 +188,7 @@ func TestCache(t *testing.T) {
|
||||||
|
|
||||||
// test without any excludes
|
// test without any excludes
|
||||||
config := format.Config{
|
config := format.Config{
|
||||||
Formatters: map[string]*format.Formatter{
|
Formatters: map[string]*format.FormatterConfig{
|
||||||
"echo": {
|
"echo": {
|
||||||
Command: "echo",
|
Command: "echo",
|
||||||
Includes: []string{"*"},
|
Includes: []string{"*"},
|
||||||
|
@ -202,7 +223,7 @@ func TestChangeWorkingDirectory(t *testing.T) {
|
||||||
|
|
||||||
// test without any excludes
|
// test without any excludes
|
||||||
config := format.Config{
|
config := format.Config{
|
||||||
Formatters: map[string]*format.Formatter{
|
Formatters: map[string]*format.FormatterConfig{
|
||||||
"echo": {
|
"echo": {
|
||||||
Command: "echo",
|
Command: "echo",
|
||||||
Includes: []string{"*"},
|
Includes: []string{"*"},
|
||||||
|
@ -227,7 +248,7 @@ func TestFailOnChange(t *testing.T) {
|
||||||
|
|
||||||
// test without any excludes
|
// test without any excludes
|
||||||
config := format.Config{
|
config := format.Config{
|
||||||
Formatters: map[string]*format.Formatter{
|
Formatters: map[string]*format.FormatterConfig{
|
||||||
"echo": {
|
"echo": {
|
||||||
Command: "echo",
|
Command: "echo",
|
||||||
Includes: []string{"*"},
|
Includes: []string{"*"},
|
||||||
|
@ -263,7 +284,7 @@ func TestBustCacheOnFormatterChange(t *testing.T) {
|
||||||
|
|
||||||
// start with 2 formatters
|
// start with 2 formatters
|
||||||
config := format.Config{
|
config := format.Config{
|
||||||
Formatters: map[string]*format.Formatter{
|
Formatters: map[string]*format.FormatterConfig{
|
||||||
"python": {
|
"python": {
|
||||||
Command: "black",
|
Command: "black",
|
||||||
Includes: []string{"*.py"},
|
Includes: []string{"*.py"},
|
||||||
|
@ -307,7 +328,7 @@ func TestBustCacheOnFormatterChange(t *testing.T) {
|
||||||
as.Contains(string(out), "0 files changed")
|
as.Contains(string(out), "0 files changed")
|
||||||
|
|
||||||
// add go formatter
|
// add go formatter
|
||||||
config.Formatters["go"] = &format.Formatter{
|
config.Formatters["go"] = &format.FormatterConfig{
|
||||||
Command: "gofmt",
|
Command: "gofmt",
|
||||||
Options: []string{"-w"},
|
Options: []string{"-w"},
|
||||||
Includes: []string{"*.go"},
|
Includes: []string{"*.go"},
|
||||||
|
@ -358,7 +379,7 @@ func TestGitWorktree(t *testing.T) {
|
||||||
|
|
||||||
// basic config
|
// basic config
|
||||||
config := format.Config{
|
config := format.Config{
|
||||||
Formatters: map[string]*format.Formatter{
|
Formatters: map[string]*format.FormatterConfig{
|
||||||
"echo": {
|
"echo": {
|
||||||
Command: "echo",
|
Command: "echo",
|
||||||
Includes: []string{"*"},
|
Includes: []string{"*"},
|
||||||
|
@ -404,3 +425,57 @@ func TestGitWorktree(t *testing.T) {
|
||||||
as.NoError(err)
|
as.NoError(err)
|
||||||
as.Contains(string(out), fmt.Sprintf("%d files changed", 55))
|
as.Contains(string(out), fmt.Sprintf("%d files changed", 55))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestOrderingFormatters(t *testing.T) {
|
||||||
|
as := require.New(t)
|
||||||
|
|
||||||
|
tempDir := test.TempExamples(t)
|
||||||
|
configPath := path.Join(tempDir, "treefmt.toml")
|
||||||
|
|
||||||
|
// missing child
|
||||||
|
test.WriteConfig(t, configPath, format.Config{
|
||||||
|
Formatters: map[string]*format.FormatterConfig{
|
||||||
|
"hs-a": {
|
||||||
|
Command: "echo",
|
||||||
|
Includes: []string{"*.hs"},
|
||||||
|
Before: "hs-b",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
out, err := cmd(t, "--config-file", configPath, "--tree-root", tempDir)
|
||||||
|
as.ErrorContains(err, "formatter hs-a is before hs-b but config for hs-b was not found")
|
||||||
|
|
||||||
|
// multiple roots
|
||||||
|
test.WriteConfig(t, configPath, format.Config{
|
||||||
|
Formatters: map[string]*format.FormatterConfig{
|
||||||
|
"hs-a": {
|
||||||
|
Command: "echo",
|
||||||
|
Includes: []string{"*.hs"},
|
||||||
|
Before: "hs-b",
|
||||||
|
},
|
||||||
|
"hs-b": {
|
||||||
|
Command: "echo",
|
||||||
|
Includes: []string{"*.hs"},
|
||||||
|
Before: "hs-c",
|
||||||
|
},
|
||||||
|
"hs-c": {
|
||||||
|
Command: "echo",
|
||||||
|
Includes: []string{"*.hs"},
|
||||||
|
},
|
||||||
|
"py-a": {
|
||||||
|
Command: "echo",
|
||||||
|
Includes: []string{"*.py"},
|
||||||
|
Before: "py-b",
|
||||||
|
},
|
||||||
|
"py-b": {
|
||||||
|
Command: "echo",
|
||||||
|
Includes: []string{"*.py"},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
out, err = cmd(t, "--config-file", configPath, "--tree-root", tempDir)
|
||||||
|
as.NoError(err)
|
||||||
|
as.Contains(string(out), "8 files changed")
|
||||||
|
}
|
||||||
|
|
|
@ -8,7 +8,7 @@ type Config struct {
|
||||||
// Excludes is an optional list of glob patterns used to exclude certain files from all formatters.
|
// Excludes is an optional list of glob patterns used to exclude certain files from all formatters.
|
||||||
Excludes []string
|
Excludes []string
|
||||||
}
|
}
|
||||||
Formatters map[string]*Formatter `toml:"formatter"`
|
Formatters map[string]*FormatterConfig `toml:"formatter"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// ReadConfigFile reads from path and unmarshals toml into a Config instance.
|
// ReadConfigFile reads from path and unmarshals toml into a Config instance.
|
||||||
|
|
|
@ -5,28 +5,17 @@ import (
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
formattersKey = "formatters"
|
|
||||||
completedChKey = "completedCh"
|
completedChKey = "completedCh"
|
||||||
)
|
)
|
||||||
|
|
||||||
// RegisterFormatters is used to set a map of formatters in the provided context.
|
|
||||||
func RegisterFormatters(ctx context.Context, formatters map[string]*Formatter) context.Context {
|
|
||||||
return context.WithValue(ctx, formattersKey, formatters)
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetFormatters is used to retrieve a formatters map from the provided context.
|
|
||||||
func GetFormatters(ctx context.Context) map[string]*Formatter {
|
|
||||||
return ctx.Value(formattersKey).(map[string]*Formatter)
|
|
||||||
}
|
|
||||||
|
|
||||||
// SetCompletedChannel is used to set a channel for indication processing completion in the provided context.
|
// SetCompletedChannel is used to set a channel for indication processing completion in the provided context.
|
||||||
func SetCompletedChannel(ctx context.Context, completedCh chan string) context.Context {
|
func SetCompletedChannel(ctx context.Context, completedCh chan string) context.Context {
|
||||||
return context.WithValue(ctx, completedChKey, completedCh)
|
return context.WithValue(ctx, completedChKey, completedCh)
|
||||||
}
|
}
|
||||||
|
|
||||||
// MarkFormatComplete is used to indicate that all processing has finished for the provided path.
|
// MarkPathComplete is used to indicate that all processing has finished for the provided path.
|
||||||
// This is done by adding the path to the completion channel which should have already been set using
|
// This is done by adding the path to the completion channel which should have already been set using
|
||||||
// SetCompletedChannel.
|
// SetCompletedChannel.
|
||||||
func MarkFormatComplete(ctx context.Context, path string) {
|
func MarkPathComplete(ctx context.Context, path string) {
|
||||||
ctx.Value(completedChKey).(chan string) <- path
|
ctx.Value(completedChKey).(chan string) <- path
|
||||||
}
|
}
|
||||||
|
|
|
@ -14,8 +14,7 @@ import (
|
||||||
// ErrFormatterNotFound is returned when the Command for a Formatter is not available.
|
// ErrFormatterNotFound is returned when the Command for a Formatter is not available.
|
||||||
var ErrFormatterNotFound = errors.New("formatter not found")
|
var ErrFormatterNotFound = errors.New("formatter not found")
|
||||||
|
|
||||||
// Formatter represents a command which should be applied to a filesystem.
|
type FormatterConfig struct {
|
||||||
type Formatter struct {
|
|
||||||
// Command is the command invoke when applying this Formatter.
|
// Command is the command invoke when applying this Formatter.
|
||||||
Command string
|
Command string
|
||||||
// Options are an optional list of args to be passed to Command.
|
// Options are an optional list of args to be passed to Command.
|
||||||
|
@ -24,64 +23,100 @@ type Formatter struct {
|
||||||
Includes []string
|
Includes []string
|
||||||
// Excludes is an optional list of glob patterns used to exclude certain files from this Formatter.
|
// Excludes is an optional list of glob patterns used to exclude certain files from this Formatter.
|
||||||
Excludes []string
|
Excludes []string
|
||||||
|
// Before is the name of another formatter which must process a path after this one
|
||||||
|
Before string
|
||||||
|
}
|
||||||
brianmcgee marked this conversation as resolved
Outdated
zimbatm
commented
Personal taste thing: because of how many public/private fields there are, I would split this into a FormatterConfig that only contains the config and serializes/deserializes, and then the Formatter that gets generated from the config. That way, how to interact with the structs in the rest of the code becomes clearer. I don't think the Before field should be mutated in the code for example. Personal taste thing: because of how many public/private fields there are, I would split this into a FormatterConfig that only contains the config and serializes/deserializes, and then the Formatter that gets generated from the config. That way, how to interact with the structs in the rest of the code becomes clearer. I don't think the Before field should be mutated in the code for example.
brianmcgee
commented
It was a fair point, I've separated things out in It was a fair point, I've separated things out in https://git.numtide.com/numtide/treefmt/commit/c54265517754f4d67684e5810c87cbba0644ae0d
|
|||||||
|
|
||||||
|
// Formatter represents a command which should be applied to a filesystem.
|
||||||
|
type Formatter struct {
|
||||||
name string
|
name string
|
||||||
|
config *FormatterConfig
|
||||||
|
|
||||||
log *log.Logger
|
log *log.Logger
|
||||||
executable string // path to the executable described by Command
|
executable string // path to the executable described by Command
|
||||||
|
|
||||||
|
before string
|
||||||
|
parent *Formatter
|
||||||
|
child *Formatter
|
||||||
|
|
||||||
// internal compiled versions of Includes and Excludes.
|
// internal compiled versions of Includes and Excludes.
|
||||||
includes []glob.Glob
|
includes []glob.Glob
|
||||||
excludes []glob.Glob
|
excludes []glob.Glob
|
||||||
|
|
||||||
// inbox is used to accept new paths for formatting.
|
// inboxCh is used to accept new paths for formatting.
|
||||||
inbox chan string
|
inboxCh chan string
|
||||||
|
// completedCh is used to wait for this formatter to finish all processing.
|
||||||
|
completedCh chan interface{}
|
||||||
|
|
||||||
// Entries from inbox are batched according to batchSize and stored in batch for processing when the batchSize has
|
// Entries from inboxCh are batched according to batchSize and stored in batch for processing when the batchSize has
|
||||||
// been reached or Close is invoked.
|
// been reached or Close is invoked.
|
||||||
batch []string
|
batch []string
|
||||||
batchSize int
|
batchSize int
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func (f *Formatter) Before() string {
|
||||||
|
return f.before
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *Formatter) ResetBefore() {
|
||||||
|
f.before = ""
|
||||||
|
}
|
||||||
|
|
||||||
// Executable returns the path to the executable defined by Command
|
// Executable returns the path to the executable defined by Command
|
||||||
func (f *Formatter) Executable() string {
|
func (f *Formatter) Executable() string {
|
||||||
return f.executable
|
return f.executable
|
||||||
}
|
}
|
||||||
|
|
||||||
// Init is used to initialise internal state before this Formatter is ready to accept paths.
|
// NewFormatter is used to create a new Formatter.
|
||||||
func (f *Formatter) Init(name string, globalExcludes []glob.Glob) error {
|
func NewFormatter(name string, config *FormatterConfig, globalExcludes []glob.Glob) (*Formatter, error) {
|
||||||
var err error
|
var err error
|
||||||
|
|
||||||
|
f := Formatter{}
|
||||||
// capture the name from the config file
|
// capture the name from the config file
|
||||||
f.name = name
|
f.name = name
|
||||||
|
f.config = config
|
||||||
|
f.before = config.Before
|
||||||
|
|
||||||
// test if the formatter is available
|
// test if the formatter is available
|
||||||
executable, err := exec.LookPath(f.Command)
|
executable, err := exec.LookPath(config.Command)
|
||||||
if errors.Is(err, exec.ErrNotFound) {
|
if errors.Is(err, exec.ErrNotFound) {
|
||||||
return ErrFormatterNotFound
|
return nil, ErrFormatterNotFound
|
||||||
} else if err != nil {
|
} else if err != nil {
|
||||||
return err
|
return nil, err
|
||||||
}
|
}
|
||||||
f.executable = executable
|
f.executable = executable
|
||||||
|
|
||||||
// initialise internal state
|
// initialise internal state
|
||||||
f.log = log.WithPrefix("format | " + name)
|
f.log = log.WithPrefix("format | " + name)
|
||||||
f.batchSize = 1024
|
f.batchSize = 1024
|
||||||
f.inbox = make(chan string, f.batchSize)
|
f.batch = make([]string, 0, f.batchSize)
|
||||||
f.batch = make([]string, f.batchSize)
|
f.inboxCh = make(chan string, f.batchSize)
|
||||||
f.batch = f.batch[:0]
|
f.completedCh = make(chan interface{}, 1)
|
||||||
|
|
||||||
f.includes, err = CompileGlobs(f.Includes)
|
f.includes, err = CompileGlobs(config.Includes)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("%w: formatter '%v' includes", err, f.name)
|
return nil, fmt.Errorf("%w: formatter '%v' includes", err, f.name)
|
||||||
}
|
}
|
||||||
|
|
||||||
f.excludes, err = CompileGlobs(f.Excludes)
|
f.excludes, err = CompileGlobs(config.Excludes)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return fmt.Errorf("%w: formatter '%v' excludes", err, f.name)
|
return nil, fmt.Errorf("%w: formatter '%v' excludes", err, f.name)
|
||||||
}
|
}
|
||||||
f.excludes = append(f.excludes, globalExcludes...)
|
f.excludes = append(f.excludes, globalExcludes...)
|
||||||
|
|
||||||
return nil
|
return &f, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *Formatter) SetParent(formatter *Formatter) {
|
||||||
|
f.parent = formatter
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *Formatter) Parent() *Formatter {
|
||||||
|
return f.parent
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *Formatter) SetChild(formatter *Formatter) {
|
||||||
|
f.child = formatter
|
||||||
}
|
}
|
||||||
|
|
||||||
// Wants is used to test if a Formatter wants path based on it's configured Includes and Excludes patterns.
|
// Wants is used to test if a Formatter wants path based on it's configured Includes and Excludes patterns.
|
||||||
|
@ -94,16 +129,26 @@ func (f *Formatter) Wants(path string) bool {
|
||||||
return match
|
return match
|
||||||
}
|
}
|
||||||
|
|
||||||
// Put add path into this Formatter's inbox for processing.
|
// Put add path into this Formatter's inboxCh for processing.
|
||||||
func (f *Formatter) Put(path string) {
|
func (f *Formatter) Put(path string) {
|
||||||
f.inbox <- path
|
f.inboxCh <- path
|
||||||
}
|
}
|
||||||
|
|
||||||
// Run is the main processing loop for this Formatter.
|
// Run is the main processing loop for this Formatter.
|
||||||
// It accepts a context which is used to lookup certain dependencies and for cancellation.
|
// It accepts a context which is used to lookup certain dependencies and for cancellation.
|
||||||
func (f *Formatter) Run(ctx context.Context) (err error) {
|
func (f *Formatter) Run(ctx context.Context) (err error) {
|
||||||
|
defer func() {
|
||||||
|
if f.child != nil {
|
||||||
|
// indicate no further processing for the child formatter
|
||||||
|
f.child.Close()
|
||||||
|
}
|
||||||
|
|
||||||
|
// indicate this formatter has finished processing
|
||||||
|
f.completedCh <- nil
|
||||||
|
}()
|
||||||
|
|
||||||
LOOP:
|
LOOP:
|
||||||
// keep processing until ctx has been cancelled or inbox has been closed
|
// keep processing until ctx has been cancelled or inboxCh has been closed
|
||||||
for {
|
for {
|
||||||
select {
|
select {
|
||||||
|
|
||||||
|
@ -112,8 +157,8 @@ LOOP:
|
||||||
err = ctx.Err()
|
err = ctx.Err()
|
||||||
break LOOP
|
break LOOP
|
||||||
|
|
||||||
case path, ok := <-f.inbox:
|
case path, ok := <-f.inboxCh:
|
||||||
// check if the inbox has been closed
|
// check if the inboxCh has been closed
|
||||||
if !ok {
|
if !ok {
|
||||||
break LOOP
|
break LOOP
|
||||||
}
|
}
|
||||||
|
@ -148,7 +193,7 @@ func (f *Formatter) apply(ctx context.Context) error {
|
||||||
}
|
}
|
||||||
|
|
||||||
// construct args, starting with config
|
// construct args, starting with config
|
||||||
args := f.Options
|
args := f.config.Options
|
||||||
|
|
||||||
// append each file path
|
// append each file path
|
||||||
for _, path := range f.batch {
|
for _, path := range f.batch {
|
||||||
|
@ -157,7 +202,7 @@ func (f *Formatter) apply(ctx context.Context) error {
|
||||||
|
|
||||||
// execute
|
// execute
|
||||||
start := time.Now()
|
start := time.Now()
|
||||||
cmd := exec.CommandContext(ctx, f.Command, args...)
|
cmd := exec.CommandContext(ctx, f.config.Command, args...)
|
||||||
|
|
||||||
if out, err := cmd.CombinedOutput(); err != nil {
|
if out, err := cmd.CombinedOutput(); err != nil {
|
||||||
f.log.Debugf("\n%v", string(out))
|
f.log.Debugf("\n%v", string(out))
|
||||||
|
@ -167,9 +212,16 @@ func (f *Formatter) apply(ctx context.Context) error {
|
||||||
|
|
||||||
f.log.Infof("%v files processed in %v", len(f.batch), time.Now().Sub(start))
|
f.log.Infof("%v files processed in %v", len(f.batch), time.Now().Sub(start))
|
||||||
|
|
||||||
|
if f.child == nil {
|
||||||
// mark each path in this batch as completed
|
// mark each path in this batch as completed
|
||||||
for _, path := range f.batch {
|
for _, path := range f.batch {
|
||||||
MarkFormatComplete(ctx, path)
|
MarkPathComplete(ctx, path)
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
// otherwise forward each path onto the next formatter for processing
|
||||||
|
for _, path := range f.batch {
|
||||||
|
f.child.Put(path)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// reset batch
|
// reset batch
|
||||||
|
@ -180,5 +232,10 @@ func (f *Formatter) apply(ctx context.Context) error {
|
||||||
|
|
||||||
// Close is used to indicate that a Formatter should process any remaining paths and then stop it's processing loop.
|
// Close is used to indicate that a Formatter should process any remaining paths and then stop it's processing loop.
|
||||||
func (f *Formatter) Close() {
|
func (f *Formatter) Close() {
|
||||||
close(f.inbox)
|
close(f.inboxCh)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (f *Formatter) AwaitCompletion() {
|
||||||
|
// todo support a timeout
|
||||||
|
<-f.completedCh
|
||||||
}
|
}
|
||||||
|
|
Reference in New Issue
Block a user
formatter.Before is there 2 times
If you look at the string you can see why it's listed twice