gomacro-mode

This Emacs package provides bindings for working with Gomacro, a read eval print loop for Go. Gomacro installation instuctions can be found in the gomacro repo. Thanks to the gomacro author!

Table of Contents

• gomacro-mode
• Todo
• Issues
• Installation
• Usage
  • Interactive functions
    • gomacro-run
    • gomacro-verbose-toggle
    • gomacro-eval (stmt)
    • gomacro-eval-region (begin end)
    • gomacro-eval-line
    • gomacro-eval-defun
    • gomacro-eval-buffer
    • gomacro-eval-file
    • gomacro-eval-package
  • Other useful functions
    • gomacro-running-p

Todo

• [ ] Look into using go--build-font-lock-keywordsto to syntax highlightning in gomacro buffer
• [x] Add gomacro-eval-file which prompts for file to eval
• [x] Add gomacro-eval-pacakge which evaluates all files in specified folder
• [x] Combine eval region and eval region verbose to one function with config param
• [x] Add gomacro-eval-buffer
• [x] Add gomacro-eval-line
• [x] Add support for type definitions in eval defun (struct and interface)
• [x] Remove all comments in gomacro--sanitize-string
• [x] Ensure only one whitespace in gomacro--sanitize-string
• [x] Add some tests
• [x] Handle package declarations

Issues

Does not handle multiple packages as all files are evaluated without package header.

Installation

Installation can be done using use-package:

(use-package gomacro-mode
  :hook (go-mode . gomacro-mode))

Usage

By enabling gomacro-mode in buffer with Go source code the following keybindings will be set:

Interactive functions

The following functions are ment to be used from the M-x interface.

gomacro-run

Run an inferior instance of gomacro inside Emacs comint-mode buffer

gomacro-verbose-toggle

Toggle value of gomacro-verbose-toggle. When verbose mode is activated everything is sent to gomacro line by line, default behaviour is to only display "Region is sent to gomacro REPL".

gomacro-eval (stmt)

Evaluate stmt in gomacro REPL buffer. Will prompt for statement if run interactively.

gomacro-eval-region (begin end)

Evaluate region between begin and end. Can be run interactively with marked region. If gomacro-verbose-eval is set region will be sent line by line to gomacro REPL.

gomacro-eval-line

Evaluate current line.

gomacro-eval-defun

Evaluate the nearest function, type or import statement looking backwards. This function will select whichever function, type or import statement that is nearest to current cursor position and pass it to gomacro REPL.

gomacro-eval-buffer

Evaluate entire buffer.

Does not evaluate package statement, hence all buffers sent to gomacro REPL will be in the same namespace.

gomacro-eval-file

Evaluate file, will prompt for file if run interactively.

gomacro-eval-package

Evaluate go package, will prompt for path if run interactively. If filename is specified all other go files in same directory will be processed.

Other useful functions

These functions are not ment to run interactively.

gomacro-running-p

Check if gomacro REPL is running or not.