rlpath

README

rlpath.go

rlpath is scanning path with completion library.

Instalation

$ go get -u github.com/yasukotelin/rlpath

import (
	"github.com/yasukotelin/rlpath"
)

Example

You can use this library so easily!!

package main

import (
	"fmt"
	"log"

	"github.com/yasukotelin/rlpath"
)

func main() {
	scanner := rlpath.Scanner{
		Prompt:  "$ ",
		RootDir: "~/go",
		OnlyDir: false,
	}

	path, err := scanner.Scan()
	if err != nil {
		log.Fatal(err)
	}

	fmt.Println(path)
}

rlpath.Scanner has options.

Option
Prompt	Prompt is left edge text, like a $.
RootDir	RootDir is root directory to start scanning. If this is empty, start scanning from execution path.
OnlyDir	OnlyDir is flag that shows only directory.

Author

yasukotelin

LICENCE

MIT

Documentation

Index

• type Scanner
  • func (sc *Scanner) Scan() (string, error)

Types

type Scanner

type Scanner struct {
	// Prompt is left edge text, like a $.
	Prompt string
	// RootDir is root directory to start scanning.
	// If this is empty, start scanning from execution path.
	RootDir string
	// OnlyDir is flag that shows only directory.
	OnlyDir bool
}

Scanner can scan standard input with completetion path.

func (*Scanner) Scan

func (sc *Scanner) Scan() (string, error)

Scan scans path from standard input with completion.