github.com/jcalmat/bob

Bob - The Boilerplate Builder

Bob is a CLI tool used to generate boilerplate code from templates made beforehand.

Setup

Binary

Download the latest release, unzip and put the binary somewhere on your PATH.

Building

Requirements

• golang 1.13.x or later

$> go get github.com/jcalmat/bob
$> bob init

OR

$> git clone git@github.com:jcalmat/bob.git
$> make install
$> bob init

Configuration

Bob settings should be stored in your home directory in a .bobconfig.yml file and contain the following fields

# Register your commands here
commands:
  microservice:
    alias: "microservice"   #alias is the key provided to bob to match this command
    templates:
      - my_microservice     #templates is an array containing one or multiple templates used during this command
 
  
templates:
  my_microservice:
    #you can either provide a git link to be cloned or a template already in your local environment
    #git: "github.com/USERNAME/templates/microservice.git"
    path: "/path/to/your/template"
    variables:  #variables are the variables to replace in your template
      - "service"
    skip: # files or folders to ignore, usefull when cloning a git project for example
      - ".git"
    

Templates

Templates are prebuilt formatted pieces of code

Variables format

Bob uses go templates to parse and replace the variables, thus these variables must be formatted with double brackets {{VARIABLE}}.

For more information about the format, here is a cheat sheet.

Custom functions

To ease your development and avoid variables duplication, bob has custom formatting methods:

• short will truncate the x first characters of your variable
• upcase will capitalize your variable
• title will return a copy of the string s with all Unicode letters that begin words mapped to their Unicode title case

Note: you can also pile the functions up

Conditional templates

To be more flexible, you can add conditions to your template to ask the user if he wants to add a particular piece of code.

{{if .print_hello}}
fmt.Println("Hello world")
{{end}}

This print method will be in final code only if the variable print_hello is defined.

print_hello can be a boolean or a string. If the string is empty, the block won’t be included.

yaml example:

templates:
  microservice_pkg:
    git: ""
    variables:
      - name: "print_hello"
        type: "bool"
        desc: "Do you want to print the hello world? [y/n] " // desc will override the replacement question asked to the user

In depth examples

See here for more in-depth examples

Help

$> bob --help

 ______     ______     ______
/\  == \   /\  __ \   /\  == \
\ \  __<   \ \ \/\ \  \ \  __<
 \ \_____\  \ \_____\  \ \_____\
  \/_____/   \/_____/   \/_____/

Bob is a tool for creating flexible pieces of code from templates.

Usage:
  bob [command]

Available Commands:
  build       build a project from a specified template
  help        Help about any command
  init        initialize bob's config file

Flags:
      --config string   config file (default is $HOME/.bobconfig)
  -h, --help            help for bob

Use "bob [command] --help" for more information about a command.