• Stars
    star
    83
  • Rank 392,854 (Top 8 %)
  • Language
    Emacs Lisp
  • License
    GNU General Publi...
  • Created about 9 years ago
  • Updated 8 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

GNU/Emacs mode that setup local Go playground for code snippets like play.golang.org or even better :)

Local Golang playground MELPA Stable MELPA

The simple mode for GNU/Emacs for setting up local Go language playground with features similar (and with help of go-mode even outperform!) service at play.golang.org. You may treat it like the simple REPL for Go. This is not a wrapper for working with play.golang.org from Emacs (it is already did by original go-mode), this is complete alternative for setting local playground inside Emacs without using browser for experiments with code snippets.

Web playground at play.golang.org is a nice idea. It has not require setup and it executes your code in a restricted environment where you can't damage you system. But it brings many restrictions too especially when you want use additional helpers for working with your code: formatters, code completers etc. Emacs offers many such tools for Go development so it is the most comfortable play with snippets inside Emacs instead of rude webeditor. Of course local playground requres you to setup Go environment but if you developing in Go (or you want to do it) you are anyway would need to setup go-mode and helper tools for working with code in a comfortable way.

Features

  • uses go-mode with all your plugins (like lsp, linters and so on)
  • allow to import external packages
  • keeps the library of snippets under a customized root path
  • support multiple source filcces (or subpackages) for a snippet
  • compatible with Go modules

Install

First install go-mode and gotest β€” these are mandatory. Setup any additional tools you want for Golang (see Emacs Wiki for guides or google for "emacs+golang"). Minimal way is install goimports that automatically add import clauses to your snippets. For a fully functional Go IDE look at lsp and supplementary packages.

Install go-playground from MELPA:

M-x package-install RET go-playground

Or:

(use-package go-playground)

If you want to share snippets use go-play-buffer from go-mode. Install gist-buffer from MELPA if you want publish gists on github.com.

Usage

Quick start

  1. From any mode run M-x go-playground for start a new playground buffer filled with basic template for main package (see the picture below).
  2. Add your code then press Ctl-Return (it bound to go-playground-exec command). It will save, compile and exec the snippet code.
  3. When you played enough with this snippet just run M-x go-playground-rm. It will remove the current snippet with its directory and all files.

Mode not offers default bindings except Ctl-Return. It just lefts the space for you.

For easy running the template declares main package with defined main() function. Each snippet saved to its own directory (named by timestamp by default). Remember go-playground runs the compiler as go run *.go so any sources from the snippet directory will be included.

List of interactive functions

Function name Description
go-playground Create a new playground buffer with basic template for the main package.
go-playground-download Download the snippet from the URL at play.golang.org.
go-playground-exec Save, compile and run the code of the snippet.
go-playground-cmd Save the code then prompts for the command (compile-mode used).
go-playground-upload Upload the buffer to play.golang.org and return the short URL.
go-playground-rm Remove the snippet with its directory with all files.

List of customizable variables

Function name Description
go-playground-ask-filename Ask for the snippet filename on a new playground creation. By default it got name snippet.go.
go-playground-basedir Default directory where snippets dirs will placed. Each new snippet got a new dir under this. It has sense place the default directory under GOPATH. Var introduced in the release 1.1.
go-playground-confirm-deletion Ask for confirmation before snippet deletion. It may be annoying so you can switch confirmations off. Var introduced in the release 1.2.
go-playground-compile-command Run compiler with custom args or run any other additional commands. By default it runs two command in sequence "go mod tidy; go mod run ./..."
go-playground-init-command Setup shell command that will be run once when a new snippet just created.
go-playground-compiler-args That arguments should be passed for the compiler.
go-playground-pre-rm-hook Hook that should be run before a snippet is removed.

Example screen after creation of a new snippet:

screenshot

Using with lsp-mode

If you use lsp-mode, you can add a hook in your init file to cleanup the workspace when a snippet is removed, for example:

	(defun my/go-playground-remove-lsp-workspace () (when-let ((root (lsp-workspace-root))) (lsp-workspace-folders-remove root)))
	(add-hook 'go-playground-pre-rm-hook #'my/go-playground-remove-lsp-workspace)

Snippet with multiple files and subpackages

Explained here #19.

Similar projects

  • Try go-scratch it even simplier than go-playground. But it prevents you from using many of tools because it not keeps code in files.
  • gorepl-mode is REPL for Go, helpful for interactive research of code.

Licence

Under terms of GPL v3. See LICENSE file.

Future plans and accepting contributions

I don't want to make this package much complex. Most of go-playground functions depends on other packages around go-mode. And it is good way. But one thing I want to add is snippet list buffer where you can easily find and edit/delete snippets of your library. Bugfixes and small features accepted as well.

More Repositories

1

m3u8

Parser and generator of M3U8-playlists for Apple HLS. Library for Go language. 🎦
Go
1,225
star
2

hulk

HULK DoS tool ported to Go with some additional features.
Go
769
star
3

plantuml2mysql

This utility parses PlantUML class diagram and generates SQL DDL for MySQL
Python
115
star
4

bcast

Broadcasting library for Go. Broadcast message of any type on a set of channels. WIP
Go
98
star
5

streamsurfer

Software for monitoring of HTTP video streams.
Go
82
star
6

rust-playground

GNU/Emacs mode that setup local playground for code snippets in Rust language.
Emacs Lisp
45
star
7

hlsprobe

Utility to probe Apple HLS streams.
Python
39
star
8

kiwi

Fast, structured, with filters and dynamic sinks. No levels. Logger & context keeper for Go language πŸ₯ It smells like a mushroom.
Go
24
star
9

shift-shift

Xorg/Wayland keyboard layout switcher.
Go
15
star
10

russian-holidays

Russian holidays for GNU/Emacs calendar πŸ“†
Emacs Lisp
14
star
11

websocket-utils

Simple utils for testing websocket connections.
Go
5
star
12

reddit-clone-example

Example of realization of Reddit-like API with Go language.
Go
5
star
13

mpegts

Mpegts stream decoder
Go
3
star
14

gorg

Org-mode parser and generator for Golang
3
star
15

quickpic-cloud-linux-downloader

Download photos from the cloud that offered by Quickpic
Go
2
star
16

broadcast

The experiment
Go
2
star
17

pin-buffer

πŸ“Pins buffer to current window in GNU/Emacs
Emacs Lisp
2
star
18

wtfm

Where's The Fucking Manual? (ok, let Write the Fabulous Manual)
Go
2
star
19

mysql-backup

Simple tool for backuping MySQL databases.
2
star
20

rule-mode

Emacs support for rule-based comments in code.
Emacs Lisp
2
star
21

slack-anything

Slack Anything offers additional ways for using Slack Chat
Go
2
star
22

keyboard

Alternative keyboard layouts. Colemacs layout for emacsers on unix.
PHP
2
star
23

go-loggers-comparison

Benchmarks of loggers for Go language.
Go
2
star
24

service

The service tree 🌳 library for Go
Go
2
star
25

aeis

Ordering chaos in ~/.emacs.d.
Emacs Lisp
2
star
26

tw

Text Widgets library.
1
star
27

viewga

Experiments with desktop UI
1
star
28

quicksand

Quicksand β€” website stress testing & DOS tool. Hulk' successor.
1
star
29

whereami

Where am I? β€” executes actions based on your geographic place
1
star
30

webhotkey

URL shortener + HTTP proxy + DNS cache: swiss knife for webdeveloper.
1
star
31

apply

Apply the command to the project directories.
1
star
32

dotemacs

My emacs config.
Emacs Lisp
1
star
33

ergodox_configurator

JavaScript
1
star
34

portage-utils

Misc utils for Gentoo portage.
Python
1
star
35

perkeep-docker

Docker build for perkeep (calimstore).
Dockerfile
1
star
36

image-resize-service

The example of image resizing HTTP-service in Go
Go
1
star
37

randfs

Go library for generating random files/filenames/directories. For testing applications that needs work with massive number of files.
Go
1
star