find

README

find - Go package for locating files

Usage

See package examples!

cmd/ifind

$ go install github.com/gregoryv/find/cmd/ifind@latest
$ ifind --help

ifind supports emacs and vi editors when opening to specific line.

Documentation

Overview

Package find implements search funcs for finding files by name or content

Index

• func InFile(pattern, file string) (result *list.List, err error)
• func InStream(pattern string, stream io.Reader) *list.List
• type Matcher
  • func NewRegexp(ex *regexp.Regexp) Matcher
  • func NewShellPattern(pattern string) Matcher
• type Ref
  • func (ref *Ref) String() string
• type Result
  • func By(m Matcher, root string) (*Result, error)
  • func ByName(pattern, root string) (*Result, error)
  • func (result *Result) Map(fn func(string))

Examples

• ByName
• Result.Map

Functions

func InFile

func InFile(pattern, file string) (result *list.List, err error)

InFile opens and the file and uses InStream to find references

func InStream

func InStream(pattern string, stream io.Reader) *list.List

InStream works much like grep, finding references by the given pattern

Types

type Matcher

type Matcher interface {
	Match(path string) bool
}

func NewRegexp

func NewRegexp(ex *regexp.Regexp) Matcher

func NewShellPattern

func NewShellPattern(pattern string) Matcher

type Ref

type Ref struct {
	LineNo int
	Line   string
}

Ref points to a line in a file starting from 0

func (*Ref) String

func (ref *Ref) String() string

type Result

type Result struct {
	*list.List
}

func By

func By(m Matcher, root string) (*Result, error)

By returns a list of files whose names match

func ByName

func ByName(pattern, root string) (*Result, error)

ByName returns a list of files whose names match the shell like pattern

Example

package main

import (
	"fmt"
	"os"

	"github.com/gregoryv/find"
)

var testRoot string

func main() {
	os.Chdir(testRoot)
	result, _ := find.ByName("*.txt", ".")
	for e := result.Front(); e != nil; e = e.Next() {
		if s, ok := e.Value.(string); ok {
			fmt.Println(s)
		}
	}
}

Output:
a.txt
b.txt

func (*Result) Map

func (result *Result) Map(fn func(string))

Example

package main

import (
	"fmt"
	"os"

	"github.com/gregoryv/find"
)

var testRoot string

func main() {
	os.Chdir(testRoot)
	result, _ := find.ByName("*.txt", ".")
	echo := func(name string) {
		fmt.Println(name)
	}
	result.Map(echo)
}

Output:
a.txt
b.txt