Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,7 @@ actors-code-gen:
$(GOCC) fmt ./...

actors-gen: actors-code-gen
./scripts/fiximports
$(GOCC) run ./scripts/fiximports
.PHONY: actors-gen

bundle-gen:
Expand Down Expand Up @@ -392,10 +392,10 @@ docsgen-openrpc-gateway: docsgen-openrpc-bin
.PHONY: docsgen docsgen-md-bin docsgen-openrpc-bin

fiximports:
./scripts/fiximports
$(GOCC) run ./scripts/fiximports

gen: actors-code-gen type-gen cfgdoc-gen docsgen api-gen circleci
./scripts/fiximports
$(GOCC) run ./scripts/fiximports
@echo ">>> IF YOU'VE MODIFIED THE CLI OR CONFIG, REMEMBER TO ALSO RUN 'make docsgen-cli'"
.PHONY: gen

Expand Down
22 changes: 0 additions & 22 deletions scripts/fiximports

This file was deleted.

92 changes: 92 additions & 0 deletions scripts/fiximports/main.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
package main

import (
"bytes"
"fmt"
"io"
"io/fs"
"os"
"path/filepath"
"regexp"
"strings"

"golang.org/x/tools/imports"
)

var (
// groupByPrefixes is the list of import prefixes that should _each_ be grouped separately.
// See: imports.LocalPrefix.
groupByPrefixes = []string{
"github.com/filecoin-project",
"github.com/filecoin-project/lotus",
}
newline = []byte("\n")
importBlockRegex = regexp.MustCompile(`(?s)import\s*\((.*?)\)`)
consecutiveNewlinesRegex = regexp.MustCompile(`\n\s*\n`)
)

func main() {
if err := filepath.Walk(".", func(path string, info fs.FileInfo, err error) error {
switch {
case err != nil:
return err
case // Skip the entire "./extern/..." directory and its contents.
strings.HasPrefix(path, "extern/"):
return filepath.SkipDir
case // Skip directories, generated cborgen go files and any other non-go files.
info.IsDir(),
strings.HasSuffix(info.Name(), "_cbor_gen.go"),
!strings.HasSuffix(info.Name(), ".go"):
return nil
}
return fixGoImports(path)
Comment thread
Stebalien marked this conversation as resolved.
}); err != nil {
fmt.Printf("Error fixing go imports: %v\n", err)
Comment thread
masih marked this conversation as resolved.
os.Exit(1)
}
}

func fixGoImports(path string) error {
sourceFile, err := os.OpenFile(path, os.O_RDWR, 0666)
if err != nil {
return err
}
defer func() { _ = sourceFile.Close() }()

source, err := io.ReadAll(sourceFile)
if err != nil {
return err
}
formatted := collapseImportNewlines(source)
for _, prefix := range groupByPrefixes {
imports.LocalPrefix = prefix
formatted, err = imports.Process(path, formatted, nil)
if err != nil {
return err
}
}
if !bytes.Equal(source, formatted) {
if err := replaceFileContent(sourceFile, formatted); err != nil {
return err
}
}
return nil
}

func replaceFileContent(target *os.File, replacement []byte) error {
if _, err := target.Seek(0, io.SeekStart); err != nil {
return err
}
written, err := target.Write(replacement)
if err != nil {
return err
}
return target.Truncate(int64(written))
Comment on lines +80 to +84
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: I'd generally recommend that you truncate then write. It shouldn't make any difference at the OS level, but it'll reduce the chances of someone observing a garbage version.

(well, actually, it might make a difference with a CoW filesystem...)

But this is getting deep into nit forest.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting; thank you for pointing that out

}

func collapseImportNewlines(content []byte) []byte {
return importBlockRegex.ReplaceAllFunc(content, func(importBlock []byte) []byte {
// Replace consecutive newlines with a single newline within the import block
return consecutiveNewlinesRegex.ReplaceAll(importBlock, newline)
})
}