gooki

README

gooki

list contents of directories in a tree-like format.

Module

Usage

package main

import (
	"os"

	"github.com/masakurapa/gooki"
)

func main() {
	ki, _ := gooki.MakeByDefaultOption(".")
	ki.Write(os.Stdout)
}

Command Line Tool

Installing

$ go get -u github.com/masakurapa/gooki/cmd/gooki

Usage

$ gooki -help

	  _____             _  ___
	 / ____|           | |/ (_)
	| |  __  ___   ___ | ' / _
	| | |_ |/ _ \ / _ \|  < | |
	| |__| | (_) | (_) | . \| |
	 \_____|\___/ \___/|_|\_\_|

Description:
	'gooki' is list contents of directories in a tree-like format.

Synopsis:
	gooki [options...] directory

Options:
  -a	Outputs all files. By default does not hidden files.
  -d	Outputs only directories.
  -f	Outputs full path prefix for each file.
  -help
    	Outputs a usage.

Example

$ gooki
.
├── LICENSE
├── Makefile
├── README.md
├── cmd
│   └── gooki
│       └── main.go
├── go.mod
├── gooki.go
├── internal
│   └── ki
│       ├── interface.go
│       ├── ki.go
│       └── tree_writer.go
└── pkg
    └── gooki
        ├── gooki.go
        └── option.go

5 directories, 10 files

Documentation

Overview

Package gooki はディレクトリの内容をツリー構造で扱うためのモジュールです

Index

• func DefaultOption() gooki.Option
• func Make(path string, option gooki.Option) (gooki.Ki, error)
• func MakeByDefaultOption(path string) (gooki.Ki, error)

Examples

• Make
• MakeByDefaultOption

Functions

func DefaultOption

func DefaultOption() gooki.Option

DefaultOption はデフォルト値を設定したオプションを返します。

Default Values:

AllFile:       false    隠しファイルを出力しない
DirectoryOnly: false    ファイルを出力
ShowFullPath:  false    ファイル名のみ出力

func Make

func Make(path string, option gooki.Option) (gooki.Ki, error)

Make はディレクトリツリー情報を生成します。

Example

package main

import (
	"os"

	"github.com/masakurapa/gooki"
)

func main() {
	ki, err := gooki.Make(".", gooki.DefaultOption())
	if err != nil {
		panic(err)
	}
	ki.Write(os.Stdout)
}

Output:

.
└── path
    └── to
        └── file.go

func MakeByDefaultOption

func MakeByDefaultOption(path string) (gooki.Ki, error)

MakeByDefaultOption はデフォルトのオプションでディレクトリツリー情報を生成します。

Example

package main

import (
	"os"

	"github.com/masakurapa/gooki"
)

func main() {
	ki, err := gooki.MakeByDefaultOption(".")
	if err != nil {
		panic(err)
	}
	ki.Write(os.Stdout)
}

Output:

.
└── path
    └── to
        └── file.go