You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@freemarker.apache.org by sg...@apache.org on 2020/08/04 20:22:21 UTC
[freemarker-generator] branch FREEMARKER-153 updated:
FREEMARKER-153 Rename "freemarker-cli" to "freemarker-generator"
This is an automated email from the ASF dual-hosted git repository.
sgoeschl pushed a commit to branch FREEMARKER-153
in repository https://gitbox.apache.org/repos/asf/freemarker-generator.git
The following commit(s) were added to refs/heads/FREEMARKER-153 by this push:
new 63cc4dc FREEMARKER-153 Rename "freemarker-cli" to "freemarker-generator"
63cc4dc is described below
commit 63cc4dcb04a5156434072fbc0856717064e36c72
Author: Siegfried Goeschl <si...@gmail.com>
AuthorDate: Tue Aug 4 22:22:05 2020 +0200
FREEMARKER-153 Rename "freemarker-cli" to "freemarker-generator"
---
README.md | 2 +-
.../generator/base/FreeMarkerConstants.java | 6 +-
.../src/site/markdown/index.md | 2 +-
freemarker-generator-cli/README.md | 14 ++---
freemarker-generator-cli/pom.xml | 2 +-
freemarker-generator-cli/src/main/assembly/app.xml | 4 +-
.../freemarker-generator.properties} | 0
.../org/apache/freemarker/generator/cli/Main.java | 6 +-
.../cli/config/TemplateDirectorySupplier.java | 8 +--
.../freemarker-generator.properties} | 0
.../src/main/scripts/run-examples.bat | 2 +-
.../src/main/scripts/run-examples.sh | 2 +-
.../markdown/cli/advanced/cli-configuration.md | 20 +++----
.../src/site/markdown/cli/concepts/data-models.md | 12 ++--
.../src/site/markdown/cli/concepts/passing-data.md | 10 ++--
.../site/markdown/cli/concepts/template-loading.md | 18 +++---
.../src/site/markdown/cli/concepts/tools.md | 2 +-
.../site/markdown/cli/concepts/transformation.md | 10 ++--
.../markdown/cli/introduction/getting-started.md | 30 +++++-----
.../site/markdown/cli/usage/running-examples.md | 66 +++++++++++-----------
.../site/markdown/cli/usage/transforming-csv.md | 8 +--
.../markdown/cli/usage/transforming-directories.md | 20 +++----
.../src/site/markdown/index.md | 4 +-
.../src/site/markdown/index.md | 8 +--
24 files changed, 128 insertions(+), 128 deletions(-)
diff --git a/README.md b/README.md
index d0c6e3d..f104070 100644
--- a/README.md
+++ b/README.md
@@ -23,7 +23,7 @@ well. It can be used to generated source code, configuration files, etc.
Currently it can be invoked as a
-* Command-line interface `freemarker-generator-cli`
+* Command-line interface `freemarker-generator`
* Maven plug-in `freemarker-generator-maven-plugin`
Building Apache FreeMarker Generator
diff --git a/freemarker-generator-base/src/main/java/org/apache/freemarker/generator/base/FreeMarkerConstants.java b/freemarker-generator-base/src/main/java/org/apache/freemarker/generator/base/FreeMarkerConstants.java
index 239c80e..779cf8b 100644
--- a/freemarker-generator-base/src/main/java/org/apache/freemarker/generator/base/FreeMarkerConstants.java
+++ b/freemarker-generator-base/src/main/java/org/apache/freemarker/generator/base/FreeMarkerConstants.java
@@ -47,13 +47,13 @@ public class FreeMarkerConstants {
private Configuration() {
}
- /** Prefix to extract tools from 'freemarker-cli.properties' */
+ /** Prefix to extract tools from 'freemarker-generator.properties' */
public static final String TOOLS_PREFIX = "freemarker.tools.";
- /** Key for reading the configured locale from 'freemarker-cli.properties' */
+ /** Key for reading the configured locale from 'freemarker-generator.properties' */
public static final String LOCALE_KEY = "freemarker.configuration.setting.locale";
- /** Prefix to extract FreeMarker configuration settings from 'freemarker-cli.properties' */
+ /** Prefix to extract FreeMarker configuration settings from 'freemarker-generator.properties' */
public static final String SETTING_PREFIX = "freemarker.configuration.setting.";
}
diff --git a/freemarker-generator-base/src/site/markdown/index.md b/freemarker-generator-base/src/site/markdown/index.md
index 212345d..0980fe0 100644
--- a/freemarker-generator-base/src/site/markdown/index.md
+++ b/freemarker-generator-base/src/site/markdown/index.md
@@ -1,3 +1,3 @@
-# Apache FreeMarker CLI Base
+# Apache FreeMarker Generator Base
This package contains infrastructure code not depending on `Apache FreeMarker` directly since `DataSources` and their creation might be useful for un-related command-line tools.
diff --git a/freemarker-generator-cli/README.md b/freemarker-generator-cli/README.md
index acfcc67..047aa60 100644
--- a/freemarker-generator-cli/README.md
+++ b/freemarker-generator-cli/README.md
@@ -4,13 +4,13 @@ Apache FreeMarker Generator CLI
This module provides provides the CLI for `Apache FreeMarker`.
* Requires JDK 1.8+ on Linux, Mac OSX and Windows
-* Add the bin/freemarker-cli or bin/freemarker-cli.bat to your PATH variable
+* Add the bin/freemarker-generator or bin/freemarker-generator.bat to your PATH variable
Now you can have a look at the command line options
```text
-freemarker-cli -h
-Usage: freemarker-cli (-t=<templates> [-t=<templates>]... |
+freemarker-generator -h
+Usage: freemarker-generator (-t=<templates> [-t=<templates>]... |
-i=<interactiveTemplate>) [-hV] [--stdin] [-b=<baseDir>]
[--config=<configFile>]
[--data-source-exclude=<dataSourceExcludePattern>]
@@ -20,10 +20,10 @@ Usage: freemarker-cli (-t=<templates> [-t=<templates>]... |
[-D=<String=String>]... [-m=<dataModels>]...
[-o=<outputs>]... [-P=<String=String>]...
[-s=<dataSources>]... [<sources>...]
-Apache FreeMarker CLI
+Apache FreeMarker Generator
[<sources>...] data source files and/or directories
-b, --basedir=<baseDir> additional template base directory
- --config=<configFile> FreeMarker CLI configuration file
+ --config=<configFile> FreeMarker Generator configuration file
-D, --system-property=<String=String>
set system property
--data-source-exclude=<dataSourceExcludePattern>
@@ -52,10 +52,10 @@ Apache FreeMarker CLI
-V, --version Print version information and exit.
```
-Check the version of the `Apache FreeMarker CLI`
+Check the version of the `Apache FreeMarker Generator`
```text
-freemarker-cli -V
+freemarker-generator -V
version=0.1.0-SNAPSHOT, time=2020-06-25T21:48:02+0200, commit=b320d00094be8789086ad6153d9d3fcaf4b8c75f
```
diff --git a/freemarker-generator-cli/pom.xml b/freemarker-generator-cli/pom.xml
index 66310bc..688755e 100644
--- a/freemarker-generator-cli/pom.xml
+++ b/freemarker-generator-cli/pom.xml
@@ -58,7 +58,7 @@
<platform>unix</platform>
</platforms>
<mainClass>org.apache.freemarker.generator.cli.Main</mainClass>
- <id>freemarker-cli</id>
+ <id>freemarker-generator</id>
</program>
</programs>
</configuration>
diff --git a/freemarker-generator-cli/src/main/assembly/app.xml b/freemarker-generator-cli/src/main/assembly/app.xml
index 41c987c..20eed47 100644
--- a/freemarker-generator-cli/src/main/assembly/app.xml
+++ b/freemarker-generator-cli/src/main/assembly/app.xml
@@ -28,7 +28,7 @@
<fileSet>
<directory>${project.basedir}/target/appassembler</directory>
<excludes>
- <exclude>bin/freemarker-cli</exclude>
+ <exclude>bin/freemarker-generator</exclude>
<exclude>*.sh</exclude>
</excludes>
<outputDirectory>${file.separator}</outputDirectory>
@@ -37,7 +37,7 @@
<fileSet>
<directory>${project.basedir}/target/appassembler</directory>
<includes>
- <include>bin/freemarker-cli</include>
+ <include>bin/freemarker-generator</include>
<include>*.sh</include>
</includes>
<outputDirectory>${file.separator}</outputDirectory>
diff --git a/freemarker-generator-cli/src/main/resources/freemarker-cli.properties b/freemarker-generator-cli/src/main/config/freemarker-generator.properties
similarity index 100%
rename from freemarker-generator-cli/src/main/resources/freemarker-cli.properties
rename to freemarker-generator-cli/src/main/config/freemarker-generator.properties
diff --git a/freemarker-generator-cli/src/main/java/org/apache/freemarker/generator/cli/Main.java b/freemarker-generator-cli/src/main/java/org/apache/freemarker/generator/cli/Main.java
index 8b3b853..669cac7 100644
--- a/freemarker-generator-cli/src/main/java/org/apache/freemarker/generator/cli/Main.java
+++ b/freemarker-generator-cli/src/main/java/org/apache/freemarker/generator/cli/Main.java
@@ -50,10 +50,10 @@ import static java.util.Objects.requireNonNull;
import static org.apache.freemarker.generator.cli.config.Suppliers.propertiesSupplier;
import static org.apache.freemarker.generator.cli.config.Suppliers.templateDirectorySupplier;
-@Command(description = "Apache FreeMarker CLI", name = "freemarker-cli", mixinStandardHelpOptions = true, versionProvider = GitVersionProvider.class)
+@Command(description = "Apache FreeMarker Generator", name = "freemarker-generator", mixinStandardHelpOptions = true, versionProvider = GitVersionProvider.class)
public class Main implements Callable<Integer> {
- private static final String FREEMARKER_CLI_PROPERTY_FILE = "freemarker-cli.properties";
+ private static final String FREEMARKER_GENERATOR_CLI_PROPERTY_FILE = "freemarker-generator.properties";
@ArgGroup(multiplicity = "1")
TemplateSourceOptions templateSourceOptions;
@@ -90,7 +90,7 @@ public class Main implements Callable<Integer> {
@Option(names = { "-s", "--data-source" }, description = "data source used for rendering")
List<String> dataSources;
- @Option(names = { "--config" }, defaultValue = FREEMARKER_CLI_PROPERTY_FILE, description = "FreeMarker CLI configuration file")
+ @Option(names = { "--config" }, defaultValue = FREEMARKER_GENERATOR_CLI_PROPERTY_FILE, description = "FreeMarker CLI configuration file")
String configFile;
@Option(names = { "--data-source-include" }, description = "file include pattern for data sources")
diff --git a/freemarker-generator-cli/src/main/java/org/apache/freemarker/generator/cli/config/TemplateDirectorySupplier.java b/freemarker-generator-cli/src/main/java/org/apache/freemarker/generator/cli/config/TemplateDirectorySupplier.java
index 976c4d4..fab66c9 100644
--- a/freemarker-generator-cli/src/main/java/org/apache/freemarker/generator/cli/config/TemplateDirectorySupplier.java
+++ b/freemarker-generator-cli/src/main/java/org/apache/freemarker/generator/cli/config/TemplateDirectorySupplier.java
@@ -32,13 +32,13 @@ import static java.util.stream.Collectors.toList;
* <ol>
* <li>User-defined template directory</li>
* <li>Current working directory</li>
- * <li>~/.freemarker-cli</li>
+ * <li>~/.freemarker-generator</li>
* <li>Application installation directory</li>
* </ol>
*/
public class TemplateDirectorySupplier implements Supplier<List<File>> {
- /** Installation directory of "freemarker-cli" when invoked with shell wrapper */
+ /** Installation directory of "freemarker-generator" when invoked with shell wrapper */
private static final String APP_HOME = "app.home";
/** Current working directory when invoked with shell wrapper */
@@ -47,8 +47,8 @@ public class TemplateDirectorySupplier implements Supplier<List<File>> {
/** Home directory of the user */
private static final String USER_HOME = "user.home";
- /** The user's optional "freemarker-cli" directory */
- private static final String USER_CONFIGURATION_DIR_NAME = ".freemarker-cli";
+ /** The user's optional "freemarker-generator" directory */
+ private static final String USER_CONFIGURATION_DIR_NAME = ".freemarker-generator";
/** User-defined template directory */
private final String userDefinedTemplateDir;
diff --git a/freemarker-generator-cli/src/main/config/freemarker-cli.properties b/freemarker-generator-cli/src/main/resources/freemarker-generator.properties
similarity index 100%
rename from freemarker-generator-cli/src/main/config/freemarker-cli.properties
rename to freemarker-generator-cli/src/main/resources/freemarker-generator.properties
diff --git a/freemarker-generator-cli/src/main/scripts/run-examples.bat b/freemarker-generator-cli/src/main/scripts/run-examples.bat
index 80dbf46..b550b54 100644
--- a/freemarker-generator-cli/src/main/scripts/run-examples.bat
+++ b/freemarker-generator-cli/src/main/scripts/run-examples.bat
@@ -21,7 +21,7 @@ REM Run all the samples being documented
mkdir target 2>NULL
mkdir target\out 2>NULL
-SET FREEMARKER_CMD=CALL .\bin\freemarker-cli.bat
+SET FREEMARKER_CMD=CALL .\bin\freemarker-generator.bat
REM =========================================================================
REM Info
diff --git a/freemarker-generator-cli/src/main/scripts/run-examples.sh b/freemarker-generator-cli/src/main/scripts/run-examples.sh
index 13eb994..a740da5 100755
--- a/freemarker-generator-cli/src/main/scripts/run-examples.sh
+++ b/freemarker-generator-cli/src/main/scripts/run-examples.sh
@@ -26,7 +26,7 @@ hash java 2>/dev/null || { echo >&2 "I require JDK but it's not installed. Abor
mkdir target 2>/dev/null
mkdir target/out 2>/dev/null
-FREEMARKER_CMD=./bin/freemarker-cli
+FREEMARKER_CMD=./bin/freemarker-generator
#############################################################################
# Info
diff --git a/freemarker-generator-cli/src/site/markdown/cli/advanced/cli-configuration.md b/freemarker-generator-cli/src/site/markdown/cli/advanced/cli-configuration.md
index 96353fd..4460330 100644
--- a/freemarker-generator-cli/src/site/markdown/cli/advanced/cli-configuration.md
+++ b/freemarker-generator-cli/src/site/markdown/cli/advanced/cli-configuration.md
@@ -1,14 +1,14 @@
## CLI Configuration
-The `Apache FreeMarker CLI` configuration can be tweaked to
+The `Apache FreeMarker Generator` configuration can be tweaked to
* Change the underlying `Apache FreeMarker Configuration`
* Instantiate custom tools
* Storing user-specific templates
-### Apache FreeMarker CLI Properties File
+### Apache FreeMarker Generator Properties File
-`Apache FreeMarker CLI` reads the `conf/freemarker-cli.properties`
+`Apache FreeMarker Generator` reads the `conf/freemarker-generator.properties`
```
#############################################################################
@@ -42,11 +42,11 @@ Changing this file allows to tweak the underlying `Apache FreeMarker Configurati
Over the time you will accumulate more and more `Apache FreeMarker` templates - some of them are stored within a project but some of the more general might be free-floating and you don't want to store them in the installation directory.
-To give those free-floating templates a home `Apache FreeMarker CLI` tries to read templates from `~/freemarker-cli`, e.g.
+To give those free-floating templates a home `Apache FreeMarker Generator CLI` tries to read templates from `~/freemarker-generator`, e.g.
```
-tree ~/.freemarker-cli/
-/Users/sgoeschl/.freemarker-cli/
+tree ~/.freemarker-generator/
+/Users/sgoeschl/.freemarker-generator/
`-- templates
`-- json
|-- confluence
@@ -62,16 +62,16 @@ tree ~/.freemarker-cli/
`-- customer-user-products.ftl
```
-If a `~/freemarker-cli` is found it will be automatically added to the `FreeMarker Template Loader` (for more information see https://freemarker.apache.org/docs/pgui_config_templateloading.html)
+If a `~/freemarker-generator` is found it will be automatically added to the `FreeMarker Template Loader` (for more information see https://freemarker.apache.org/docs/pgui_config_templateloading.html)
You can easily check this, e.g.
```
-> freemarker-cli -t templates/info.ftl
+> freemarker-generator -t templates/info.ftl
FreeMarker CLI Template Loader Directories
------------------------------------------------------------------------------
[#1] /Users/sgoeschl
-[#2] /Users/sgoeschl/.freemarker-cli
-[#3] /Applications/Java/freemarker-cli-2.0.0
+[#2] /Users/sgoeschl/.freemarker-generator
+[#3] /Applications/Java/freemarker-generator-2.0.0
```
diff --git a/freemarker-generator-cli/src/site/markdown/cli/concepts/data-models.md b/freemarker-generator-cli/src/site/markdown/cli/concepts/data-models.md
index 65aac2a..bd56d76 100644
--- a/freemarker-generator-cli/src/site/markdown/cli/concepts/data-models.md
+++ b/freemarker-generator-cli/src/site/markdown/cli/concepts/data-models.md
@@ -24,7 +24,7 @@ Expose the fields of the JSON data source in FreeMarker's model
"year": "2020"
}
-> freemarker-cli --data-model https://xkcd.com/info.0.json -i '<a href="${img}">${title}</a>'; echo
+> freemarker-generator --data-model https://xkcd.com/info.0.json -i '<a href="${img}">${title}</a>'; echo
<a href="https://imgs.xkcd.com/comics/old_days_2.png">Old Days 2</a>
```
@@ -39,14 +39,14 @@ Exposed the JSON data source as variable `post` in FreeMarker's model
"userId": 1
}
-> freemarker-cli --data-model post=https://jsonplaceholder.typicode.com/posts/2 -i 'post title is: ${post.title}'; echo
+> freemarker-generator --data-model post=https://jsonplaceholder.typicode.com/posts/2 -i 'post title is: ${post.title}'; echo
post title is: qui est esse
```
Expose all environment variables as `env` in theFreeMarker model
```
-> freemarker-cli --data-model env=env:/// -i '<#list env as name,value>${name}=${value}${"\n"}</#list>'
+> freemarker-generator --data-model env=env:/// -i '<#list env as name,value>${name}=${value}${"\n"}</#list>'
HOME=/Users/sgoeschl
USER=sgoeschl
```
@@ -54,14 +54,14 @@ USER=sgoeschl
Expose a single environment variable in theFreeMarker model
```
-> freemarker-cli --data-model NAME=env:///USER -i 'Hello ${NAME}'; echo
+> freemarker-generator --data-model NAME=env:///USER -i 'Hello ${NAME}'; echo
Hello sgoeschl
```
Alternatively use the short command line options, e.g.
```
-> freemarker-cli -m NAME=env:///USER -i 'Hello ${NAME}!'; echo
+> freemarker-generator -m NAME=env:///USER -i 'Hello ${NAME}!'; echo
Hello sgoeschl!
```
@@ -74,7 +74,7 @@ The following snippet shows a more advanced example
> export DB_CONFIG='{"db_default_user":"scott","db_default_password":"tiger"}'
> echo $DB_CONFIG
{"db_default_user":"scott","db_default_password":"tiger"}
-> freemarker-cli -m config=env:///DB_CONFIG#mimeType=application/json -i '<#list config as name,value>${name}=${value}${"\n"}</#list>'
+> freemarker-generator -m config=env:///DB_CONFIG#mimeType=application/json -i '<#list config as name,value>${name}=${value}${"\n"}</#list>'
db_default_user=scott
db_default_password=tiger
```
\ No newline at end of file
diff --git a/freemarker-generator-cli/src/site/markdown/cli/concepts/passing-data.md b/freemarker-generator-cli/src/site/markdown/cli/concepts/passing-data.md
index eb6110e..5fdd4e2 100644
--- a/freemarker-generator-cli/src/site/markdown/cli/concepts/passing-data.md
+++ b/freemarker-generator-cli/src/site/markdown/cli/concepts/passing-data.md
@@ -1,6 +1,6 @@
## Passing Configuration Data
-`Apache FreeMarker CLI` provides multiple ways to pass configuration data used in in templates
+`Apache FreeMarker Generator CLI` provides multiple ways to pass configuration data used in in templates
* System properties
* Parameters
@@ -10,7 +10,7 @@
User-supplied system properties are added to the JVM's system properties
```
-> freemarker-cli -Dfoo1=foo1 -D foo2=foo2 -t templates/info.ftl
+> freemarker-generator -Dfoo1=foo1 -D foo2=foo2 -t templates/info.ftl
```
### User-Supplied Parameters
@@ -23,7 +23,7 @@ User-supplied parameters allow to pass additional information to an Apache FreeM
Pass a simple name/value pair on the command line
```
-> freemarker-cli -t templates/info.ftl -P key=value
+> freemarker-generator -t templates/info.ftl -P key=value
User Supplied Parameters
------------------------------------------------------------------------------
@@ -33,7 +33,7 @@ User Supplied Parameters
By providing a `group` you can create nested maps
```
-> freemarker-cli -t templates/info.ftl -P foo1:group=bar1 -P foo2:group=bar2
+> freemarker-generator -t templates/info.ftl -P foo1:group=bar1 -P foo2:group=bar2
User Supplied Parameters
------------------------------------------------------------------------------
@@ -43,7 +43,7 @@ User Supplied Parameters
It is also possible to mix and match the two approaches
```
-> freemarker-cli -t templates/info.ftl -P foo1:group=bar1 -P foo2:group=bar2 -P key=value
+> freemarker-generator -t templates/info.ftl -P foo1:group=bar1 -P foo2:group=bar2 -P key=value
User Supplied Parameters
------------------------------------------------------------------------------
diff --git a/freemarker-generator-cli/src/site/markdown/cli/concepts/template-loading.md b/freemarker-generator-cli/src/site/markdown/cli/concepts/template-loading.md
index 30e9404..43ae25a 100644
--- a/freemarker-generator-cli/src/site/markdown/cli/concepts/template-loading.md
+++ b/freemarker-generator-cli/src/site/markdown/cli/concepts/template-loading.md
@@ -8,28 +8,28 @@ In order the render a template it needs to be loaded first - there are multiple
### FreeMarker MultiTemplateLoader
-`Apache FreeMarker CLI` uses a `MultiTemplateLoader` searching for templates in the following directories
+`Apache FreeMarker Generator CLI` uses a `MultiTemplateLoader` searching for templates in the following directories
* Current working directory
-* Optional `~/.freemarker-cli` directory
-* `Apache FreeMarker CLI` installation directory
+* Optional `~/.freemarker-generator` directory
+* `Apache FreeMarker Generator` installation directory
You can check the currently used template loader directories easily on the command line, e.g.
```
-freemarker-cli -t templates/info.ftl
+freemarker-generator -t templates/info.ftl
FreeMarker CLI Template Loader Directories
------------------------------------------------------------------------------
[#1] /Users/sgoeschl/work/github/apache/freemarker-generator
-[#2] /Users/sgoeschl/.freemarker-cli
-[#3] /Applications/Java/freemarker-cli-2.0.0
+[#2] /Users/sgoeschl/.freemarker-generator
+[#3] /Applications/Java/freemarker-generator-2.0.0
```
The main benefit of `MultiTemplateLoader` is the use of abstract template paths finding a template in the template loader directories
```
-freemarker-cli -t templates/info.ftl
+freemarker-generator -t templates/info.ftl
```
and [Template Includes](https://freemarker.apache.org/docs/ref_directive_include.html)
@@ -47,7 +47,7 @@ irrelevant therefore any template file outside of the template loader directorie
This example loads the `info.ftl` directly from a GitHub URL
```
-freemarker-cli -t https://raw.githubusercontent.com/apache/freemarker-generator/master/freemarker-generator-cli/templates/info.ftl
+freemarker-generator -t https://raw.githubusercontent.com/apache/freemarker-generator/master/freemarker-generator-cli/templates/info.ftl
```
### Interactive Template Loading
@@ -55,6 +55,6 @@ freemarker-cli -t https://raw.githubusercontent.com/apache/freemarker-generator/
The template can be defined directly on the command line in case of trivial transformations
```
-freemarker-cli -i '${tools.gson.toJson(yaml)}' -m yaml=examples/data/yaml/swagger-spec.yaml
+freemarker-generator -i '${tools.gson.toJson(yaml)}' -m yaml=examples/data/yaml/swagger-spec.yaml
```
diff --git a/freemarker-generator-cli/src/site/markdown/cli/concepts/tools.md b/freemarker-generator-cli/src/site/markdown/cli/concepts/tools.md
index c07a01a..c5bb4da 100644
--- a/freemarker-generator-cli/src/site/markdown/cli/concepts/tools.md
+++ b/freemarker-generator-cli/src/site/markdown/cli/concepts/tools.md
@@ -1,6 +1,6 @@
## Tools
-A `Apache FreeMarker CLI Tool` is just a POJO (plain old Java object) that is "useful" in a template and is not meant to be rendered in the output.
+A `Apache FreeMarker Generator Tool` is just a POJO (plain old Java object) that is "useful" in a template and is not meant to be rendered in the output.
The following tools are currently implemented
diff --git a/freemarker-generator-cli/src/site/markdown/cli/concepts/transformation.md b/freemarker-generator-cli/src/site/markdown/cli/concepts/transformation.md
index 73477eb..779c269 100644
--- a/freemarker-generator-cli/src/site/markdown/cli/concepts/transformation.md
+++ b/freemarker-generator-cli/src/site/markdown/cli/concepts/transformation.md
@@ -1,6 +1,6 @@
## Transformation
-The `freemarker-cli` generates text output based on processing FreeMarker templates and data
+The `freemarker-generator` generates text output based on processing FreeMarker templates and data
* A command line invocation requires 1..n `templates` and 0..n `data sources` / `data models`
* A command line invocation is mapped to a series of `template transformations`
@@ -18,7 +18,7 @@ The `freemarker-cli` generates text output based on processing FreeMarker templa
Transforming a single template to a single output file
```
-freemarker-cli \
+freemarker-generator \
-t templates/csv/md/transform.ftl examples/data/csv/contract.csv \
-o target/contract.md
```
@@ -26,7 +26,7 @@ freemarker-cli \
Transforming multiple templates to multiple output files (1:1 mapping between templates and outputs)
```
-> freemarker-cli \
+> freemarker-generator \
-t templates/csv/md/transform.ftl -o target/contract.md \
-t templates/csv/html/transform.ftl -o target/contract.html \
examples/data/csv/contract.csv
@@ -40,7 +40,7 @@ target
Transforming single template directory to single output directory
```
-> freemarker-cli \
+> freemarker-generator \
-t examples/data/template -o target/template1
> tree target
@@ -56,7 +56,7 @@ target
Transforming multiple template directories to multiple output directories
```
-freemarker-cli \
+freemarker-generator \
-t examples/data/template -o target/template1 \
-t examples/data/template -o target/template2
diff --git a/freemarker-generator-cli/src/site/markdown/cli/introduction/getting-started.md b/freemarker-generator-cli/src/site/markdown/cli/introduction/getting-started.md
index e2f0de4..d90fbfd 100644
--- a/freemarker-generator-cli/src/site/markdown/cli/introduction/getting-started.md
+++ b/freemarker-generator-cli/src/site/markdown/cli/introduction/getting-started.md
@@ -5,38 +5,38 @@
* Requires JDK 1.8+ on Linux, Mac OSX and Windows
* Download [freemarker-generator-cli-0.1.0-SNAPSHOT-app.tar.gz] or [freemarker-generator-cli-0.1.0-SNAPSHOT-app.zip]
* Unpack the archive in a directory of your choice
-* Add the `bin/freemarker-cli` or `bin/freemarker-cli.bat` to your `PATH` variable
+* Add the `bin/freemarker-generator` or `bin/freemarker-generator.bat` to your `PATH` variable
### Verify Installation
On my local box (Mac OS 10.15.5) I use the following setup
```
-export FREEMARKER_CLI_HOME=/Applications/Java/freemarker-cli-2.0.0
+export FREEMARKER_CLI_HOME=/Applications/Java/freemarker-generator-2.0.0
export PATH=$PATH:$FREEMARKER_CLI_HOME/bin
```
-Afterwards `Apache FreeMarker CLI` can be executed from the command line
+Afterwards `Apache FreeMarker Generator` can be executed from the command line
```
-> which freemarker-cli
-/Applications/Java/freemarker-cli-2.0.0/bin/freemarker-cli
+> which freemarker-generator
+/Applications/Java/freemarker-generator-2.0.0/bin/freemarker-generator
```
-and check the version of `Apache FreeMarker CLI`
+and check the version of `Apache FreeMarker Generator`
```
-> freemarker-cli -V
+> freemarker-generator -V
version=0.1.0-SNAPSHOT, time=2020-06-25T21:48:02+0200, commit=b320d00094be8789086ad6153d9d3fcaf4b8c75f
```
### Command Line Options
-`Apache FreeMarker CLI` provides command line help as shown below
+`Apache FreeMarker Generator` provides command line help as shown below
```
-> freemarker-cli -h
- Usage: freemarker-cli (-t=<templates> [-t=<templates>]... |
+> freemarker-generator -h
+ Usage: freemarker-generator (-t=<templates> [-t=<templates>]... |
-i=<interactiveTemplate>) [-hV] [--stdin] [-b=<baseDir>]
[--config=<configFile>]
[--data-source-exclude=<dataSourceExcludePattern>]
@@ -46,7 +46,7 @@ version=0.1.0-SNAPSHOT, time=2020-06-25T21:48:02+0200, commit=b320d00094be878908
[-D=<String=String>]... [-m=<dataModels>]...
[-o=<outputs>]... [-P=<String=String>]...
[-s=<dataSources>]... [<sources>...]
- Apache FreeMarker CLI
+ Apache FreeMarker Generator
[<sources>...] data source files and/or directories
-b, --basedir=<baseDir> additional template base directory
--config=<configFile> FreeMarker CLI configuration file
@@ -81,10 +81,10 @@ version=0.1.0-SNAPSHOT, time=2020-06-25T21:48:02+0200, commit=b320d00094be878908
### The Info Template
The distribution ships with a couple of FreeMarker templates and the `templates/info.ftl` is particularly helpful
-to better understand `Apache FreeMarker CLI`
+to better understand `Apache FreeMarker Generator`
```
-> freemarker-cli -t templates/info.ftl
+> freemarker-generator -t templates/info.ftl
FreeMarker CLI Information
------------------------------------------------------------------------------
FreeMarker version : 2.3.30
@@ -98,8 +98,8 @@ Output format : plainText
FreeMarker CLI Template Loader Directories
------------------------------------------------------------------------------
[#1] /Users/sgoeschl/work/github/apache/freemarker-generator
-[#2] /Users/sgoeschl/.freemarker-cli
-[#3] /Applications/Java/freemarker-cli-2.0.0
+[#2] /Users/sgoeschl/.freemarker-generator
+[#3] /Applications/Java/freemarker-generator-2.0.0
FreeMarker CLI Tools
------------------------------------------------------------------------------
diff --git a/freemarker-generator-cli/src/site/markdown/cli/usage/running-examples.md b/freemarker-generator-cli/src/site/markdown/cli/usage/running-examples.md
index ec19b06..0c185fb 100644
--- a/freemarker-generator-cli/src/site/markdown/cli/usage/running-examples.md
+++ b/freemarker-generator-cli/src/site/markdown/cli/usage/running-examples.md
@@ -2,7 +2,7 @@
There a many examples (see below) available you can execute - The examples were tested with JDK 1.8 on Mac OS X.
-Run `run-examples.sh` in the `Apache Freemarker CLI` installation directory and have a look at the generated output.
+Run `run-examples.sh` in the `Apache FreeMarker Generator` installation directory and have a look at the generated output.
```text
./run-examples.sh
@@ -82,11 +82,11 @@ A simple example with real JSON data to be transformed into Markdown
You can either use the existing JSON sample
-> freemarker-cli -t examples/templates/json/md/github-users.ftl examples/data/json/github-users.json
+> freemarker-generator -t examples/templates/json/md/github-users.ftl examples/data/json/github-users.json
or pipe a cURL response
-> curl -s https://api.github.com/users | freemarker-cli -t examples/templates/json/md/github-users.ftl --stdin
+> curl -s https://api.github.com/users | freemarker-generator -t examples/templates/json/md/github-users.ftl --stdin
Below you see the Apache FreeMarker Template
@@ -121,8 +121,8 @@ creates the following output
Sometimes you have a CSV file which needs to be translated in Markdown or HTML - there are on-line solutions available such as [CSV To Markdown Table Generator](https://donatstudios.com/CsvToMarkdownTable) but having a local solution gives you more flexibility.
```text
-> freemarker-cli -t templates/csv/md/transform.ftl examples/data/csv/contract.csv
-> freemarker-cli -t templates/csv/html/transform.ftl examples/data/csv/contract.csv
+> freemarker-generator -t templates/csv/md/transform.ftl examples/data/csv/contract.csv
+> freemarker-generator -t templates/csv/html/transform.ftl examples/data/csv/contract.csv
```
The FreeMarker template is shown below
@@ -160,7 +160,7 @@ The resulting file actually looks pleasant when compared to raw CSV
Of course you can also transform a XML document
```text
-> freemarker-cli -t examples/templates/xml/txt/recipients.ftl examples/data/xml/recipients.xml
+> freemarker-generator -t examples/templates/xml/txt/recipients.ftl examples/data/xml/recipients.xml
```
using the following template
@@ -249,7 +249,7 @@ ${'\n'}
Invoking the FTL template
-> freemarker-cli -t examples/templates/json/csv/swagger-endpoints.ftl examples/data/json/swagger-spec.json
+> freemarker-generator -t examples/templates/json/csv/swagger-endpoints.ftl examples/data/json/swagger-spec.json
gives you
@@ -266,10 +266,10 @@ ENDPOINT;METHOD;CONSUMES;PRODUCES;SUMMARY;DESCRIPTION
Another day my project management asked me to create a CSV configuration file based on an Excel documents - as usual manual copying was not an option due to required data cleanup and data transformation. So I thought about Apache POI which support XLS and XLSX documents - integration of Apache POI was a breeze but the resulting code was not particularly useful example. So a more generic transformation was provided to show the transformation of Excel documents ...
```text
-> freemarker-cli -t templates/excel/html/transform.ftl examples/data/excel/test.xls
-> freemarker-cli -t templates/excel/html/transform.ftl examples/data/excel/test.xlsx
-> freemarker-cli -t templates/excel/html/transform.ftl examples/data/excel/test-multiple-sheets.xlsx
-> freemarker-cli -t templates/excel/md/transform.ftl examples/data/excel/test-multiple-sheets.xlsx
+> freemarker-generator -t templates/excel/html/transform.ftl examples/data/excel/test.xls
+> freemarker-generator -t templates/excel/html/transform.ftl examples/data/excel/test.xlsx
+> freemarker-generator -t templates/excel/html/transform.ftl examples/data/excel/test-multiple-sheets.xlsx
+> freemarker-generator -t templates/excel/md/transform.ftl examples/data/excel/test-multiple-sheets.xlsx
```
The provided FTL transforms an Excel into a HTML document supporting multiple Excel sheets
@@ -353,7 +353,7 @@ but the result looks reasonable
In this sample we transform all property files found in a directory (recursive search using include pattern) to a CSV file
```text
-> freemarker-cli --data-source-include *.properties -t examples/templates/properties/csv/locker-test-users.ftl examples/data/properties
+> freemarker-generator --data-source-include *.properties -t examples/templates/properties/csv/locker-test-users.ftl examples/data/properties
TENANT,SITE,USER_ID,DISPOSER_ID,PASSWORD,SMS_OTP,NAME,DESCRIPTION
TENANT_A,fat,user_0004,user_0004,password_0004,,,
TENANT_B,fat,user_0001,user_0001,password_0001,,,
@@ -484,7 +484,7 @@ For a POC (proof of concept) I created a sample transformation from CSV to XML-F
In order to create the PDF you need to execute the following commands (assuming that you have Apache FOP installed)
```text
-> freemarker-cli -t examples/templates/csv/fo/transform.ftl examples/data/csv/locker-test-users.csv > sample.fo
+> freemarker-generator -t examples/templates/csv/fo/transform.ftl examples/data/csv/locker-test-users.csv > sample.fo
> fop -fo sample.fo sample.pdf
Dec 29, 2018 10:24:30 PM org.apache.fop.events.LoggingEventListener processEvent
WARNING: Font "Symbol,normal,700" not found. Substituting with "Symbol,normal,400".
@@ -501,7 +501,7 @@ The result does not look very impressive but it is a PDF :-)
Further along the line of the POC we converted a transaction export from CSV to PDF using Apache FOP
```text
-> freemarker-cli -t examples/templates/csv/fo/transactions.ftl examples/data/csv/transactions.csv > transactions.fo
+> freemarker-generator -t examples/templates/csv/fo/transactions.ftl examples/data/csv/transactions.csv > transactions.fo
> fop -fo transactions.fo transactions.pdf
Jan 16, 2019 11:15:21 PM org.apache.fop.events.LoggingEventListener processEvent
WARNING: Font "Symbol,normal,700" not found. Substituting with "Symbol,normal,400".
@@ -562,7 +562,7 @@ Recently I got the rather unusual question how to determine the list of dependen
Your dependencies as CSV can be generated as shown below
```text
-> freemarker-cli -t examples/templates/html/csv/dependencies.ftl examples/data/html/dependencies.html
+> freemarker-generator -t examples/templates/html/csv/dependencies.ftl examples/data/html/dependencies.html
GroupId,ArtifactId,Version,Type,Licenses
com.jayway.jsonpath,json-path,2.4.0,jar,The Apache Software License Version 2.0
commons-cli,commons-cli,1.4,jar,Apache License Version 2.0
@@ -617,7 +617,7 @@ date "+%FT%H:%M:%S" | tr -d '\n'; curl --write-out ',${record.disposer},%{http_c
Rendering the FreeMarker template
```
-> freemarker-cli -t ./examples/templates/csv/shell/curl.ftl examples/data/csv/user.csv
+> freemarker-generator -t ./examples/templates/csv/shell/curl.ftl examples/data/csv/user.csv
```
generates the following shell script
@@ -659,7 +659,7 @@ QUOTEDSTRING (?>(?<!\\)(?>"(?>\\.|[^\\"]+)+"|""|(?>'(?>\\.|[^\\']+)+')|''|(?>`(?
And with `Grok` the `QUOTEDSTRING` is just a building block for an even more complex regular expression such as `COMBINEDAPACHELOG`
-> bin/freemarker-cli -t examples/templates/accesslog/combined-access.ftl examples/data/accesslog/combined-access.log
+> bin/freemarker-generator -t examples/templates/accesslog/combined-access.ftl examples/data/accesslog/combined-access.log
which gives you the following output
@@ -765,22 +765,22 @@ h3. AWS EC2 Instance
Sometime you need to apply a CSS, JSON or XPath query in ad ad-hoc way without installing `xmllint`, `jq` or `pup` - in this case you can pass a FreeMarker template in an interactive fashion
```text
-> bin/freemarker-cli -i 'Hello ${tools.system.envs["USER"]}'; echo
+> bin/freemarker-generator -i 'Hello ${tools.system.envs["USER"]}'; echo
Hello sgoeschl
-> bin/freemarker-cli -i '${tools.jsonpath.parse(dataSources?values[0]).read("$.info.title")}' examples/data/json/swagger-spec.json; echo
+> bin/freemarker-generator -i '${tools.jsonpath.parse(dataSources?values[0]).read("$.info.title")}' examples/data/json/swagger-spec.json; echo
Swagger Petstore
-> bin/freemarker-cli -i 'Post Title : ${tools.jsonpath.parse(dataSources?values[0]).read("$.title")}' https://jsonplaceholder.typicode.com/posts/2; echo
+> bin/freemarker-generator -i 'Post Title : ${tools.jsonpath.parse(dataSources?values[0]).read("$.title")}' https://jsonplaceholder.typicode.com/posts/2; echo
Post Title : qui est esse
-> bin/freemarker-cli -i '${tools.xml.parse(dataSources?values[0])["recipients/person[1]/name"]}' examples/data/xml/recipients.xml; echo
+> bin/freemarker-generator -i '${tools.xml.parse(dataSources?values[0])["recipients/person[1]/name"]}' examples/data/xml/recipients.xml; echo
John Smith
-> bin/freemarker-cli -i '${tools.jsoup.parse(dataSources?values[0]).select("a")[0]}' examples/data/html/dependencies.html; echo
+> bin/freemarker-generator -i '${tools.jsoup.parse(dataSources?values[0]).select("a")[0]}' examples/data/html/dependencies.html; echo
<a href="${project.url}" title="FreeMarker CLI">FreeMarker CLI</a>
-> freemarker-cli -i '<#list tools.system.envs as name,value>${name} ==> ${value}${"\n"}</#list>'
+> freemarker-generator -i '<#list tools.system.envs as name,value>${name} ==> ${value}${"\n"}</#list>'
TERM ==> xterm-256color
LANG ==> en_US
DISPLAY ==> :0.0
@@ -795,7 +795,7 @@ During an integration project we imported large transactions CSV files (500.000+
So lets start the filtering & transformation using the following command line
```text
-> bin/freemarker-cli -e UTF-8 -l de_AT -Pcolumn="Order ID" \
+> bin/freemarker-generator -e UTF-8 -l de_AT -Pcolumn="Order ID" \
-Pvalues=226939189,957081544 \
-t examples/templates/csv/md/filter.ftl examples/data/csv/sales-records.csv
```
@@ -889,13 +889,13 @@ yields
Sometimes we simply need to transform a JSON into an equivalent YAML or the other way around
```
-> freemarker-cli -t templates/yaml/json/transform.ftl examples/data/yaml/swagger-spec.yaml
-> freemarker-cli -i '${tools.gson.toJson(tools.yaml.parse(dataSources?values[0]))}' examples/data/yaml/swagger-spec.yaml
-> freemarker-cli -i '${tools.gson.toJson(yaml)}' -m yaml=examples/data/yaml/swagger-spec.yaml
+> freemarker-generator -t templates/yaml/json/transform.ftl examples/data/yaml/swagger-spec.yaml
+> freemarker-generator -i '${tools.gson.toJson(tools.yaml.parse(dataSources?values[0]))}' examples/data/yaml/swagger-spec.yaml
+> freemarker-generator -i '${tools.gson.toJson(yaml)}' -m yaml=examples/data/yaml/swagger-spec.yaml
-> freemarker-cli -t templates/json/yaml/transform.ftl examples/data/json/swagger-spec.json
-> freemarker-cli -i '${tools.yaml.toYaml(tools.gson.parse(dataSources?values[0]))}' examples/data/json/swagger-spec.json
-> freemarker-cli -i '${tools.yaml.toYaml(json)}' -m json=examples/data/json/swagger-spec.json
+> freemarker-generator -t templates/json/yaml/transform.ftl examples/data/json/swagger-spec.json
+> freemarker-generator -i '${tools.yaml.toYaml(tools.gson.parse(dataSources?values[0]))}' examples/data/json/swagger-spec.json
+> freemarker-generator -i '${tools.yaml.toYaml(json)}' -m json=examples/data/json/swagger-spec.json
```
### 15. Using Advanced FreeMarker Features
@@ -910,7 +910,7 @@ There is a `demo.ftl` which shows some advanced FreeMarker functionality
Running
-> freemarker-cli -t examples/templates/demo.ftl
+> freemarker-generator -t examples/templates/demo.ftl
gives you
@@ -974,7 +974,7 @@ user.home : /Users/sgoeschl
9) List Environment Variables
---------------------------------------------------------------------------
-- PATH ==> /Users/sgoeschl/bin:/Library/Java/JavaVirtualMachines/jdk1.8.0_192.jdk/Contents/Home/bin:/usr/local/opt/ruby/bin:HOME/.gem/ruby/2.7.0/bin:/usr/local/Cellar/git/2.19.1/bin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin:/Library/Apple/usr/bin:/Applications/Java/apache-fop-2.3:/Applications/Java/freemarker-cli-2.0.0-BETA-2/bin:
+- PATH ==> /Users/sgoeschl/bin:/Library/Java/JavaVirtualMachines/jdk1.8.0_192.jdk/Contents/Home/bin:/usr/local/opt/ruby/bin:HOME/.gem/ruby/2.7.0/bin:/usr/local/Cellar/git/2.19.1/bin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin:/Library/Apple/usr/bin:/Applications/Java/apache-fop-2.3:/Applications/Java/freemarker-generator-2.0.0-BETA-2/bin:
- GIT_HOME ==> /usr/local/Cellar/git/2.19.1
- JAVA_8_HOME ==> /Library/Java/JavaVirtualMachines/jdk1.8.0_192.jdk/Contents/Home
- JAVA_HOME ==> /Library/Java/JavaVirtualMachines/jdk1.8.0_192.jdk/Contents/Home
@@ -1006,7 +1006,7 @@ user.home : /Users/sgoeschl
- SSH_AUTH_SOCK ==> /private/tmp/com.apple.launchd.DTdlBj20Ka/Listeners
- EDITOR ==> vi
- XPC_FLAGS ==> 0x0
-- FREEMARKER_CLI_HOME ==> /Applications/Java/freemarker-cli-2.0.0-BETA-2
+- FREEMARKER_CLI_HOME ==> /Applications/Java/freemarker-generator-2.0.0-BETA-2
- TERM_SESSION_ID ==> 2745D6A3-543A-4DE3-830B-945678460311
- LC_ALL ==> en_US.utf-8
- __CF_USER_TEXT_ENCODING ==> 0x1F5:0x0:0x0
diff --git a/freemarker-generator-cli/src/site/markdown/cli/usage/transforming-csv.md b/freemarker-generator-cli/src/site/markdown/cli/usage/transforming-csv.md
index a891c38..0cf1634 100644
--- a/freemarker-generator-cli/src/site/markdown/cli/usage/transforming-csv.md
+++ b/freemarker-generator-cli/src/site/markdown/cli/usage/transforming-csv.md
@@ -1,6 +1,6 @@
## Transforming CSV
-A common task is changing the output format of a CSV file therefore `Apache FreeMarker CLI` ships with a ready-to-use
+A common task is changing the output format of a CSV file therefore `Apache FreeMarker Generator` ships with a ready-to-use
templates to convert CSVs
* Convert a CSV into a different format
@@ -15,7 +15,7 @@ This allows opening the CSV directly in Excel without going to the tedious CSV i
The following command line prints the converted CSV to `stdout`
```
-freemarker-cli \
+freemarker-generator \
-PCSV_SOURCE_FORMAT=DEFAULT \
-PCSV_TARGET_FORMAT=EXCEL \
-PCSV_TARGET_DELIMITER=SEMICOLON \
@@ -37,7 +37,7 @@ actually allows including CSV directly)
The following command line prints the resulting MarkDown to `stdout`
```
-freemarker-cli \
+freemarker-generator \
-PCSV_SOURCE_FORMAT=DEFAULT \
-t templates/csv/md/transform.ftl \
https://raw.githubusercontent.com/apache/freemarker-generator/master/freemarker-generator-cli/examples/data/csv/contract.csv
@@ -50,7 +50,7 @@ Please note that most MarkDown tools expect a header row (see [Create a table wi
Of course it is possible to convert a CSV to HTML as well
```
-freemarker-cli \
+freemarker-generator \
-PCSV_SOURCE_FORMAT=DEFAULT \
-t templates/csv/html/transform.ftl \
https://raw.githubusercontent.com/apache/freemarker-generator/master/freemarker-generator-cli/examples/data/csv/contract.csv
diff --git a/freemarker-generator-cli/src/site/markdown/cli/usage/transforming-directories.md b/freemarker-generator-cli/src/site/markdown/cli/usage/transforming-directories.md
index 073a7e9..4eec217 100644
--- a/freemarker-generator-cli/src/site/markdown/cli/usage/transforming-directories.md
+++ b/freemarker-generator-cli/src/site/markdown/cli/usage/transforming-directories.md
@@ -1,6 +1,6 @@
## Transforming Directories
-`Apache FreeMarker CLI` supports the transformation of directories
+`Apache FreeMarker Generator` supports the transformation of directories
* Transform an input directory recursively into an output directory
* If a template has a ".ftl" extension this extension will be removed after processing
@@ -39,7 +39,7 @@ server {
If no output directory is provided all output is written to `stdout`
```
-freemarker-cli -t examples/data/template/
+freemarker-generator -t examples/data/template/
# == application.properties ==================================================
server.name=localhost
server.logs=/var/log/nginx
@@ -60,7 +60,7 @@ The transformed templates are written to an `out` directory
* `nginx.conf.ftl` was changed to `nginx.conf" during the transformation
```
-freemarker-cli -t examples/data/template/ -o out; tree out
+freemarker-generator -t examples/data/template/ -o out; tree out
out
|-- application.properties
`-- nginx
@@ -74,7 +74,7 @@ out
A user-supplied parameter `NGINX_HOSTNAME` is used to render the templates
```
-freemarker-cli -t examples/data/template/ -P NGINX_HOSTNAME=localhost
+freemarker-generator -t examples/data/template/ -P NGINX_HOSTNAME=localhost
# == application.properties ==================================================
server.name=localhost
server.logs=/var/log/nginx
@@ -97,7 +97,7 @@ All environment variables can be copied to the top-level data model by providing
```
export NGINX_PORT=8080
-freemarker-cli -t examples/data/template/ -m env:///
+freemarker-generator -t examples/data/template/ -m env:///
# == application.properties ==================================================
server.name=localhost
server.logs=/var/log/nginx
@@ -117,7 +117,7 @@ Instead of environment variables an environment file (aka properties file) can b
```
echo "NGINX_PORT=8080" > nginx.env
-freemarker-cli -t examples/data/template/ -m nginx.env
+freemarker-generator -t examples/data/template/ -m nginx.env
# == application.properties ==================================================
server.name=localhost
server.logs=/var/log/nginx
@@ -137,7 +137,7 @@ Another option is passing the information as JSON file
```
echo '{"NGINX_PORT":"8443","NGINX_HOSTNAME":"localhost"}' > nginx.json
-freemarker-cli -t examples/data/template/ -m nginx.json
+freemarker-generator -t examples/data/template/ -m nginx.json
# == application.properties ==================================================
server.name=localhost
server.logs=/var/log/nginx
@@ -157,7 +157,7 @@ Yet another option is using a YAML file
```
echo -e "- NGINX_PORT": "\"8443\"\n- NGINX_HOSTNAME": "localhost" > nginx.yaml
-freemarker-cli -t examples/data/template/ -m nginx.yaml
+freemarker-generator -t examples/data/template/ -m nginx.yaml
# == application.properties ==================================================
server.name=localhost
server.logs=/var/log/nginx
@@ -180,7 +180,7 @@ In the cloud it is common to pass JSON configuration as environment variable
```
export NGINX_CONF='{"NGINX_PORT":"8443","NGINX_HOSTNAME":"localhost"}'
-freemarker-cli -t examples/data/template/ -m env:///NGINX_CONF#mimeType=application/json
+freemarker-generator -t examples/data/template/ -m env:///NGINX_CONF#mimeType=application/json
# == application.properties ==================================================
server.name=localhost
server.logs=/var/log/nginx
@@ -200,7 +200,7 @@ For testing purpose it is useful to override certain settings
```
export NGINX_CONF='{"NGINX_PORT":"8443","NGINX_HOSTNAME":"localhost"}'
-freemarker-cli -t examples/data/template/ -PNGINX_HOSTNAME=www.mydomain.com -m env:///NGINX_CONF#mimeType=application/json
+freemarker-generator -t examples/data/template/ -PNGINX_HOSTNAME=www.mydomain.com -m env:///NGINX_CONF#mimeType=application/json
# == application.properties ==================================================
server.name=www.mydomain.com
server.logs=/var/log/nginx
diff --git a/freemarker-generator-cli/src/site/markdown/index.md b/freemarker-generator-cli/src/site/markdown/index.md
index a3ecefa..0bef5c0 100644
--- a/freemarker-generator-cli/src/site/markdown/index.md
+++ b/freemarker-generator-cli/src/site/markdown/index.md
@@ -1,6 +1,6 @@
-## FreeMarker Generator CLI
+## FreeMarker Generator
-`Apache FreeMarker CLI` is a command-line interface for [Apache FreeMarker](https://freemarker.apache.org/)
+`Apache FreeMarker Generator` is a command-line interface for [Apache FreeMarker](https://freemarker.apache.org/)
* Requires JDK 1.8+ on Linux, Mac OSX and Windows
* Use stdin, files and URLs to load data and templates
diff --git a/freemarker-generator-tools/src/site/markdown/index.md b/freemarker-generator-tools/src/site/markdown/index.md
index 19d0bb2..62fe847 100644
--- a/freemarker-generator-tools/src/site/markdown/index.md
+++ b/freemarker-generator-tools/src/site/markdown/index.md
@@ -1,12 +1,12 @@
-# Apache FreeMarker CLI Tools
+# Apache FreeMarker Generator Tools
## Overview
-The implementation of the `Apache FreeMarker CLI Tools` was inspired by [Apache Velocity Tools](https://velocity.apache.org/tools/devel/) - a `tool` is just a POJO (plain old Java object) that is "useful" in a template and is not meant to be rendered in the output.
+The implementation of the `Apache FreeMarker Generator Tools` was inspired by [Apache Velocity Tools](https://velocity.apache.org/tools/devel/) - a `tool` is just a POJO (plain old Java object) that is "useful" in a template and is not meant to be rendered in the output.
-Let's have a look at the anatomy and life-cycle of a `Apache FreeMarker CLI Tool`
+Let's have a look at the anatomy and life-cycle of a `Apache FreeMarker Generator Tool`
-* The meta-data, e.g. class name, is read from `freemarker-cli.properties`
+* The meta-data, e.g. class name, is read from `freemarker-generator.properties`
* It provides a default constructor
* Its `toString` methods prints a short description
* It exposes public methods being used directly by the template