Template

Variables

The variable interpolation is done as it is specified in the standard. The only difference is about escaping: by default no escaping is performed, but you can change this comportment with the configuration key template.escaper (see configuration).

  data:
    subject: "World"
  template: "Hello, {{subject}}!"
  result: "Hello, World!"

  data:
    person:
      name: "Joe"
  template: "Hello, {{person.name}}!"
  result: "Hello, Joe!"

Disable escaping variable with a triple braces ({{{name}}}) or with & ({{& name}}) are supported.

Sections

Sections can be used to defined a context or display something conditionally or iterate on lists, as it is specified in the standard. The tag is treated as standalone when the situation is appropriate, removing the previous white spaces and the next new line characters.

  data:
    person:
      name: "Joe"
  template: "Hello, {{#person}}{{name}}{{/person}}!"
  result: "Hello, Joe!"

  data:
    first: true
    second: false
  template: "{{#first}}This is rendered.{{/first}}{{#second}}And this is not.{{/second}}"
  result: "This is rendered."

  data:
    list:
      - item: 1
      - item: 2
      - item: 3
  template: "{{#list}}{{item}}{{/list}}"
  result: "123"

  data:
    list:
      - item: 1
      - item: 2
      - item: 3
  template: |-
    My pretty list:
      {{#list}}
      - {{item}}
      {{/list}}
  result: |-
    My pretty list:
      - 1
      - 2
      - 3

The closing tag can always be abbreviated by {{/}}:

  data:
    list:
      - item: 1
      - item: 2
      - item: 3
  template: "My inline list:{{#list}} {{item}}{{/}}"
  result: "My inline list: 1 2 3"

You can use the implicit iterator {{.}} to output the current context or the current iterated object:

  data:
    list: [ "a", "b", "c" ]
  template: "My implicit list:{{#list}} {{.}}{{/}}"
  result: "My implicit list: a b c"

During a list iteration, additional keys can be accessed:

• @first is true for the first item only.
• @last is true for the last item only.
• @index is the 0-based index of the item (0, 1, 2,…)
• @indexPlusOne is the 1-based index of the item (1, 2, 3, …)
• @indexIsEven is true if the 0-based index is even.

These keys only refers to the inner-most enclosing section.

  data:
    list: [ "a", "b", "c" ]
  template: |-
    My numeroted list:
      {{#list}}
      {{@index}}. {{item}}
      {{/list}}
  result: |-
    My numeroted list:
      1. a
      2. b
      3. c

Inverted Sections

Inverted section can be used as the standard specifies.

  data:
    first: false
    second: true
  template: "{{^first}}This is rendered.{{/first}}{{^second}}And this is not.{{/second}}"
  result: "This is rendered."

  data:
    list: []
  template: "{{^list}}The list is empty!{{/list}}"
  result: "The list is empty!"

Like sections implicit closing tag ({{/}}) can be used. An implicit inverted tag ({{^}}) can also be used to create some kind of if-then-else structure:

  data:
    list: []
  template: "My empty list:{{#list}} {{.}}{{^}} empty!{{/}}"
  result: "My empty list: empty!"

Inverted section can used with the additional keys (@first, @last and @indexIsEven):

  data:
    list: [ "a", "b", "c" ]
  template: "My glamorous list: {{#list}}{{.}}{{^@last}}, {{/}}{{/}}"
  result: "My glamorous list: a, b, c"

Comments

The template can contain some comments, which will be ignored during the rendering.

  data:
  template: "12345{{! Comment }}67890"
  result: "1234567890"

  data:
  template: |-
    Begin.
      {{!
          Comment can be multiline.
          They are also considered as standalone,
          when it is appropriate.
      }}
    End.
  result: |-
    Begin.
    End.

Partials

The engine supports partials. To define a partial, see the configuration section. Indentation are respected, as the standard specifies it.

  data:
    text: "content"
  template: ">{{>partial}}<"
  partials:
    partial: "*{{text}}*"
  result: ">*content*<"

  data:
    content: |-
      <
      ->
  template: |
    \
     {{>partial}}
    /
  partials:
    partial: |
      |
      {{{content}}}
      |
  result: |
    \
     |
     <
    ->
     |
    /

Delimiters

Tag delimiters ({{ and }}) can be redefined, as the standard specifies.

  data:
    text: "Hey!"
  template: "{{=<% %>=}}(<%text%>)"
  result: "(Hey!)"

Not implemented features

Some feature are not implemented. If they happen to be requested and necessary, they may be implemented.

• Dynamic partial names
• Partial inheritance
• Filters

Version

The data model for a version can be used to extract the different fields, according to the semver specifications.

Date

The data model for a date, with all the imaginable formatters.

Identity

An identity in the Git philosophy (a name, an email and a date).

Commit

A Git commit.

Commit Message

A Git commit message, potentially formatted with Conventional Commit with some adaptations:

• Several scopes can be defined, separated by a comma: feat(lang,doc): add Bantu language.
• Footers are defined as one key (case insensitive) and one or several values. Each value is defined on its own line, or several footers with the same key can be defined:

feat: adding best feature ever.

Refs: #123
      #456
Reviewed-by: Me
Refs: #789

In this case, the footer REFS will contains values #123, #456 and #789.

• Breaking changes are indicated by adding a bang in the first line, before the first colon, or by defining a footer BREAKING CHANGE or BREAKING-CHANGE (case insensitive). In accordance with the specification, if a bang is used and no footer BREAKING CHANGE or BREAKING-CHANGE is defined, a footer BREAKING-CHANGE is automatically created, and contains the description as value.

A footer itself have a data model:

Tag Commit

A tag commit is a special commit created as an annotation for a tag.

Release

A release is corresponds to a release of a module, which is a set of commits marked with a tag (annotated or not, but following the mandatory pattern). The most recent modifications of a module can be not associated with a tag.

Release Goal

When calling the release goal, the message of the annotated tag can be customized. Follow the configuration to knowing how to configure the template. The template can use the following data:

The default message template is Release {{artifactId}} {{version}}.

Changelog Goal

When calling the changelog goal, the template of the changes can be customized. Follow the configuration to knowing how to configure the template. The template can use the following data:

The default template is:

{{#releases}}

{{#released}}
# {{version}}{{#tagged}} ({{tag.when.ISO_LOCAL_DATE}}){{/}}
{{^}}
# Not released
{{/released}}

{{#changes}}
{{#message.conventional}}
 * [{{shortId}}] {{message.type}}{{#message.breaking}}!{{/}}: {{message.description}}
{{^}}
 * [{{shortId}}] {{message.firstLine}}
{{/}}
{{^changes}}
_No change._
{{/changes}}
{{/releases}}