goconstruct

Go project construction from opinionated templates.

Overview

goconstruct provides a way to construct Go projects from opinionated, templated, components.

My goal with this project, specifically with the templates is to "document" the opinions that I have in the form of templates that can be shared and used by others or minimally, referenced in code reviews. While these opinions are my own, they have absolutely been influenced by the work of others.

Installing

(
  d=$(mktemp -d) cd $d
  go get -u -v github.com/mccurdyc/goconstruct
)

Usage

% goconstruct project -h
USAGE
  project <subcommand>

SUBCOMMANDS
  generate  Generates a new project.

FLAGS
  -config config.toml       A config file defining values for the required variables for all templates used.
  -destination .            The destination directory where the project should be created.
  -templates glue           A comma-separate list of template names.
  -templates-path ./_tmpls  Path to templates.

Contributing

• Check out the CONTRIBUTING document.

License

• GNU General Public License Version 3

TODOs

1. Handle goconstruct with missing subcommands.
2. GitHub Action for CI (build and test).
3. Simplify each template so that they are more composable and align with the Unix philosophy of doing one thing.
4. Backport changes to goconstruct to the template files.
5. Render templated filenames.
6. Configurable template delimeters.
7. Move templates to a separate GitHub repository.
8. Generate README usage section via Make target or something.