Automate templating of package name

pulumi / pulumi-component-provider-go-boilerplate

Apache License 2.0

15 stars 3 forks source link

Automate templating of package name #8

Open jkodroff opened 2 years ago

jkodroff commented 2 years ago

There's numerous places where we ask the user to replace xyz with the name of the module. It would be nicer if we could automate this for the user via a Makefile target or similar mechanism.

Here's what I'm thinking for a solution:

For source files, use a templating tool (propose Gomplate, and rename the affected source files filename.ext.tmpl.
For directories, rename using shell commands.
Execute all changes via make init.

If we like this, I'm happy to submit a PR.

lukehoban commented 2 years ago

FWIW - there is a make prepare target in the bridge boilerplate - which serves largely this same purpose. Ideally we keep all our boilerplate repos aligned on things like this (either by porting that to the other repos, or by designing something new and ensuring it is pushed to all boilerplate repos).

jkodroff commented 2 years ago

@lukehoban Yes, that would be the end state - that all boilerplate repos have templating and use the same tooling. The TF provider boilerplate uses sed, but I think a more modern template engine would be more maintainable.