Skip to content

Latest commit

 

History

History
127 lines (101 loc) · 5.17 KB

README.md

File metadata and controls

127 lines (101 loc) · 5.17 KB
Raw

FOSSA Status Known Vulnerabilities

velociwraptor

A project templating library based on the ideas in https://github.com/tmrts/boilr

Template engine used is [JMTE][https://github.com/DJCordhose/jmte]

Getting Started

Let's start with a simple "hello world" example.

We will use velociwraptor with the worlds most simplistic template. This template only contains one file hello.txt.

C:\velociwraptor-example>velociwraptor -g duckAsteroid/hello-world/master

We asked velociwraptor to use a template in a GitHub repository duckAsteroid/hello-world/master this is shorthand for the master branch of the https://github.com/duckAsteroid/hello-world repository.

Velociwraptor is in interactive mode, it prompts us to confirm the greeting we would like to see "templated" into hello.txt...

Velociwraptor v0.0.1
[?] Please choose an option for "Greeting" [default: Hello world!]:

The default looks fine, so we hit <ENTER>. The template runs and we now have a new hello.txt file.

Let's look at the structure of that github repo:

  • template/hello.txt - this folder template contains the files that are copied as part of our template.
  • default.json - this JSON file contains the default values for variables to use in the template (not copied into template output).
  • Readme.md - this is a readme file for GitHub (not copied into template output)
  • LICENSE - this is a licence for the template (not copied into template output)

Looking inside template/hello.txt we can see:

${Greeting}

If you can read this - velociwraptor is working!

The first line refers to a template variable Greeting. Velociwraptor prompted us for the value we would like to use and default.json contains a default to use (should we choose not to supply a value):

{
  "Greeting": "Hello world!"
}

So let's look inside our template output and see what's inside it...

C:\velociwraptor-example>more hello.txt
Hello world!

If you can read this - velociwraptor is working!

C:\velociwraptor-example>

As you can see our greeting was placed on the first line.

This is a very simple example. We could create many directories and files and use many more template variables.

Next Steps

Read about how templates behave or the JMTE syntax used to define them.

Usage

Velociwraptor v0.0.1
usage: Main [-q] [-r <URI>] [-i <PATH>] [-c] [-x] -d <DIR> | -z <URI> | -m
       <MVN> | -g <REPO>    [-o <OUT>] [-p] [-e] [-j <JSON>]
 -q,--quiet             Disable interactive mode
 -r,--repo <URI>        URI to maven or github repo when using those
                        template sources
 -i,--zip-root <PATH>   path to template root inside ZIP/JAR
 -c,--retain            Retain any cached downloads of ZIP/JAR files
 -x,--no-color          No color in console
 -d,--dir <DIR>         Use a local directory <DIR> as template
 -z,--zip <URI>         Use a ZIP file (local file/public web URI) as a
                        template
 -m,--mvn <MVN>         Use a maven artefact (JAR) as a template. Use
                        maven ':' separated coordinate syntax - see [1],
                        [2].
 -g,--github <REPO>     Use a GitHub repo as the template. Repository is
                        defined as {user}/{repo}/{branch} (branch
                        optional). See [1]
 -o,--output <OUT>      Target directory for template output
 -p,--properties        Use system properties to resolve template
                        variables
 -e,--env               Use system ENVIRONMENT to resolve template
                        variables
 -j,--json <JSON>       Use JSON file(s) to resolve template variables. If
                        a list, filenames are separated by ';'.Relative
                        paths are resolved based on current working dir
[1] - Non standard repository URI may be specified with the --repo option.
[2] - https://maven.apache.org/pom.html#Maven_Coordinates

Template Sources

Velociwraptor will use templates from many sources including:

  • A template directory in the local file system
  • A template ZIP (including .jar etc.) in the local file system
  • A template ZIP (including .jar etc.) on some public URI
  • A maven repository co-ordinate (it will fetch the JAR and use it as the template)
  • A github repository (it will grab a snapshot ZIP from github.com)

Download

You can grab an executable installer from the releases link above.

License

FOSSA Status