Skip to content

Commit 757bb5f

Browse files
Allow New-YamlHelp to generate YAML for Common Parameters (#547)
1 parent 7da4751 commit 757bb5f

File tree

3 files changed

+15
-4
lines changed

3 files changed

+15
-4
lines changed

src/Markdown.MAML/Renderer/YamlRenderer.cs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,17 @@ public static string MamlModelToString(MamlCommand mamlCommand)
3131
Syntaxes = mamlCommand.Syntax.Select(CreateSyntax).ToList()
3232
};
3333

34+
if (mamlCommand.SupportCommonParameters)
35+
{
36+
var commonParam = new YamlParameter
37+
{
38+
Name = Markdown.MAML.Resources.MarkdownStrings.CommonParametersToken,
39+
Description = Markdown.MAML.Resources.MarkdownStrings.CommonParametersText
40+
};
41+
42+
model.OptionalParameters.Add(commonParam);
43+
}
44+
3445
using (var writer = new StringWriter())
3546
{
3647
serializer.Serialize(writer, model);

test/Markdown.MAML.Test/Renderer/YamlRendererTests.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -119,9 +119,9 @@ public void RenderProducesOptionalParameters()
119119

120120
var writtenModel = deserializer.Deserialize<YamlCommand>(output);
121121

122-
Assert.Single(writtenModel.OptionalParameters);
122+
Assert.Equal(2, writtenModel.OptionalParameters.Count);
123123

124-
var optionalParameter = writtenModel.OptionalParameters.Single();
124+
var optionalParameter = writtenModel.OptionalParameters.First();
125125
var expectedParameter = model.Parameters.Single(p => !p.Required);
126126

127127
Assert.Equal(expectedParameter.Globbing, optionalParameter.AcceptWildcardCharacters);
@@ -197,7 +197,7 @@ public void RenderProducesSyntaxes()
197197
var syntax = writtenModel.Syntaxes.Single();
198198

199199
Assert.Equal(model.Syntax.Single().ParameterSetName, syntax.ParameterValueGroup);
200-
200+
201201
Assert.Single(syntax.Parameters);
202202
Assert.Equal(model.Syntax.Single().Parameters.Single().Name, syntax.Parameters.Single());
203203
}

test/Pester/PlatyPs.Tests.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1621,7 +1621,7 @@ Describe 'New-YamlHelp' {
16211621
$yamlModel.RequiredParameters[0].Name | Should Be 'Path'
16221622
$yamlModel.RequiredParameters[1].Name | Should Be 'OutputFolder'
16231623

1624-
$yamlModel.OptionalParameters.Count | Should Be 2
1624+
$yamlModel.OptionalParameters.Count | Should Be 3
16251625

16261626
$yamlModel.OptionalParameters[0].Name | Should Be 'Encoding'
16271627
$yamlModel.OptionalParameters[1].Name | Should Be 'Force'

0 commit comments

Comments
 (0)