index.md

StringTemplate 4 Documentation

Please ask questions about StringTemplate in general on StackOverflow or in the StringTemplate-discussion list. For specific question about the TypeScript implementation of the ST library use the issue tracker or the discussions of the repository on Github.

Installation

Get the Node.js package with the usual command:

npm i stringtemplate4ts

in your project folder.

Note: This TypeScript port uses semantic versioning, independent of the original Code, and hence starts with version 1.0.0 instead of 4.3.3 (the version of Java ST4, at the time of writing this).

Introductory material

• Introduction
• StringTemplate cheat sheet
• Motivation and philosophy

Groups

• Group file syntax
• Group inheritance
• Template regions

Templates

• Literals
• Expressions
• Template includes
• Expression options
• Conditionals
• Anonymous templates
• Map operations
• Functions
• Lazy evaluation
• Missing and null attribute evaluation

Whitespace and formatting

• Auto-indentation
• Automatic line wrapping

Customizing StringTemplate behavior

• Error listeners
• Renderers
• Model adaptors

Misc

• Template to Bytecode mapping