pokstad / gomate

Gomate is a set of TextMate CLI tools for working with Go code

Gomate

Gomate is a set of TextMate CLI tools for working with Go code. Inspired by syscrusher/golang.tmbundle.

Gomate embraces the Unix philosophy adopted by Textmate by utilizing simple CLI tool constructs, such as:

• Command line arguments to indicate desired action
• Sourcing environment variable for context of operation
• Reading input from STDIN and producing desired output on STDOUT

Additionally, Gomate is comprised of many smaller packages with dedicated functions to allow for maximum reuse outside the scope of Textmate. For example, you may want to use the note parsing package and build your own extension to a different tool (e.g. VSCode or VIM).

The modular design also encouraged the development of some dedicated CLI tools:

• notes - provided a path, will scan recursively and return all godoc notes in all packages
  • Installation: go get github.com/pokstad/gomate/notes/notes
  • Usage: $GOPATH/bin/notes [OPTIONS] PACKAGE_PATH

Install

To get the gomate CLI:

go get -u github.com/pokstad/gomate

Then, install the tool's dependencies:

$GOPATH/bin/gomate install

Usage

Until the bundle install is automated, the following needs to be done manually for each bundle command script:

References

To find references to the symbol under the cursor:

#!/bin/bash
gomate references

• Output: is set to Show in New Window
  • Format: is HTML

External dependencies: guru

Outline

To generate an outline of the current source code file:

#!/bin/bash
gomate outline

• Input: is set to Selection
  • Format is set to Text
• Output: is set to Show in New Window
  • Format: is HTML

Get Documentation

To view HTML documentation of the symbol under the cursor:

#!/bin/bash
gomate getdoc

• Input: is set to Document
  • Format is set to Text
• Output: is set to Show in New Window
  • Format: is HTML

External dependencies: gogetdoc

Notes

To view a list of gonotes in the current project:

#!/bin/bash
gomate notes

• Input: Nothing
• Ouput: Show in New Window
  • Format: HTML

Rename

To rename an identifier:

#!/bin/bash
gomate rename

• Input: Nothing
• Output: Discard

External dependencies: gorename

Roadmap

• Testing coverage and advanced options for individual test functions (similar to VSCode code lense)
• Reimplement all features of existing Textmate plugin syscrusher/golang.tmbundle
• Web service to support rich contexts that allow interactions via AJAX calls

gomate's Issues

Go font based theme

Bundle a version of Go using the official Go font and using the color scheme from playgrounds: https://blog.golang.org/go-fonts

General purpose wrapper

Many of the gomate tools provide very similar functionality:

1. Run an external command
2. Collect output (stderr and stdout)
3. Parse output for code location references (e.g. location of compile error) in order to create textmate link.
4. Generate HTML output for display in Textmate panel.

This general pattern could be adapted into a simple CLI tool that parses command output from stdout and stderr. This would speed up the development of future gomate tools by generalizing the pattern. Some additional requirements:

1. Stderr should be displayed in separate HTML element to prevent interfering with stdout.
2. Go conventions should be identified for proper parsing
   1. e.g. Go path convention ("fmt".Printf) or line references ("./code.go:14:13")

Wrapper could be used for gogetdoc, golint, go install, gometalinter, etc.

Feature: gopls integration

Integrate the new experimental gopls tool which provides an LSP client and server for interacting with Go code.

System font dark theme

Bundle both a light and dark version of the universal theme:

https://github.com/textmate/themes.tmbundle/blob/master/Themes/macOS%20System%20Theme.tmTheme

HTML renderers need unit tests

Tests are needed to validate the HTML rendering functions work. Additionally, a method to easily update golden files should be implemented.