Weaver Forge - A Jinja-based Doc/Code Generation Engine

Introduction

Weaver Forge is a component of OTEL Weaver that facilitates documentation and code generation from a semantic convention registry. It uses MiniJinja, a template engine compatible with Jinja2 syntax, which provides extensive customization options (refer to this GitHub repository for more details). To streamline template creation for semantic conventions, additional filters, functions, tests, and naming conventions have been integrated with the standard Jinja logic.

Weaver Forge also incorporates a YAML/JSON processor compatible with JQ to preprocess resolved registries before they are processed by Jinja templates. This integration helps avoid complex logic within the templates. A set of specialized JQ filters is available to extract and organize attributes and metrics, making them directly usable by the templates. This allows template authors to focus on rendering rather than filtering, transforming, or ordering logic in Jinja.

The following diagram illustrates the documentation and code generation pipeline using the OTEL Weaver tool:

Weaver's resolution process simplifies the semantic conventions by eliminating references, extend statements, and other complex constructs, creating a fully resolved, easy-to-use, self-contained version of the registry. This resolved registry can be optionally filtered, grouped, sorted, and processed using a JQ-based transformation before being used by the Jinja-based template engine for documentation and code generation. Additionally, a set of templates and a configuration file, stored alongside these templates, are processed by the template engine to generate the desired artifacts.

General Concepts

Template Directory Structure and Naming Conventions

By default, Weaver looks for a directory named templates/, which contains several collection of templates, also referred to as targets (e.g. go, html, markdown, rust, ...). The hierarchical structure of the templates directory is detailed below. Note that this location can be changed using the -t or --templates CLI parameter.

templates/
  registry/
    go/
      ...
    html/
      ...
    markdown/
      ...
    rust/
      ...
    .../

In this example, all templates for the go target are located in templates/registry/go, and all templates for the rust target are in templates/registry/rust. Similarly, other targets such as html have their respective templates in designated folders. These targets (go, html, and rust) are used for code and documentation generation via the weaver registry generate <target> command. For instance, running weaver registry generate rust will generate Rust files based on the templates in templates/registry/rust. The intermediary registry directory groups targets that convert a semantic convention registry into generated artifacts. In a future version of Weaver, a new class of targets will be introduced to generate artifacts from application telemetry schemas (templates/schema/<target>).

Configuration File - `weaver.yaml`

Weaver searches for a weaver.yaml file in the templates/registry/<target> directory. This file guides Weaver on which Jinja templates to use, the context to provide during evaluation, and how to apply them. The template input can be applied to the entire document with application_mode set to single, or to each part of the document (if it is an array of objects) with application_mode set to multiple. The file also configures filters (e.g., map_text or acronym filters), controls whitespace handling, and includes other configurations detailed in the in-depth section. The complete syntax for this configuration file is described here.

Weaver supports sharing common configuration parts through an overriding mechanism, loading configuration files in this order:

$HOME/.weaver/weaver.yaml
/weaver.yaml and any intermediate directories containing a weaver.yaml file up to the templates/registry/<target> directory.
templates/registry/<target>/weaver.yaml

Each subsequent configuration file overrides the previous ones, up to the weaver.yaml in the home directory (if it exists). To define your own configuration file list, use the --config CLI parameter.

A common use of this configuration hierarchy is to share configuration segments across multiple targets.

JQ Filters

JQ filters are a powerful tool integrated into Weaver to preprocess the data before it is passed to the templates. Each template in the templates/registry/<target> directory can be associated with a JQ filter, defined in the weaver.yaml configuration file. These filters are applied to the resolved semantic convention registry, allowing you to transform and manipulate the data as needed before to being processed in the template.

For example, you can group attributes by root namespace or filter out specific stability levels. This preprocessing ensures that the data is in the correct format and structure when it is accessed within the corresponding Jinja templates.

In the following example, the attributes.j2 template is associated with the semconv_grouped_attributes JQ filter. This filter is applied to each object selected by the JQ filter before being delivered to the template. semconv_grouped_attributes returns an array of objects containing the attributes grouped by root namespace. The application_mode is set to each so that the template is applied to each object in the array, i.e., to each group of attributes for a given root namespace.

templates:
  - template: "attributes.j2"             # glob patterns are supported
    filter: semconv_grouped_attributes
    application_mode: each
  - ...

More details here.

Global Variables

All templates have access to the following global variables:

ctx: The context object that contains the resolved registry or the output of the JQ filter if defined in the weaver.yaml configuration file.
params: The parameters defined in the weaver.yaml configuration file or overridden by the command line --param, -D, or --params arguments.
template: An object exposing various helper functions such as the set_file_name method to redefine the name of the file that will be produced from the template.

Step-by-Step Guide

Step 1: Setting Up Your Template Directory

Create the directory for your target language:

mkdir -p templates/registry/rust

In this guide, we will use the Rust target as an example.

Step 2: Creating and Configuring `weaver.yaml`

Create a weaver.yaml file in the target directory:

text_maps:
  rust_types:
    int: i64
    double: f64
    boolean: bool
    string: String
    string[]: Vec<String>
    template[string]: String
    template[string[]]: Vec<String>

params:
  incubating: true
  # ...

# Jinja Engine Whitespace Control Settings
# With both trim_blocks and lstrip_blocks enabled, you can put block tags on
# their own lines, and the entire block line will be removed when rendered, 
# preserving the whitespace of the contents.
whitespace_control:
  trim_blocks: true
  lstrip_blocks: true

templates:
  - template: "attributes.md.j2"
    filter: semconv_grouped_attributes
    application_mode: each
    file_name: "attributes/{{ctx.root_namespace}}.md"
  # ...

In this configuration, we define a set of text maps that map semantic convention types to Rust types. We also define a set of parameters that can be used in the templates.

More details on the structure of the configuration file here.

Define templates and JQ filters in your weaver.yaml file:

# ...

templates:
  - template: "attributes.md.j2"
    filter: semconv_grouped_attributes
    application_mode: each
    file_name: "attributes/{{ctx.root_namespace | snake_case}}.md"
  - template: "metrics.md.j2"
    filter: semconv_grouped_metrics
    application_mode: each
    file_name: "metrics/{{ctx.root_namespace | snake_case}}.md"
# ...

In this example, the attributes.md.j2 template is feed with the output of the semconv_grouped_attributes and metrics.md.j2 with the output of the semconv_grouped_metrics JQ filter.

The file_name is an optional field that allows you to define the name of the file generated from the evaluation of the provided Jinja expression. A Jinja expression can be a standard string or a more complex expression using the global variables ctx and params. If not defined, the file will be named after the template file name without the .j2 extension.

More details on the JQ syntax and custom semconv filters here.

Step 3: Writing Your First Template

Create a template file attributes.md.j2 in the appropriate directory:

The file generated from the evaluation of this template will be named attributes/<root_namespace>.md.

...
a valid jinja template
...

or if you want to programmatically generate a file name directly from the template:

{%- set file_name = ctx.root_namespace | snake_case -%}
{{- template.set_file_name("attributes/" ~ file_name ~ ".md") -}}
...
a valid jinja template
...

The first two lines (optional) specify the name of the file generated from the evaluation of the current template and the inputs provided by Weaver. In this specific example, an object containing a root_namespace and an array of attributes.

Use Jinja syntax to define the content and structure of the generated files.

Most of the Jinja syntax is supported, as well as a set of common Python functions and custom filters, function, and tests. See the section In-Depth Features for more explanations.

Use predefined Jinja filters to format and transform data within templates:

{{ attribute.name | snake_case }}

Access global variables and parameters in your templates:

{% if params.incubating %}
... generate incubating code ...
{% endif %}

Use custom Jinja tests to apply logic based on data attributes:

{% if attribute is experimental %}
... generate experimental attribute documentation ...
{% endif %}

In-Depth Features

JQ Filters Reference

JQ filters allow template authors to manipulate the data before it is passed to the templates. The filters can be defined in the weaver.yaml configuration file and are applied to the resolved semantic convention registry.

Example configuration for JQ filters in weaver.yaml:

templates:
  - template: "attributes.j2"
    filter: semconv_grouped_attributes
    application_mode: each
  - template: "metrics.j2"
    filter: semconv_grouped_metrics
    application_mode: each
  # ...

In this example, the attributes.j2 and metrics.j2 templates are associated with the
semconv_grouped_attributes and semconv_grouped_metrics JQ filters respectively. These
filters are applied to each object selected by the JQ filter before being delivered to the
template. semconv_grouped_attributes returns an array of objects containing the attributes
grouped by root namespace. The application_mode is set to each so that the template is
applied to each object in the array, i.e., to each group of attributes for a given root namespace.

A series of JQ filters dedicated to the manipulation of semantic conventions registries is
available to template authors.

Process Registry Attributes

The following JQ filter extracts the registry attributes from the resolved registry and
returns a list of registry attributes grouped by root namespace and sorted by attribute names.

templates:
  - template: attributes.j2
    filter: semconv_grouped_attributes
    application_mode: each

The output of the JQ filter has the following structure:

[
  {
    "root_namespace": "user_agent",
    "attributes": [
      {
        "brief": "Value of the HTTP User-Agent",
        "examples": [
          ...
        ],
        "name": "user_agent.original",
        "namespace": "user_agent",
        "requirement_level": "recommended",
        "stability": "stable",
        "type": "string",
        // ... other fields
      },
      // ... other attributes in the same root namespace
    ]
  },
  // ... other root namespaces
]

The semconv_grouped_attributes function also supports options to exclude specified root namespaces, specific stability levels, and deprecated entities. The following syntax is supported:

templates:
  - template: attributes.j2
    filter: >
      semconv_grouped_attributes({
        "exclude_root_namespace": ["url", "network"], 
        "exclude_stability": ["experimental"],
        "exclude_deprecated": true
      })
    application_mode: each

The structure of the output of semconv_grouped_attributes with these options is exactly the
same as without the options. The JSON object passed as a parameter describes a series of
options that can easily be extended if needed. Each of these options is optional.

Technically, the semconv_grouped_attributes function is a combination of two semconv
JQ functions:

def semconv_grouped_attributes($options):
    semconv_attributes($options)
    | semconv_group_attributes_by_root_namespace;

def semconv_grouped_attributes: semconv_grouped_attributes({});

The semconv_attributes function extracts the registry attributes and applies the given options.
The semconv_group_attributes_by_root_namespace function groups the attributes by root namespace. It's
possible to combine these two functions with your own JQ filters if needed.

Process Metrics

The following JQ filter extracts the metrics from the resolved registry, sorted by group
root namespace and sorted by metric names.

templates:
  - template: metrics.j2
    filter: semconv_grouped_metrics
    application_mode: each

The output of the JQ filter has the following structure:

[
  {
    "root_namespace": "jvm",
    "metrics": [
      {
        "attributes": [
          ...
        ],
        "brief": "Recent CPU utilization for the process as reported by the JVM.",
        "id": "metric.jvm.cpu.recent_utilization",
        "instrument": "gauge",
        "metric_name": "jvm.cpu.recent_utilization",
        "root_namespace": "jvm",
        "note": "The value range is [0.0,1.0]. ...",
        "stability": "stable",
        "type": "metric",
        "unit": "1",
        // ... other fields
      },
      // ... other metrics in the same root namespace
    ]
  },
  // ... other root namespaces
]

The same options are supported by semconv_grouped_metrics, as shown in the following example:

templates:
  - template: metrics.j2
    filter: >
      semconv_grouped_metrics({
        "exclude_root_namespace": ["url", "network"], 
        "exclude_stability": ["experimental"],
        "exclude_deprecated": true
      })
    application_mode: each

All the semconv_grouped_<...> functions are the composition of two functions:
semconv_<...> and semconv_group_<...>_by_root_namespace.

Note: JQ is a language for querying and transforming structured data. For more
information, see JQ Manual. The
integration into Weaver is done through the Rust library jaq, which is a
reimplementation of JQ in Rust. Most JQ filters are supported. For more
information, see jaq GitHub repository.

Jinja Filters Reference

All the filters available in the MiniJinja template engine are available (see
this online documentation) and the py_compat compatibility extensions that are also enabled in Weaver.

In addition, OTel Weaver provides a set of custom filters to facilitate the
generation of documentation and code.

The following filters are available:

lower_case: Converts a string to lowercase.
upper_case: Converts a string to UPPERCASE.
title_case: Converts a string to TitleCase.
pascal_case: Converts a string to PascalCase.
camel_case: Converts a string to camelCase.
snake_case: Converts a string to snake_case.
screaming_snake_case: Converts a string to SCREAMING_SNAKE_CASE.
kebab_case: Converts a string to kebab-case.
screaming_kebab_case: Converts a string to SCREAMING-KEBAB-CASE.
capitalize_first: Capitalizes the first letter of a string.
kebab_case_const: Generates kebab-case constants which follow semantic convention namespacing rules (underscores are ignored, but . is meaningful).
pascal_case_const: Generates PascalCase constants which follow semantic convention namespacing rules (underscores are ignored, but . is meaningful).
camel_case_const: Generates camelCase constants which follow semantic convention namespacing rules (underscores are ignored, but . is meaningful).
snake_case_const: Generates snake_case constants which follow semantic convention namespacing rules (underscores are ignored, but . is meaningful).
screaming_snake_case_const: Generates SCREAMING_SNAKE_CASE constants which follow semantic convention namespacing rules (underscores are ignored, but . is meaningful).
acronym: Replaces acronyms in the input string with the full name defined in the acronyms section of the weaver.yaml configuration file.
split_id: Splits a string by '.' creating a list of nested ids.
regex_replace: Replace all occurrences of a regex pattern (1st parameter) in the input string with the replacement string (2nd parameter). Under the hood, this filter uses the regex crate (see regex for more details)
comment_with_prefix(prefix): Outputs a multiline comment with the given prefix. This filter is deprecated, please use the more general comment filter.
comment: A generic comment formatter that uses the comment_formats section of the weaver.yaml configuration file (more details here).
flatten: Converts a List of Lists into a single list with all elements.
e.g. [[a,b],[c]] => [a,b,c]
attribute_sort: Sorts a list of Attributes by requirement level, then name.
metric_namespace: Converts registry.{namespace}.{other}.{components} to {namespace}.
attribute_registry_file: Converts registry.{namespace}.{other}.{components} to attributes-registry/{namespace}.md ( kebab-case namespace).
attribute_registry_title: Converts registry.{namespace}.{other}.{components} to {Namespace} (title case the namespace).
attribute_registry_namespace: Converts metric.{namespace}.{other}.{components} to {namespace}.
attribute_namespace: Converts {namespace}.{attribute_id} to {namespace}.
required: Filters a list of Attributes to include only the required attributes. The "conditionally_required" attributes are not returned by this filter.
not_required: Filters a list of Attributes to only include non-required attributes. The "conditionally_required" attributes are returned by this filter.
instantiated_type: Filters a type to return the instantiated type.
enum_type: Filters a type to return the enum type or an error if the type is not an enum.
markdown_to_html: Converts a markdown string to an HTML string.
map_text: Converts an input into a string based on the text_maps section of the weaver.yaml configuration file
and a named text_map. The first parameter is the name of the text_map (required). The second parameter is the default
value if the name of the text map or the input are not found in the text_maps section (optional).
ansi_black: Format a text using the black ansi code.
ansi_red: Format a text using the red ansi code.
ansi_green: Format a text using the green ansi code.
ansi_yellow: Format a text using the yellow ansi code.
ansi_blue: Format a text using the blue ansi code.
ansi_magenta: Format a text using the magenta ansi code.
ansi_cyan: Format a text using the cyan ansi code.
ansi_white: Format a text using the white ansi code.
ansi_bright_black: Format a text using the bright black ansi code.
ansi_bright_red: Format a text using the bright red ansi code.
ansi_bright_green: Format a text using the bright green ansi code.
ansi_bright_yellow: Format a text using the bright yellow ansi code.
ansi_bright_blue: Format a text using the bright blue ansi code.
ansi_bright_magenta: Format a text using the bright magenta ansi code.
ansi_bright_cyan: Format a text using the bright cyan ansi code.
ansi_bright_white: Format a text using the bright white ansi code.
ansi_bg_black: Format a text using the black background ansi code.
ansi_bg_red: Format a text using the red background ansi code.
ansi_bg_green: Format a text using the green background ansi code.
ansi_bg_yellow: Format a text using the yellow background ansi code.
ansi_bg_blue: Format a text using the blue background ansi code.
ansi_bg_magenta: Format a text using the magenta background ansi code.
ansi_bg_cyan: Format a text using the cyan background ansi code.
ansi_bg_white: Format a text using the white background ansi code.
ansi_bg_bright_black: Format a text using the bright black background ansi code.
ansi_bg_bright_red: Format a text using the bright red background ansi code.
ansi_bg_bright_green: Format a text using the bright green background ansi code.
ansi_bg_bright_yellow: Format a text using the bright yellow background ansi code.
ansi_bg_bright_blue: Format a text using the bright blue background ansi code.
ansi_bg_bright_magenta: Format a text using the bright magenta background ansi code.
ansi_bg_bright_cyan: Format a text using the bright cyan background ansi code.
ansi_bg_bright_white: Format a text using the bright white background ansi code.
ansi_bold: Format a text using the bold ansi code.
ansi_italic: Format a text using the italic ansi code.
ansi_underline: Format a text using the underline ansi code.
ansi_strikethrough: Format a text using the strikethrough ansi code.
print_value: Filter returning a quoted and escaped string representation of the input if the input is of type string (JSON escape rules are used). Numbers and booleans are stringified without the quotes, and an empty string is returned for other types.
body_fields: A filter that returns a list of triples (path, field, depth) from a body field in depth-first order. This filter can be used to iterate over a tree of fields in a body. The parameter sort_by can be used to sort the fields by the given key (by default, the fields at each level are sorted by their IDs).

Example of usage:
```
{% for path, field, depth in body|body_fields %}
Do something with {{ field }} at depth {{ depth }} with path {{ path }}
{% endfor %}

{% for path, field, depth in body|body_fields(sort_by=`type`) %}
Do something with {{ field }} at depth {{ depth }} with path {{ path }}
{% endfor %}
```

Please open an issue if you have any suggestions for new filters. They are easy to implement.

Comment Filter

The comment filter is a flexible and powerful tool designed to format comments in a consistent way across various templates. It leverages the comment_formats section in the weaver.yaml configuration file to define the formatting rules. Currently, the filter supports two primary formats: markdown and html, each with specific configuration options.

The comment_formats section in weaver.yaml allows you to define the behavior of the comment filter. This section is optional and highly customizable. Below is a general configuration template:

# weaver.yaml
...
comment_formats:           # optional
  <format-name>:
    format: markdown|html

    # Common fields for both markdown and html formats
    header: <string>                  # The comment header line (e.g., `/**`)
    prefix: <string>                  # The comment line prefix (e.g., ` * `)
    footer: <string>                  # The comment line footer (e.g., ` */`)
    indent_type: space | tab          # The type of indentation (default: space)
    trim: <bool>                      # Flag to trim the comment content (default: true). 
    remove_trailing_dots: <bool>      # Flag to remove trailing dots from the comment content (default: false).
    enforce_trailing_dots: <bool>     # Flag to enforce trailing dots for the comment content (default: false).

    # Fields specific to 'markdown' format
    escape_backslashes: <bool>            # Whether to escape backslashes in markdown (default: false).
    escape_square_brackets: <bool>        # Whether to escape square brackets in markdown (default: false).
    shortcut_reference_links: <bool>      # Convert inlined links into shortcut reference links (default: false).
    indent_first_level_list_items: <bool> # Indent the first level of list items in markdown (default: false).
    default_block_code_language: <string> # Default language for block code snippets (default: "").
    
    # Fields specific to 'html' format
    old_style_paragraph: <bool>       # Use old-style HTML paragraphs (default: false).
    omit_closing_li: <bool>           # Omit closing </li> tags in lists (default: false).
    inline_code_snippet: <jinja-expr> # Jinja expression to render inline code (default: "<c>{{code}}</c>").
    block_code_snippet: <jinja-expr>  # Jinja expression to render block code (default: "<pre>\n{{code}}\n</pre>").
  <other-format-name>:
    ...
default_comment_format: <format-name>
...

Here’s an example configuration for generating comments in Java:

# Example of configuration for Java
comment_formats:
  javadoc:
    format: html
    header: "/**"
    prefix: " * "
    footer: " */"
    old_style_paragraph: true
    omit_closing_li: false
    inline_code_snippet: "{@code {{code}}}"
    block_code_snippet: "<pre>{@code {{code}}}</pre>"
    trim: true
    remove_trailing_dots: true
  java:
    format: html
    prefix: "// "
    old_style_paragraph: true
    omit_closing_li: false
    inline_code_snippet: "{@code {{code}}}"
    block_code_snippet: "<pre>{@code {{code}}}</pre>"
    trim: true
    remove_trailing_dots: true
default_comment_format: javadoc

To generate a comment using the comment filter, simply pass the content through the filter with the desired configuration. For example:

{{ attr.note | comment(indent=2) }}

This will produce a formatted comment based on the javadoc configuration from the example above.

Note: If the input is undefined, the filter will not fail and will produce no output.

The input of the comment filter can also be a sequence.

{{ [attr.brief, "\n", attr.note] | comment(indent=2) }}

This will produce a formatted comment with the brief and note fields separated by a newline. If the note field is not defined, the comment will contain only the formatted brief field.

Given the following semconv attribute definition:

id: attr
stability: stable
brief: >
  This is a brief description of the attribute + a short link [OTEL](https://www.opentelemetry.com).
type: int
note: |
  This is a note about the attribute `attr`. It can be multiline.
  
  It can contain a list:
  * item **1**,
  * lorem ipsum dolor sit amet, consectetur
    adipiscing elit sed do eiusmod tempor
    [incididunt](https://www.loremipsum.com) ut labore et dolore magna aliqua.
  * item 2
  * lorem ipsum dolor sit amet, consectetur
    adipiscing elit sed do eiusmod tempor
  incididunt ut labore et dolore magna aliqua.
  
  And an **inline code snippet**: `Attr.attr`.
  
  # Summary
  
  ## Examples
  1. Example 1
  1. [Example](https://loremipsum.com) with lorem ipsum dolor sit amet, consectetur adipiscing elit
     [sed](https://loremipsum.com) do eiusmod tempor incididunt ut
  [labore](https://loremipsum.com) et dolore magna aliqua.
  1. Example 3      
  
  ## Appendix
    * [Link 1](https://www.link1.com)
    * [Link 2](https://www.link2.com)
    * A very long item in the list with lorem ipsum dolor sit amet, consectetur adipiscing elit sed do eiusmod
      tempor incididunt ut labore et dolore magna aliqua.
  
  > This is a blockquote.
  It can contain multiple lines.
  > Lorem ipsum dolor sit amet, consectetur adipiscing 
  > elit sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
  
  > [!NOTE] Something very important here

The following weaver.yaml configuration:

comment_formats:
  javadoc:
    format: html
    header: "/**"
    prefix: " * "
    footer: " */"
    old_style_paragraph: true
    omit_closing_li: true
    inline_code_snippet: "{@code {{code}}}"
    block_code_snippet: "<pre>{@code {{code}}}</pre>"
    trim: true
    remove_trailing_dots: true
  go:
    format: markdown
    prefix: "// "
    indent_first_level_list_items: true
    shortcut_reference_link: true
    trim: true
    remove_trailing_dots: true
default_comment_format: javadoc

The following Jinja template:

{{ [attr.brief], "\n", [attr.note] | comment(indent=2) }}

The resulting comment in JavaDoc format would be:

  /**
   * This is a brief description of the attribute + a short link <a href="https://www.opentelemetry.com">OTEL</a>.
   * <p>
   * This is a note about the attribute {@code attr}. It can be multiline.
   * <p>
   * It can contain a list:
   * <p>
   * <ul>
   *   <li>item <strong>1</strong>,
   *   <li>lorem ipsum dolor sit amet, consectetur
   * adipiscing elit sed do eiusmod tempor
   * <a href="https://www.loremipsum.com">incididunt</a> ut labore et dolore magna aliqua.
   *   <li>item 2
   *   <li>lorem ipsum dolor sit amet, consectetur
   * adipiscing elit sed do eiusmod tempor
   * incididunt ut labore et dolore magna aliqua.
   * </ul>
   * And an <strong>inline code snippet</strong>: {@code Attr.attr}.
   * <p>
   * <h1>Summary</h1>
   * <h2>Examples</h2>
   * <ol>
   *   <li>Example 1
   *   <li><a href="https://loremipsum.com">Example</a> with lorem ipsum dolor sit amet, consectetur adipiscing elit
   * <a href="https://loremipsum.com">sed</a> do eiusmod tempor incididunt ut
   * <a href="https://loremipsum.com">labore</a> et dolore magna aliqua.
   *   <li>Example 3
   * </ol>
   * <h2>Appendix</h2>
   * <ul>
   *   <li><a href="https://www.link1.com">Link 1</a>
   *   <li><a href="https://www.link2.com">Link 2</a>
   *   <li>A very long item in the list with lorem ipsum dolor sit amet, consectetur adipiscing elit sed do eiusmod
   * tempor incididunt ut labore et dolore magna aliqua.
   * </ul>
   * <blockquote>
   * This is a blockquote.
   * It can contain multiple lines.
   * Lorem ipsum dolor sit amet, consectetur adipiscing
   * elit sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</blockquote>
   * 
   * <p>
   * <blockquote>
   * [!NOTE] Something very important here</blockquote>
   */

And if you specifies the go format in the comment filter:

{{ [attr.name | screaming_snake_case, attr.brief, "\n", attr.note] | comment(format="go", indent=2) }}

The generated Go documentation would be:

  // ATTR
  // This is a brief description of the attribute + a short link [OTEL].
  // 
  // This is a note about the attribute `attr`. It can be multiline.
  // 
  // It can contain a list:
  // 
  //   - item **1**,
  //   - lorem ipsum dolor sit amet, consectetur
  //     adipiscing elit sed do eiusmod tempor
  //     [incididunt] ut labore et dolore magna aliqua.
  //   - item 2
  //   - lorem ipsum dolor sit amet, consectetur
  //     adipiscing elit sed do eiusmod tempor
  //     incididunt ut labore et dolore magna aliqua.
  // 
  // And an **inline code snippet**: `Attr.attr`.
  // 
  // # Summary
  // 
  // ## Examples
  // 
  //   1. Example 1
  //   2. [Example] with lorem ipsum dolor sit amet, consectetur adipiscing elit
  //      [sed] do eiusmod tempor incididunt ut
  //      [labore] et dolore magna aliqua.
  //   3. Example 3
  // 
  // ## Appendix
  // 
  //   - [Link 1]
  //   - [Link 2]
  //   - A very long item in the list with lorem ipsum dolor sit amet, consectetur adipiscing elit sed do eiusmod
  //     tempor incididunt ut labore et dolore magna aliqua.
  // 
  // > This is a blockquote.
  // > It can contain multiple lines.
  // > Lorem ipsum dolor sit amet, consectetur adipiscing
  // > elit sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
  // 
  // > [!NOTE] Something very important here
  // 
  // [OTEL]: https://www.opentelemetry.com
  // [incididunt]: https://www.loremipsum.com
  // [Example]: https://loremipsum.com
  // [sed]: https://loremipsum.com
  // [labore]: https://loremipsum.com
  // [Link 1]: https://www.link1.com
  // [Link 2]: https://www.link2.com

The comment filter accepts the following optional parameters:

format: A valid ID from the comment_formats configuration map.
header: A custom header for the comment block.
prefix: A custom prefix for each comment line.
footer: A custom footer for the comment block.
indent: Number of spaces to add before each comment line for indentation purposes.
indent_type: The type of indentation to use. Supported values are space (default) and tab.

Please open an issue if you have any suggestions for new formats or features.

Jinja Functions Reference

All the functions available in the MiniJinja template engine are available (see
this online documentation).

In addition, OTel Weaver provides the following custom function:

concat_if: Concatenates two or more values (after converting them to strings) if all these values are defined. If any of the values are undefined, the function returns an "undefined" value. This function can be used, for example, to define complex multi-section comments. It can accept any number of arguments. The following Jinja expression creates a comment with a brief description and an optional note prefixed with "Notes: ". If the attribute note is not defined then the comment will only contain the brief description without the prefix "Notes: ".

{{ [attr.brief, concat_if("\n\nNotes: ", attr.note)] | comment }}

Jinja Tests Reference

All the tests available in the MiniJinja template engine are available (see
this online documentation).

In addition, OTel Weaver provides a set of custom tests to facilitate the
generation of assets.

stable: Tests if an Attribute is stable.
experimental: Tests if an Attribute is experimental.
deprecated: Tests if an Attribute is deprecated.
enum: Tests if an attribute has an enum type.
simple_type: Tests if a type is a simple type (i.e.: string | string[] | int | int[] | double | double[] | boolean | boolean[]).
template_type: Tests if a type is a template type (i.e.: template[]).
enum_type: Tests if a type is an enum type.

Please open an issue if you have any suggestions for new tests. They are easy to implement.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

Weaver Forge - A Jinja-based Doc/Code Generation Engine

Table of Contents

Introduction

General Concepts

Template Directory Structure and Naming Conventions

Configuration File - `weaver.yaml`

JQ Filters

Global Variables

Step-by-Step Guide

Step 1: Setting Up Your Template Directory

Step 2: Creating and Configuring `weaver.yaml`

Step 3: Writing Your First Template

In-Depth Features

JQ Filters Reference

Jinja Filters Reference

Comment Filter

Jinja Functions Reference

Jinja Tests Reference

Files

README.md

Latest commit

History

README.md

File metadata and controls

Weaver Forge - A Jinja-based Doc/Code Generation Engine

Table of Contents

Introduction

General Concepts

Template Directory Structure and Naming Conventions

Configuration File - weaver.yaml

JQ Filters

Global Variables

Step-by-Step Guide

Step 1: Setting Up Your Template Directory

Step 2: Creating and Configuring weaver.yaml

Step 3: Writing Your First Template

In-Depth Features

JQ Filters Reference

Jinja Filters Reference

Comment Filter

Jinja Functions Reference

Jinja Tests Reference

Configuration File - `weaver.yaml`

Step 2: Creating and Configuring `weaver.yaml`