interface TemplateData

Template data for Vento template processing

Examples

Template usage:

export const VERSION = "{{ version }}";
export const BUILD_INFO = {
  buildDate: "{{ buildDate }}",
  gitCommit: "{{ gitCommit }}",
  versionComponents: {{ versionComponents | jsonStringify }}
} as const;

{{- if metadata.endpoints }}
export const ENDPOINTS = {{ metadata.endpoints | jsonStringify }};
{{- /if }}

Properties

version: string

Version information (e.g., "1.2.3")

buildDate: string

Build date in ISO format

gitCommit: string

Git commit hash (full or short)

environment: string

Build environment (e.g., "production", "development")

Release notes following Keep a Changelog format

metadata: Record<string, unknown>

Custom metadata from configuration and data providers

project: NagareConfig["project"]

Project information from configuration

optional
versionComponents: { major: number; minor: number; patch: number; prerelease: string | null; }

Computed version components (added by TemplateProcessor)

optional
currentYear: number

Additional computed helpers (added by TemplateProcessor)

optional
buildDateFormatted: string
optional
shortCommit: string

Usage

import { type TemplateData } from ".";