dots

README

Dots

Implements the wildcard file matching in Go used by golint, go test etc.

Usage

import "github.com/mgechev/dots"

func main() {
  result, err := dots.Resolve([]string{"./fixtures/..."}, []string{"./fixtures/foo"})
  for _, f := range result {
    fmt.Println(f);
  }
}

If we suppose that we have the following directory structure:

├── README.md
├── fixtures
│   ├── bar
│   │   ├── bar1.go
│   │   └── bar2.go
│   ├── baz
│   │   ├── baz1.go
│   │   ├── baz2.go
│   │   └── baz3.go
│   └── foo
│       ├── foo1.go
│       ├── foo2.go
│       └── foo3.go
└── main.go

The result will be:

fixtures/bar/bar1.go
fixtures/bar/bar2.go
fixtures/baz/baz1.go
fixtures/baz/baz2.go
fixtures/baz/baz3.go

dots supports wildcard in both - the first and the last argument of Resolve, which means that you can ignore files based on a wildcard:

dots.Resolve([]string{"github.com/mgechev/dots"}, []string{"./..."}) // empty list
dots.Resolve([]string{"./fixtures/bar/..."}, []string{"./fixture/foo/...", "./fixtures/baz/..."}) // bar1.go, bar2.go

Preserve package structure

dots allow you to receive a slice of slices where each nested slice represents an individual package:

dots.ResolvePackages([]string{"github.com/mgechev/dots/..."}, []string{})

So we will get the result:

[
  [
    "$GOROOT/src/github.com/mgechev/dots/fixtures/dummy/bar/bar1.go",
    "$GOROOT/src/github.com/mgechev/dots/fixtures/dummy/bar/bar2.go"
  ],
  [
    "$GOROOT/src/github.com/mgechev/dots/fixtures/dummy/baz/baz1.go",
    "$GOROOT/src/github.com/mgechev/dots/fixtures/dummy/baz/baz2.go",
    "$GOROOT/src/github.com/mgechev/dots/fixtures/dummy/baz/baz3.go"
  ],
  [
    "$GOROOT/src/github.com/mgechev/dots/fixtures/dummy/foo/foo1.go",
    "$GOROOT/src/github.com/mgechev/dots/fixtures/dummy/foo/foo2.go",
    "$GOROOT/src/github.com/mgechev/dots/fixtures/dummy/foo/foo3.go"
  ],
  [
    "$GOROOT/src/github.com/mgechev/dots/fixtures/pkg/baz/baz1.go",
    "$GOROOT/src/github.com/mgechev/dots/fixtures/pkg/baz/baz2.go"
  ],
  [
    "$GOROOT/src/github.com/mgechev/dots/fixtures/pkg/foo/foo1.go",
    "$GOROOT/src/github.com/mgechev/dots/fixtures/pkg/foo/foo2.go"
  ],
  [
    "$GOROOT/src/github.com/mgechev/dots/fixtures/pkg/foo/bar/bar1.go"
  ]
]

This method is especially useful, when you want to perform type checking over given package from the result.

License

MIT

Documentation

Index

• func Resolve(includePatterns, skipPatterns []string) ([]string, error)
• func ResolvePackages(includePatterns, skipPatterns []string) ([][]string, error)

Functions

func Resolve

func Resolve(includePatterns, skipPatterns []string) ([]string, error)

Resolve accepts a slice of paths with optional "..." placeholder and a slice with paths to be skipped. The final result is the set of all files from the selected directories subtracted with the files in the skip slice.

func ResolvePackages

func ResolvePackages(includePatterns, skipPatterns []string) ([][]string, error)

ResolvePackages accepts a slice of paths with optional "..." placeholder and a slice with paths to be skipped. The final result is the set of all files from the selected directories subtracted with the files in the skip slice. The difference between `Resolve` and `ResolvePackages` is that `ResolvePackages` preserves the package structure in the nested slices.