fs

README

FS: File Snippet

FS is the file snippet CLI.

Install

Binary

Download from GitHub Releases.

Source

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

Usage

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

[config]
head_size = 10
item_size = 10

[[snippet]]
id = "makefile-go"
name = "Makefile"
content = """
.PHONY: build
build:
	go build -o bin/{{ .Command }} cmd/{{ .Command }}/main.go

.PHONY: format
format:
	goimports -w .

.PHONY: test
test:
	go test -v ./...
"""

[[snippet]]
id = "makefile-go"
name = "Makefile"
path = "~/src/github.com/skmatz/fs/misc/Makefile"

[[snippet]]
id = "makefile-go"
name = "Makefile"
url = "https://raw.githubusercontent.com/skmatz/fs/master/misc/Makefile"

Documentation

Index

• type Config
• type FS
  • func New(path string) (*FS, error)
• type Snippet
  • func (s *Snippet) FillAllFields() 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    `default:"10" toml:"head_size"`
	ItemSize int    `default:"10" toml:"item_size"`
	Theme    string `default:"dracula" toml:"theme"`
}

Config represents a 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 FS client.

type Snippet

type Snippet struct {
	ID      string `toml:"id"`
	Name    string `toml:"name"`
	Content string `toml:"content"`
	Path    string `toml:"path"`
	URL     string `toml:"url"`

	ColoredContent string
}

Snippet represents a snippet.

func (*Snippet) FillAllFields

func (s *Snippet) FillAllFields() error

FillAllFields fills the all fields according to the text template.

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.