technicalguru / template-machine Goto Github PK

View Code? Open in Web Editor NEW

0.0 0.0 0.0 112 KB

Generate files based on directory-structured templates (supporting i18n and defaults with overriding)

License: Other

Java 95.93% Shell 0.53% Batchfile 0.72% FreeMarker 2.82%

freemarker freemarker-template java template-project templates templating

template-machine's Introduction

technicalguru.github.io

GitHub pages

template-machine's People

Contributors

Watchers

template-machine's Issues

Quoted Printable Plugin generates wrong strings

The replacement of underscores seems to be disturbing in process

Allow localization config per directory

Add a scheme to have different or adjusted localization (languages and language codes) per directory.

Document template configuration

Make special directories configurable

Make template and localization directories configurable. Defaults would be:

templateDir=__templates
localizationDir=__localization

Generator does not explicitely close the FileWriter

Tests revealed that written files cannot be closed. This was because the FileWriter was not closed after generation.

Document command line

Document how to call the program on command line

Document programmatic control

Document how to use the project in Java code

Refactor TemplateMachineConfig, GeneratorConfig and Generator to unified Context

The current design makes it difficult to enhance the configuration for all or a few sub-directories. A new context will be introduced in favour of the config objects that holds all required information for a specific generator run.

Allow a project config file

Define a default configuration file and make it available via command line

Allow configuration of localization scheme in path generation

Make the position of the language directory in output configurable, e.g.

outputScheme=<definition>

where <definition> could be:

a relative path position:
- n - the n-th position in output path
- -n - the n-th last position in output path
a class name that delivers the scheme

Default would be -1 or class templating.scheme.DefaultOutputScheme

Document language configuration

Document the configuration of languages

Batch script has issues with java executable and spaces in path name

The Java executable shall be used from JAVA_HOME if present
Spaces in paths throw errors in batch scripts

Document how localization works

Document the localization hierarchy

Javadoc warnings

build	24-Dec-2020 10:06:29	[ERROR] MavenReportException: Error while generating Javadoc: 
build	24-Dec-2020 10:06:29	Exit code: 1 - javadoc: error - The code being documented uses modules but the packages defined in https://docs.oracle.com/javase/9/docs/api/ are in the unnamed module.
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/Context.java:315: error: exception not thrown: java.io.IOException
build	24-Dec-2020 10:06:29		 * @throws IOException - when the templates cannot be read
build	24-Dec-2020 10:06:29		           ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/Generator.java:42: warning: no @param for context
build	24-Dec-2020 10:06:29		public Generator(Context context) {
build	24-Dec-2020 10:06:29		       ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/Generator.java:103: warning: no @throws for java.io.IOException
build	24-Dec-2020 10:06:29		protected void generateFile(File templateFile, String language, File outFile) throws IOException, TemplateException {
build	24-Dec-2020 10:06:29		               ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/Generator.java:103: warning: no @throws for freemarker.template.TemplateException
build	24-Dec-2020 10:06:29		protected void generateFile(File templateFile, String language, File outFile) throws IOException, TemplateException {
build	24-Dec-2020 10:06:29		               ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/TemplateMachine.java:45: warning: no @param for rootContext
build	24-Dec-2020 10:06:29		public TemplateMachine(Context rootContext) {
build	24-Dec-2020 10:06:29		       ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/TemplateMachine.java:52: warning: no @return
build	24-Dec-2020 10:06:29		public GenerationInfo generate() {
build	24-Dec-2020 10:06:29		                      ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/TemplateMachine.java:67: error: @param name not found
build	24-Dec-2020 10:06:29		 * @param parent - the parent generator to allow overriding templates and localizations
build	24-Dec-2020 10:06:29		          ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/TemplateMachine.java:68: error: @param name not found
build	24-Dec-2020 10:06:29		 * @param sourceDir    - the directory to process
build	24-Dec-2020 10:06:29		          ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/TemplateMachine.java:69: error: @param name not found
build	24-Dec-2020 10:06:29		 * @param outputDir - the output directory
build	24-Dec-2020 10:06:29		          ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/TemplateMachine.java:71: warning: no @param for context
build	24-Dec-2020 10:06:29		protected GenerationInfo generateRecursively(Context context) {
build	24-Dec-2020 10:06:29		                         ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/TemplateMachine.java:71: warning: no @return
build	24-Dec-2020 10:06:29		protected GenerationInfo generateRecursively(Context context) {
build	24-Dec-2020 10:06:29		                         ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/TemplatingException.java:23: warning: no description for @param
build	24-Dec-2020 10:06:29		 * @param message
build	24-Dec-2020 10:06:29		   ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/TemplatingException.java:31: warning: no description for @param
build	24-Dec-2020 10:06:29		 * @param cause
build	24-Dec-2020 10:06:29		   ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/TemplatingException.java:39: warning: no description for @param
build	24-Dec-2020 10:06:29		 * @param message
build	24-Dec-2020 10:06:29		   ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/TemplatingException.java:40: warning: no description for @param
build	24-Dec-2020 10:06:29		 * @param cause
build	24-Dec-2020 10:06:29		   ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/TemplatingException.java:48: warning: no description for @param
build	24-Dec-2020 10:06:29		 * @param message
build	24-Dec-2020 10:06:29		   ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/TemplatingException.java:49: warning: no description for @param
build	24-Dec-2020 10:06:29		 * @param cause
build	24-Dec-2020 10:06:29		   ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/TemplatingException.java:50: warning: no description for @param
build	24-Dec-2020 10:06:29		 * @param enableSuppression
build	24-Dec-2020 10:06:29		   ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/TemplatingException.java:51: warning: no description for @param
build	24-Dec-2020 10:06:29		 * @param writableStackTrace
build	24-Dec-2020 10:06:29		   ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/util/FileReadUtils.java:25: warning: no @throws for java.io.IOException
build	24-Dec-2020 10:06:29		public static Reader getReader(File file, String encoding) throws IOException {
build	24-Dec-2020 10:06:29		                     ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/util/FileReadUtils.java:35: warning: no @throws for java.io.IOException
build	24-Dec-2020 10:06:29		public static Reader getReader(File file, Charset encoding) throws IOException {
build	24-Dec-2020 10:06:29		                     ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/util/FileReadUtils.java:53: warning: no description for @throws
build	24-Dec-2020 10:06:29		 * @throws IOException
build	24-Dec-2020 10:06:29		   ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/util/UnicodeInputStream.java:77: warning: no @throws for java.io.IOException
build	24-Dec-2020 10:06:29		protected void init() throws IOException {
build	24-Dec-2020 10:06:29		               ^
build	24-Dec-2020 10:06:29	
build	24-Dec-2020 10:06:29	Command line was: /usr/local/jdk-9.0.4/../bin/javadoc @options @packages
build	24-Dec-2020 10:06:29	
build	24-Dec-2020 10:06:29	Refer to the generated Javadoc files in '/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/target/apidocs' dir.
build	24-Dec-2020 10:06:29	
build	24-Dec-2020 10:06:29	org.apache.maven.reporting.MavenReportException: 
build	24-Dec-2020 10:06:29	Exit code: 1 - javadoc: error - The code being documented uses modules but the packages defined in https://docs.oracle.com/javase/9/docs/api/ are in the unnamed module.
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/Context.java:315: error: exception not thrown: java.io.IOException
build	24-Dec-2020 10:06:29		 * @throws IOException - when the templates cannot be read
build	24-Dec-2020 10:06:29		           ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/Generator.java:42: warning: no @param for context
build	24-Dec-2020 10:06:29		public Generator(Context context) {
build	24-Dec-2020 10:06:29		       ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/Generator.java:103: warning: no @throws for java.io.IOException
build	24-Dec-2020 10:06:29		protected void generateFile(File templateFile, String language, File outFile) throws IOException, TemplateException {
build	24-Dec-2020 10:06:29		               ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/Generator.java:103: warning: no @throws for freemarker.template.TemplateException
build	24-Dec-2020 10:06:29		protected void generateFile(File templateFile, String language, File outFile) throws IOException, TemplateException {
build	24-Dec-2020 10:06:29		               ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/TemplateMachine.java:45: warning: no @param for rootContext
build	24-Dec-2020 10:06:29		public TemplateMachine(Context rootContext) {
build	24-Dec-2020 10:06:29		       ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/TemplateMachine.java:52: warning: no @return
build	24-Dec-2020 10:06:29		public GenerationInfo generate() {
build	24-Dec-2020 10:06:29		                      ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/TemplateMachine.java:67: error: @param name not found
build	24-Dec-2020 10:06:29		 * @param parent - the parent generator to allow overriding templates and localizations
build	24-Dec-2020 10:06:29		          ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/TemplateMachine.java:68: error: @param name not found
build	24-Dec-2020 10:06:29		 * @param sourceDir    - the directory to process
build	24-Dec-2020 10:06:29		          ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/TemplateMachine.java:69: error: @param name not found
build	24-Dec-2020 10:06:29		 * @param outputDir - the output directory
build	24-Dec-2020 10:06:29		          ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/TemplateMachine.java:71: warning: no @param for context
build	24-Dec-2020 10:06:29		protected GenerationInfo generateRecursively(Context context) {
build	24-Dec-2020 10:06:29		                         ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/TemplateMachine.java:71: warning: no @return
build	24-Dec-2020 10:06:29		protected GenerationInfo generateRecursively(Context context) {
build	24-Dec-2020 10:06:29		                         ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/TemplatingException.java:23: warning: no description for @param
build	24-Dec-2020 10:06:29		 * @param message
build	24-Dec-2020 10:06:29		   ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/TemplatingException.java:31: warning: no description for @param
build	24-Dec-2020 10:06:29		 * @param cause
build	24-Dec-2020 10:06:29		   ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/TemplatingException.java:39: warning: no description for @param
build	24-Dec-2020 10:06:29		 * @param message
build	24-Dec-2020 10:06:29		   ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/TemplatingException.java:40: warning: no description for @param
build	24-Dec-2020 10:06:29		 * @param cause
build	24-Dec-2020 10:06:29		   ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/TemplatingException.java:48: warning: no description for @param
build	24-Dec-2020 10:06:29		 * @param message
build	24-Dec-2020 10:06:29		   ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/TemplatingException.java:49: warning: no description for @param
build	24-Dec-2020 10:06:29		 * @param cause
build	24-Dec-2020 10:06:29		   ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/TemplatingException.java:50: warning: no description for @param
build	24-Dec-2020 10:06:29		 * @param enableSuppression
build	24-Dec-2020 10:06:29		   ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/TemplatingException.java:51: warning: no description for @param
build	24-Dec-2020 10:06:29		 * @param writableStackTrace
build	24-Dec-2020 10:06:29		   ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/util/FileReadUtils.java:25: warning: no @throws for java.io.IOException
build	24-Dec-2020 10:06:29		public static Reader getReader(File file, String encoding) throws IOException {
build	24-Dec-2020 10:06:29		                     ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/util/FileReadUtils.java:35: warning: no @throws for java.io.IOException
build	24-Dec-2020 10:06:29		public static Reader getReader(File file, Charset encoding) throws IOException {
build	24-Dec-2020 10:06:29		                     ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/util/FileReadUtils.java:53: warning: no description for @throws
build	24-Dec-2020 10:06:29		 * @throws IOException
build	24-Dec-2020 10:06:29		   ^
build	24-Dec-2020 10:06:29	/var/atlassian/application-data/bamboo/xml-data/build-dir/131073/OSS-TM-INSTALL/src/main/java/templating/util/UnicodeInputStream.java:77: warning: no @throws for java.io.IOException
build	24-Dec-2020 10:06:29		protected void init() throws IOException {
build	24-Dec-2020 10:06:29		               ^
build	24-Dec-2020 10:06:29

Allow language setup via configuration

The languages are currently pulled from localization directory. Allow a definition in configuration, e.g.

languages=en,de,fr,sp=es,other

which would create languages English, German, French by pulling respective files. Spanish will be defined in es.properties file but duplicated to language sp.

The keyword other would allow to auto-detect additional languages. The default setting (when setting is missing) is:

languages=auto

Document the template hierarchy

Document how templates are organized

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.