TemplateMark Transformer
Parses markdown templates (TemplateMark) into a typed DOM that captures clause/contract structure, variable references, conditionals, optionals, list iteration, joins, and embedded TypeScript formulas.
TemplateMark extends the CommonMark DOM with:
ClauseDefinition,ContractDefinitionVariableDefinition,FormattedVariableDefinition,EnumVariableDefinitionConditionalDefinition,OptionalDefinitionWithDefinition,JoinDefinition,ListBlockDefinitionFormulaDefinition
Schema: [email protected].
Installation
npm install @accordproject/markdown-template
Peer dependencies: @accordproject/concerto-core@^5.0.0 and @accordproject/concerto-cto@^5.0.0.
Usage
A template needs a Concerto model that defines the shape of the data being templated. The model must declare exactly one concept decorated with @template.
import { TemplateMarkTransformer } from '@accordproject/markdown-template';
import { ModelManager } from '@accordproject/concerto-core';
const model = `
namespace [email protected]
@template
concept Greeting {
o String name
}`;
const modelManager = new ModelManager();
modelManager.addCTOModel(model);
const transformer = new TemplateMarkTransformer();
const templateMark = transformer.fromMarkdownTemplate(
{ content: 'Hello {{name}}.' },
modelManager,
'clause'
);
The returned templateMark is a JSON document conforming to the TemplateMark schema. Pass 'contract' instead of 'clause' if the template is a contract.
In CommonJS:
const { TemplateMarkTransformer } = require('@accordproject/markdown-template');
What this package exports
TemplateMarkTransformer— markdown_template ↔ TemplateMark DOMtemplatemarkutil— lower-level helpers for tokenization and typingdatetimeutil,util— date/time and hashing utilitiesTemplateException— error type thrown for invalid templatesnormalizeNLs— normalize line endings
License
Accord Project source code files are made available under the Apache License, Version 2.0 (Apache-2.0), located in the LICENSE file. Accord Project documentation files are made available under the Creative Commons Attribution 4.0 International License (CC-BY-4.0), available at http://creativecommons.org/licenses/by/4.0/.