fs

README

FS: File Snippet

FS is the file snippet CLI. FS copies the file interactively according to a custom-defined TOML file.

Install

Download from GitHub Releases.

go get github.com/skmatz/fs/...

Usage

After the installation, prepare a TOML file like the following in ~/.config/fs/fs.toml.

[config]
head_size = 10
item_size = 10

[[snippet]]
id = "gitignore-go"
name = ".gitignore"
content = """
bin/
"""

[[snippet]]
id = "gitignore-py"
name = ".gitignore"
file = "~/sandbox/python/.gitignore"

[[snippet]]
id = "license-mit"
name = "LICENSE"
url = "https://raw.githubusercontent.com/skmatz/fs/master/LICENSE"

Documentation

Index

• type Config
• type FS
  • func New(path string) (*FS, error)
  • func (f *FS) ToBytes() ([]byte, error)
• type Mode
• type Snippet
  • func (s *Snippet) FillAllFields() error
  • func (s *Snippet) GetMode() (string, error)
  • func (s *Snippet) ToClipboard() error
  • func (s *Snippet) ToFile() error
• type Snippets
  • func (s Snippets) Select() (*Snippet, error)

Types

type Config

type Config struct {
	HeadSize int `toml:"head_size"`
	ItemSize int `toml:"item_size"`
}

Config represents the configuration of the application.

type FS

type FS struct {
	Config   Config   `toml:"config"`
	Snippets Snippets `toml:"snippet"`
}

FS represents a FS client.

func New

func New(path string) (*FS, error)

New returns a new FS client.

func (*FS) ToBytes

func (f *FS) ToBytes() ([]byte, error)

ToBytes converts itself to bytes.

type Mode

type Mode = string

Mode is the snippet mode.

const (
	ModeContent Mode = "content"
	ModeFile    Mode = "file"
	ModeURL     Mode = "url"
)

type Snippet

type Snippet struct {
	ID      string `toml:"id"`
	Name    string `toml:"name"`
	Content string `toml:"content,omitempty"`
	File    string `toml:"file,omitempty"`
	URL     string `toml:"url,omitempty"`
}

Snippet represents a snippet.

func (*Snippet) FillAllFields

func (s *Snippet) FillAllFields() error

FillAllFields fills the all fields according to the text template.

func (*Snippet) GetMode

func (s *Snippet) GetMode() (string, error)

GetMode returns the snippet mode.

func (*Snippet) ToClipboard

func (s *Snippet) ToClipboard() error

ToClipboard writes its content to the clipboard.

func (*Snippet) ToFile

func (s *Snippet) ToFile() error

ToFile writes its content to a file.

type Snippets

type Snippets []Snippet

Snippets is a list of snippets.

func (Snippets) Select

func (s Snippets) Select() (*Snippet, error)

Select selects a snippet.