README

goplay - The Go Playground (https://play.golang.org/) client

Travis Build Status Appveyor Build status Go Report Card Coverage Status Releases LICENSE GoDoc

gif

Install

as a Library

go get -u github.com/haya14busa/goplay

as a command line tool

go get -u github.com/haya14busa/goplay/cmd/goplay

Command Line Tool

SYNOPSIS: goplay [OPTION]... [FILE] (With no FILE, or when FILE is -, read standard input.

  -h    show help
  -openbrowser
        open browser automatically (default true)
  -run
        compile and run Go program on The Go Playground (default true)
  -share
        share code on The Go Playground (default true)

🐦 Author

haya14busa (https://github.com/haya14busa)

Expand ▾ Collapse ▴

Documentation

Overview

    Package goplay provides The Go Playground (https://play.golang.org/) client

    Index

    Examples

    Constants

    This section is empty.

    Variables

    View Source
    var DefaultClient = &Client{}

      DefaultClient is default Go Playground client.

      Functions

      This section is empty.

      Types

      type Client

      type Client struct {
      	// The base URL of The Go Playground. Default is `https://play.golang.org/`.
      	BaseURL string
      
      	// The HTTP client to use when sending requests. Defaults to
      	// `http.DefaultClient`.
      	HTTPClient *http.Client
      }

        Client represensts The Go Playground client.

        func (*Client) Compile

        func (c *Client) Compile(code io.Reader) (*Response, error)

          Compile compiles code on The Go Playground.

          Example
          Output:
          
          3...
          2...
          1...
          GO!
          

          func (*Client) Run

          func (c *Client) Run(code io.Reader, stdout io.Writer, stderr io.Writer) error

            Run runs code which compiled in The Go Playground.

            Example
            Output:
            
            Hello, 世界!
            

            func (*Client) Share

            func (c *Client) Share(code io.Reader) (string, error)

              Share creates go playground share link.

              Example
              Output:
              
              https://play.golang.org/p/OclbDkg7kv
              

              type Event

              type Event struct {
              	Message string
              	Kind    string        // "stdout" or "stderr"
              	Delay   time.Duration // time to wait before printing Message
              
              }

                Event represensts event of /compile result.

                type Response

                type Response struct {
                	Errors string
                	Events []*Event
                }

                  Response represensts response type of /compile.

                  Source Files

                  Directories

                  Path Synopsis
                  cmd
                  Package socket is client of `golang.org/x/tools/playground/socket`.
                  Package socket is client of `golang.org/x/tools/playground/socket`.