Boilerplate

This tool uses a templated file system to help generate templated projects. Each of the folders in this directory contain a layout for a specific type of project to generate. Each folder name starts with an underscore (_) to prevent go tools from treating them as actual golang project files.

Within a given project, all items are templatized; folders and files.

Installation

You can install by cloning the repo and running go build, or by running go install github.com/nikogura/boilerplate@latest.

Usage

Once installed, run boilerplate without arguments to access the help message.

The main usage is accomplished by running boilerplate gen, and answering the questions.

$ boilerplate gen
Creating new project of type "cobra"
Enter a name for your new tool.:
  value: example
Enter a golang semver. [default: 1.20]:
  value: 
Enter the go package name for your new tool.:
  value: github.com/nikogura/example
Enter a short project description. [default: boilerplate autogen project]:
  value: blah blah blah
Enter a long project description. [default: boilerplate autogen project]:
  value: longer blah blah
Enter your DBT Repository URL.:
  value: http://some-repo.s3.us-east-2.amazonaws.com
Enter a semantic version. [default: 0.1.0]:
  value: 
Enter the project maintainer name.:
  value: Nik Ogura
Enter the project maintainer email address.:
  value: myemail@foo.com
New project created in ./example

This creates the following in $pwd):

$ ls -R
.:
cmd	go.sum	 main.go	pkg		    README.md
go.mod	LICENSE  metadata.json	pre-commit-hook.sh  templates

./cmd:
root.go

./pkg:
example

./pkg/example:
example.go

./templates:
description.tmpl

You can test it by running: cd example && go build.

You can test it via gomason by running: cd example && gomason build -vsl. Of course, if you're running on Linux like I do, you'll need to have a macOS cross compilation env available. How to do that is beyond this README. Check out the wonderful osxcross for help with that.

Project Types

Cobra

This project is used to generate tools using the cobra command line framework.

Adding a new Project

Make a project folder

First step is to creat a new "projects" folder in the project_templates directory. Under this created directory you can create any number of templated file structures that will become the basic of your new destination project.

For example, under a project you might create both a templated service and web GUI application which require separate templating schemes.

NB: Your directory name needs to start with an underscore ("_"). This will ensure the golang tools ignore it. If you don't follow this rule, things like go mod will throw errors on the template syntax.

NB: Only single folder projects have been attempted at the time of this writing.

Add project to projects.go

Create a go:embed FS to hold your project structure

go:embed project_templates/_cobraProject/*
var myNewProject embed.FS

Add the project to each function in this file.

Add new prompt types

If adding new template variables, they should be added to the prompt.go file. This includes the prompt questions as well as any validations to perform on a given answer.

Make params structure

Create a struct that holds all of the variables your application requires to run

type DockerParams struct {
   	DockerRegistry    string
   	DockerProject     string
   	ProjectName       string
    ...

Done

After this build the binary via go build, and your new project will be available for generation at the top level of the application

Use with Gomason

The Boilerplate tool was designed for use with https://github.com/nikogura/gomason tool. You certainly don't have to use gomason, but the example cobra project included here was intended to be used that way.

You can build the project simply by running go build or go install, but if you're going to build, test, sign, and upload, you might want to run gomason publish -vsl instead. (publish verbose, skip tests, operate off of what's here on the local disk in this directory).

Gomason's other options and features can be investigated at [https://github.com/nikogura/gomason](the gomason project page).