README.md

geniveev

An easy to use, language-agnostic code generation tool, powered by Go templates and an intuitive CLI.

Why?

For better or worse, I find myself working with protobufs. To create a service, I need to create a number of files in different directories, each containing a bit of boilerplate. While it's not hard to figure out the path names and copy/pasta the boilerplate, this tool was written to automate that chore.

This tool is not protobuf specific, that's just my initial use-case.

Configuration

To configure geniveev, you must construct a toml .geniveev configuration file in your current working directory at the root of your project.

geniveev configuration file

This is an example configuration file included in the example/ directory.

The geniveev configuration file contains command definitions and any number of templates associated with these definitions. The templates are associated with a filename that is itself a template, allowing the filename and its contents to be specified per-run via the command line.

In the following configuration, we have defined the service-stubs command which consists of two templates. When geniveev is run, it generates a service-stubs command (and any others you add to the configuration file) and adds the service_name as a required parameter for that command. Any template value found in the filename can be reused in the template itself.

Note that it is common to want to manipulate the filename in the file-content template itself, so some builtins are provided, as shown below.

The following configuration file will generate two files for a protobuf setup. To run geniveev using this configuration file, clone this repo and run make && cd examples && ../build/geniveev service-stubs --service-name User.

[service-stubs]

[service-stubs."protos/{{.service_name}}/v1/{{.service_name}}/{{.service_name}}.proto"]
    code = '''
syntax = "proto3";

package {{.service_name}}.v1;

import "validate/validate.proto";

// note that Title is a geniveev builtin that we use to capitalize the Name of the service, i.e.,
// UserService
service {{ .service_name | Title }}Service {
}
'''
[service-stubs.'services/v1/{{.service_name}}/{{.service_name}}.go']
    code = '''
package {{.service_name}}v1

import (
	"context"
	"fmt"
	"net/http"

	"github.com/bufbuild/connect-go"

	"github.com/bommie/b6/config"
	"github.com/bommie/b6/db"
)

type {{.service_name | Title}}Service struct {
	db  *db.DB
	cfg *config.AuthConfig
}

var _ {{.service_name}}v1connect.{{.service_name | Title}}ServiceClient = (*{{.service_name | Title }}Service)(nil)

func NewService(_ context.Context, db *db.DB, cfg *config.AuthConfig) *{{.service_name | Title }}Service {
    return &{{.service_name | Title}}Service{
		db:  db,
		cfg: cfg,
	}
}
'''

After running ../build/geniveev service-stubs --service-name user run git status and verify that the following files exist and look as you expect.

• protos/user/v1/user.proto was created
• services/v1/user/user.go was created

Builtin template functions

• Title
• SnakeToCamelCase