gooki

Documentation

Overview

Package gooki はツリー構造を作るためのインタフェース、オプションを扱うパッケージです

Index

• type Eda
• type Happa
• type Ki
• type ModuleOption
• type Option
  • func DefaultOption() Option

Types

type Eda

type Eda interface {
	// Child は子のファイルまたはディレクトリを返します
	Child() []Eda
	// Happa はファイルまたはディレクトリ情報を返します
	Happa() Happa
	// HasChild はEdaが子のファイルまたはディレクトリを持つかを返します。
	HasChild() bool
}

Eda はファイルまたはディレクトリ情報を階層化するためのインタフェースです

type Happa

type Happa interface {
	// AbsPath はファイルまたはディレクトリ名を絶対パスを返します。
	AbsPath() string
	// RelPath はファイルまたはディレクトリ名をディレクトリツリーの起点からの相対パスを返します。
	RelPath() string
	// Dir はファイル名を除いたパスを返します
	Dir() string
	// Name はファイルまたはディレクトリ名を返します。
	Name() string
	// IsDir はディレクトリの場合にtrueを返します
	IsDir() bool
	// IsHiddenFile は隠しファイルの場合にtrueを返します
	IsHiddenFile() bool
	// IsSymlink はシンボリックリンクの場合にtrueを返します
	IsSymlink() bool
	// RealName はリンク元のファイル名を取得します
	RealName() string
}

Happa はファイルまたはディレクトリ情報を扱うためのインタフェースです

type Ki

type Ki interface {
	// Eda はファイルまたはディレクトリを返します
	Eda() []Eda
	// Write はディレクトリツリーの情報をツリー形式で書き込みを行います
	Write(out io.Writer) error
}

Ki はディレクトリツリー全体を扱うインタフェースです

type ModuleOption

type ModuleOption struct {
	// IgnoreTest がtrueの場合、_test.goで終わるテストファイルを無視します
	// デフォルトはテストファイルを含みます
	IgnoreTest bool
}

ModuleOption はモジュールから使うためのオプションです

type Option

type Option struct {
	// AllFile がtrueの場合、隠しファイルを含めたツリーを作成します
	// デフォルトは隠しファイル（ファイルまたはディレクトリ名が . から始まる）を除くツリーを作成します
	AllFile bool

	// DirectoryOnly がtrueの場合、ディレクトリのみでツリーを作成します
	// デフォルトはファイルも含めたツリーを作成します
	DirectoryOnly bool

	// ShowFullPath がtrueの場合外部出力時のファイル名にファイルのフルパスを付与して出力します
	// デフォルトはファイル名のみを出力します
	ShowFullPath bool

	// ModuleOption はモジュールから使うためのオプションです
	ModuleOption ModuleOption
}

Option はディレクトリツリー生成用のオプションを表します

func DefaultOption

func DefaultOption() Option

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