weso

package module

v0.0.1 Latest Latest Go to latest Published: Jan 10, 2016 License: MIT Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/morikuni/weso

Links

Open Source Insights

README ¶

weso

CLI for Websocket.

install

go get github.com/morikuni/weso/cmd/weso

Usage

$ cat template.txt
{{define "Name"}}{"name": "{{._1}}"}{{end}}

{{define "Decorate"}}{{._1}}{{._2}}{{._1}}{{end}}

{{define "Twice"}}{{._1}}{{._1}}{{end}}

$ weso -template template.txt ws://echo.websocket.org
> hello
<< hello
> .Name Jack
<< {"name": "Jack"}
> .Decorate *** "I'm Jack"
<< ***I'm Jack***
> .Twice Hello
<< HelloHello

Start line with dot . to use template.

Template

Template file is written in Go's standard template library.

Arguments for template are expanded to ._1, ._2 ... ._N.

License

MIT

Credit

weso uses

Liner for line editor.

Documentation ¶

Index ¶

Variables
func Completer(t *Template) liner.Completer
func Parse(s string) []string
type CLI
- func NewCLI(conf *Config) (*CLI, error)
type Config
- func NewConfig(args []string, errOut io.Writer) (*Config, bool)
type Template
- func NewTemplateFile(path string) (*Template, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var EmptyTemplate = &Template{
	make(map[string]*template.Template),
}

EmptyTemplate is empty Template.

View Source

var QuitRequest = errors.New("quit request")

QuitRequest is used when websocket should be closed.

Functions ¶

func Completer ¶

func Completer(t *Template) liner.Completer

Completer create liner.Completer from Template.

func Parse ¶

func Parse(s string) []string

Parse parse string to template name and args.

Types ¶

type CLI ¶

type CLI struct {
	// contains filtered or unexported fields
}

CLI is interface for websocket.

func NewCLI ¶

func NewCLI(conf *Config) (*CLI, error)

NewCLI create CLI from Config.

func (*CLI) Close ¶

func (c *CLI) Close()

Close close connection.

func (*CLI) Receive ¶

func (c *CLI) Receive() error

Receive receive messages and print them.

func (*CLI) Run ¶

func (c *CLI) Run() error

Run start receive and send loop.

func (*CLI) Send ¶

func (c *CLI) Send() error

Send read command from Stdin and send message.

type Config ¶

type Config struct {
	URL      string
	Origin   string
	Template string
	Debug    bool
}

Config is configuration file for CLI.

func NewConfig ¶

func NewConfig(args []string, errOut io.Writer) (*Config, bool)

NewConfig create Config and output error to `errOut`.

type Template ¶

type Template struct {
	// contains filtered or unexported fields
}

Template is used to expand template.

func NewTemplateFile ¶

func NewTemplateFile(path string) (*Template, error)

NewTemplateFile create Template from file.

func (*Template) Apply ¶

func (t *Template) Apply(name string, args ...string) ([]byte, error)

Apply apply `args` to template for `name`.

func (*Template) IsDefined ¶

func (t *Template) IsDefined(name string) bool

IsDefined check if Template for `name` exists.

func (*Template) Names ¶

func (t *Template) Names() []string

Names return template names.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd
weso

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL