feat: add descriptions to schema output

This commit is contained in:
Jurgen Beliën 2021-12-09 18:27:55 +01:00
parent aae6306a5a
commit 9f388bf182
5 changed files with 14 additions and 0 deletions

View File

@ -32,6 +32,7 @@ const handlebarsPlugin = () => ({
preventIndent: true,
knownHelpersOnly: true,
knownHelpers: {
escapeQuotes: true,
equals: true,
notEquals: true,
containsSpaces: true,

View File

@ -1,5 +1,8 @@
{
type: '{{export}}',
{{#if description}}
description: '{{{escapeQuotes description}}}',
{{/if}}
contains: [{{#each properties}}{{>schema}}{{#unless @last}}, {{/unless}}{{/each}}],
{{#if isReadOnly}}
isReadOnly: {{{isReadOnly}}},

View File

@ -2,6 +2,9 @@
{{#if type}}
type: '{{{base}}}',
{{/if}}
{{#if description}}
description: '{{{escapeQuotes description}}}',
{{/if}}
{{#if isReadOnly}}
isReadOnly: {{{isReadOnly}}},
{{/if}}

View File

@ -1,4 +1,7 @@
{
{{#if description}}
description: '{{{escapeQuotes description}}}',
{{/if}}
properties: {
{{#if properties}}
{{#each properties}}

View File

@ -10,6 +10,10 @@ export function registerHandlebarHelpers(root: {
useOptions: boolean;
useUnionTypes: boolean;
}): void {
Handlebars.registerHelper('escapeQuotes', function (value: string): string {
return value.replace(/(['"])/g, '\\$1');
});
Handlebars.registerHelper(
'equals',
function (this: any, a: string, b: string, options: Handlebars.HelperOptions): string {