toolskel

README

Tool Skeleton Generator

Generates boilerplate for small tools written in Go.

Expected userbase size: 1

Example output can be found in internal/gencode/tests.

Tool Types

The currently-available tool types are

Type	Description
library	Just headers, for a library
parallel	Parallel task executor
simple	A no-frills tool

Usage

Usage: toolskel [options] [toolname [tool description...]]

Generates boilerplate for a tool written in Go.

Options:
  -author name
    	Author's name (default "Stuart McMurray")
  -list-types
    	List available tool types
  -no-date
    	Do not set the Created/Modified date
  -summary-count
    	Generated code's summary prints a completed task count
  -tag-log
    	Tag log output with argv[0]
  -type type
    	Tool type (see -list-types) (default "simple")
  -verbose-flag
    	Add a -verbose flag

Quickstart

go install github.com/magisterquis/toolskel@latest
toolskel -h
toolskel -author 'Darth Vader' findrebels Finds rebel scum > tool.go
vi ./tool.go

Building and Testing

In most cases, go install should be sufficient. The Makefile is only intended for use during development and assumes that goimports and Staticcheck are available.

Adding Templates

Adding a new tool type takes the form of a template which overrides blocks in the base template.

1. Add a template to internal/gencode/templates which should replace blocks in internal/gencode/base.tmpl. Make sure to update the description block.
2. Add a testcase or three to TestCases in internal/gencode/toolskel_test.go.
3. Generate a test copy of the output with something like

   go run . -author '' -no-date -type $NEWTYPE > internal/gencode/tests/newtype.go
   

   The name should be the same as Testcases[yours].name, with slashes replaced with underscores.
4. Run the tests with

   make tests
   

Documentation

Overview

Program toolskel generates boilerplate for small tools written in Go.