This is port of great tool giter8 for Node.js

• Node.js (version 12+)
• Git (the git command must be available in your terminal)

Clone this repository and copy files in bin folder wherever you like.

Set PATH environment variable for exeutables.

In windows, g8js.cmd is your launcher. For mac/linux g8js is the one.

$ g8js -h
g8js 0.0.4
Usage: g8js [options] <template>

  -h, --help               show this help message
  <template>               github user/repo
  -H, --host [hostname]    hostname for template repository (default: 'github.com')
  -o, --out [path]         output directory
  -D, --no-generate        never generate files (`git clone` will be executed anyway)
  -n, --no-cache           do not cache template
  -v, --verbose            verbose output
  -y, --yes                no prompt and use defaults ('-p' options are respected)
  -p, --props key1=value1,key2=value2...
                           additional key-value args (prior to defaults)

To generate template:

$ g8js scala/scala-seed.g8

To see what files are processed (without generating anything):

$ echo %cd%
C:\dev\scala
$ g8js scala/scala-seed.g8 --no-generate
name [Scala Seed Project]:
description [A minimal Scala project.]:
'--no-generate' flag found.

RENDER:
C:\Users\lettenj61\_g8js\github.com\scala-seed.g8\src\main\g8\build.sbt => C:\dev\scala\scala-seed-project\build.sbt
MKDIR: C:\dev\scala\scala-seed-project\project
MKDIR: C:\dev\scala\scala-seed-project\src
RENDER:
C:\Users\lettenj61\_g8js\github.com\scala-seed.g8\src\main\g8\project\build.properties => C:\dev\scala\scala-seed-project\project\build.properties
RENDER:
C:\Users\lettenj61\_g8js\github.com\scala-seed.g8\src\main\g8\project\Dependencies.scala => C:\dev\scala\scala-seed-project\project\Dependencies.scala
MKDIR: C:\dev\scala\scala-seed-project\src\main
MKDIR: C:\dev\scala\scala-seed-project\src\test
MKDIR: C:\dev\scala\scala-seed-project\src\main\scala
MKDIR: C:\dev\scala\scala-seed-project\src\test\scala
MKDIR: C:\dev\scala\scala-seed-project\src\main\scala\example
MKDIR: C:\dev\scala\scala-seed-project\src\test\scala\example
RENDER:
C:\Users\lettenj61\_g8js\github.com\scala-seed.g8\src\main\g8\src\main\scala\example\Hello.scala => C:\dev\scala\scala-seed-project\src\main\scala\example\Hello.scala
Successfully generated: C:\dev\scala\github\g8js\scala-seed-project

Properties to fill templates are collected in some ways.

By default, g8js prompts you for each variables defined in the template.

Alternatively you can pass values with --props, -p option. This form takes the first precedence so g8js would never prompt you with the property key specified with -p options.

The syntax is like -p name=CoolProject,organization=foobar.com, and -p option can occur many times.

For example, given options below:

$ g8js nowhere/template.g8 -p name=foo,organization=bar -p level=99 -p scalaVersion=2.11.12

Then g8js parses them like:

val props = Map(
  "name" -> "foo",
  "organization" -> "bar",
  "level" -> "99",
  "scalaVersion" -> "2.11.12"
)

When no -p options are provided, and you skip prompt by pressing Enter with blank input, g8js look for values in the templates' default.properties.

Lastly you can tell g8js to skip all prompts and force default values by giving -y, --yes flag. Note that even if you use -y, the -p options will be respected, and takes precedence over default.properties.

g8js runs git clone on the repository you give, then process their contents as template, render it to output location.

The template syntax is simulating original giter8 implementation. (Original documentation)

g8js will cache templates in local directory, grouping by hostname and user name. The root of cache directory is defaults to ~/_g8js (in windows, %USERPROFILE%\_g8js). For example lettenj61/scala-seed.g8 with --host github.com will be saved in path ~/_g8js/github.com/lettenj61/scala-seed.g8.

• It doesn't have giter8 feature to resolve library version from Maven Central (maven property).
• It doesn't support conditionals in template syntax.
• It doesn't support g8ignore and .gitignore.

• Not-so-heavy executable (~400kb minified)
• No NPM dependency is required

• Clean / update cached template
• Specify branch to pull template from
• Support full URLs, file URIs
• Support conditional syntax (priority: LOW)

The original giter8 project is licensed under Apache Software License 2.0.

g8js is licensed under MIT license.