Skip to content

Commit 5cc4a11

Browse files
author
Kapil Borle
authored
Merge pull request #567 from PowerShell/kapilmb/AddMarkdownHelp
Integrate PlatyPS to generate MAML help
2 parents 1611784 + 854dcce commit 5cc4a11

11 files changed

+1137
-1041
lines changed

‎Engine/Microsoft.Windows.PowerShell.ScriptAnalyzer.dll-Help.xml

Lines changed: 0 additions & 998 deletions
This file was deleted.

‎Engine/ScriptAnalyzerEngine.csproj

Lines changed: 16 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -119,16 +119,12 @@
119119
<LastGenOutput>Strings.Designer.cs</LastGenOutput>
120120
</EmbeddedResource>
121121
</ItemGroup>
122-
<ItemGroup>
123-
<Content Include="about_PSScriptAnalyzer.help.txt" />
124-
</ItemGroup>
125122
<Import Project="$(MSBuildToolsPath)\Microsoft.CSHARP.Targets" />
126123
<ProjectExtensions>
127124
<VisualStudio AllowExistingFolder="true" />
128125
</ProjectExtensions>
129126
<PropertyGroup>
130-
<PostBuildEvent>
131-
if "PSV3 Release" == "$(ConfigurationName)" (
127+
<PostBuildEvent>if "PSV3 Release" == "$(ConfigurationName)" (
132128
GOTO psv3Release
133129
) else if "PSV3 Debug" == "$(ConfigurationName)" (
134130
GOTO psv3Debug
@@ -138,34 +134,31 @@ if "PSV3 Release" == "$(ConfigurationName)" (
138134

139135
:psv3Release
140136
:psv3Debug
141-
if not exist "$(SolutionDir)$(SolutionName)\PSv3" (
142-
mkdir "$(SolutionDir)$(SolutionName)\PSv3"
137+
if not exist "$(SolutionDir)out\$(SolutionName)\PSv3" (
138+
mkdir "$(SolutionDir)out\$(SolutionName)\PSv3"
143139
)
144-
copy /y "$(TargetPath)" "$(SolutionDir)$(SolutionName)\PSv3"
140+
copy /y "$(TargetPath)" "$(SolutionDir)out\$(SolutionName)\PSv3"
145141
GOTO end
146142

147143

148144
:default
149-
if not exist "$(SolutionDir)$(SolutionName)" (
150-
mkdir "$(SolutionDir)$(SolutionName)"
145+
if not exist "$(SolutionDir)out\$(SolutionName)" (
146+
mkdir "$(SolutionDir)out\$(SolutionName)"
151147
)
152-
copy /y "$(TargetPath)" "$(SolutionDir)$(SolutionName)"
148+
copy /y "$(TargetPath)" "$(SolutionDir)out\$(SolutionName)"
153149
GOTO end
154150

155151
:end
156-
copy /y "$(ProjectDir)*.ps1xml" "$(SolutionDir)$(SolutionName)"
157-
copy /y "$(ProjectDir)*.psm1" "$(SolutionDir)$(SolutionName)"
158-
copy /y "$(ProjectDir)*.psd1" "$(SolutionDir)$(SolutionName)"
159-
if not exist "$(SolutionDir)$(SolutionName)\Settings" (
160-
mkdir "$(SolutionDir)$(SolutionName)\Settings"
152+
copy /y "$(ProjectDir)*.ps1xml" "$(SolutionDir)out\$(SolutionName)"
153+
copy /y "$(ProjectDir)*.psm1" "$(SolutionDir)out\$(SolutionName)"
154+
copy /y "$(ProjectDir)*.psd1" "$(SolutionDir)out\$(SolutionName)"
155+
if not exist "$(SolutionDir)out\$(SolutionName)\Settings" (
156+
mkdir "$(SolutionDir)out\$(SolutionName)\Settings"
161157
)
162-
copy /y "$(ProjectDir)Settings\*.psd1" "$(SolutionDir)$(SolutionName)\Settings"
163-
if not exist "$(SolutionDir)$(SolutionName)\en-US" (
164-
mkdir "$(SolutionDir)$(SolutionName)\en-US"
158+
copy /y "$(ProjectDir)Settings\*.psd1" "$(SolutionDir)out\$(SolutionName)\Settings"
159+
if not exist "$(SolutionDir)out\$(SolutionName)\en-US" (
160+
mkdir "$(SolutionDir)out\$(SolutionName)\en-US"
165161
)
166-
copy /y "$(ProjectDir)about_*.help.txt" "$(SolutionDir)$(SolutionName)\en-US"
167-
copy /y "$(ProjectDir)*Help.xml" "$(SolutionDir)$(SolutionName)\en-US"
168-
169-
</PostBuildEvent>
162+
copy /y "$(SolutionDir)docs\about_*.help.txt" "$(SolutionDir)out\$(SolutionName)\en-US"</PostBuildEvent>
170163
</PropertyGroup>
171164
</Project>

‎PSScriptAnalyzer.sln

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
Microsoft Visual Studio Solution File, Format Version 12.00
3-
# Visual Studio 2013
4-
VisualStudioVersion = 12.0.21005.1
3+
# Visual Studio 14
4+
VisualStudioVersion = 14.0.23107.0
55
MinimumVisualStudioVersion = 10.0.40219.1
66
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ScriptAnalyzerEngine", "Engine\ScriptAnalyzerEngine.csproj", "{F4BDE3D0-3EEF-4157-8A3E-722DF7ADEF60}"
77
EndProject
@@ -15,16 +15,16 @@ Global
1515
Release|Any CPU = Release|Any CPU
1616
EndGlobalSection
1717
GlobalSection(ProjectConfigurationPlatforms) = postSolution
18-
{F4BDE3D0-3EEF-4157-8A3E-722DF7ADEF60}.Debug|Any CPU.ActiveCfg = Release|Any CPU
19-
{F4BDE3D0-3EEF-4157-8A3E-722DF7ADEF60}.Debug|Any CPU.Build.0 = Release|Any CPU
18+
{F4BDE3D0-3EEF-4157-8A3E-722DF7ADEF60}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
19+
{F4BDE3D0-3EEF-4157-8A3E-722DF7ADEF60}.Debug|Any CPU.Build.0 = Debug|Any CPU
2020
{F4BDE3D0-3EEF-4157-8A3E-722DF7ADEF60}.PSV3 Debug|Any CPU.ActiveCfg = PSV3 Debug|Any CPU
2121
{F4BDE3D0-3EEF-4157-8A3E-722DF7ADEF60}.PSV3 Debug|Any CPU.Build.0 = PSV3 Debug|Any CPU
2222
{F4BDE3D0-3EEF-4157-8A3E-722DF7ADEF60}.PSV3 Release|Any CPU.ActiveCfg = PSV3 Release|Any CPU
2323
{F4BDE3D0-3EEF-4157-8A3E-722DF7ADEF60}.PSV3 Release|Any CPU.Build.0 = PSV3 Release|Any CPU
2424
{F4BDE3D0-3EEF-4157-8A3E-722DF7ADEF60}.Release|Any CPU.ActiveCfg = Release|Any CPU
2525
{F4BDE3D0-3EEF-4157-8A3E-722DF7ADEF60}.Release|Any CPU.Build.0 = Release|Any CPU
26-
{C33B6B9D-E61C-45A3-9103-895FD82A5C1E}.Debug|Any CPU.ActiveCfg = Release|Any CPU
27-
{C33B6B9D-E61C-45A3-9103-895FD82A5C1E}.Debug|Any CPU.Build.0 = Release|Any CPU
26+
{C33B6B9D-E61C-45A3-9103-895FD82A5C1E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
27+
{C33B6B9D-E61C-45A3-9103-895FD82A5C1E}.Debug|Any CPU.Build.0 = Debug|Any CPU
2828
{C33B6B9D-E61C-45A3-9103-895FD82A5C1E}.PSV3 Debug|Any CPU.ActiveCfg = PSV3 Debug|Any CPU
2929
{C33B6B9D-E61C-45A3-9103-895FD82A5C1E}.PSV3 Debug|Any CPU.Build.0 = PSV3 Debug|Any CPU
3030
{C33B6B9D-E61C-45A3-9103-895FD82A5C1E}.PSV3 Release|Any CPU.ActiveCfg = PSV3 Release|Any CPU

‎Rules/ScriptAnalyzerBuiltinRules.csproj

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -143,18 +143,18 @@ if "PSV3 Release" == "$(ConfigurationName)" (
143143

144144
:psv3Release
145145
:psv3Debug
146-
if not exist "$(SolutionDir)$(SolutionName)\PSv3" (
147-
mkdir "$(SolutionDir)$(SolutionName)\PSv3"
146+
if not exist "$(SolutionDir)out\$(SolutionName)\PSv3" (
147+
mkdir "$(SolutionDir)out\$(SolutionName)\PSv3"
148148
)
149-
copy /y "$(TargetPath)" "$(SolutionDir)$(SolutionName)\PSv3"
149+
copy /y "$(TargetPath)" "$(SolutionDir)out\$(SolutionName)\PSv3"
150150

151151
GOTO end
152152

153153
:default
154-
if not exist "$(SolutionDir)$(SolutionName)" (
155-
mkdir "$(SolutionDir)$(SolutionName)"
154+
if not exist "$(SolutionDir)out\$(SolutionName)" (
155+
mkdir "$(SolutionDir)out\$(SolutionName)"
156156
)
157-
copy /y "$(TargetPath)" "$(SolutionDir)$(SolutionName)"
157+
copy /y "$(TargetPath)" "$(SolutionDir)out\$(SolutionName)"
158158

159159
GOTO end
160160

0 commit comments

Comments
 (0)