Merge pull request #369 from PowerShell/AddExampleConfiguration

Quoc Truong · Quoc Truong · commit f09842a33a62 · 2015-11-24T12:30:02.000-08:00
Give profile alias configuration and provide some sample configurations
diff --git a/Engine/Commands/InvokeScriptAnalyzerCommand.cs b/Engine/Commands/InvokeScriptAnalyzerCommand.cs
@@ -159,6 +159,7 @@ public SwitchParameter SuppressedOnly
         /// <summary>
         /// Returns path to the file that contains user profile for ScriptAnalyzer
         /// </summary>
+        [Alias("Configuration")]
         [Parameter(Mandatory = false)]
         [ValidateNotNull]
         public string Profile
diff --git a/Engine/Configurations/CmdletDesign.psd1 b/Engine/Configurations/CmdletDesign.psd1
@@ -0,0 +1,10 @@
+﻿@{
+    IncludeRules=@('PSUseApprovedVerbs',
+                   'PSReservedCmdletChar',
+                   'PSReservedParams',
+                   'PSShouldProcess',
+                   'PSUseShouldProcessForStateChangingFunctions',
+                   'PSUseSingularNouns',
+                   'PSMissingModuleManifestField',
+                   'PSAvoidDefaultValueSwitchParameter')
+}
diff --git a/Engine/Configurations/DSC.psd1 b/Engine/Configurations/DSC.psd1
@@ -0,0 +1,3 @@
+﻿@{
+    IncludeRules=@('PSDSC*')
+}
diff --git a/Engine/Configurations/ScriptFunctions.psd1 b/Engine/Configurations/ScriptFunctions.psd1
@@ -0,0 +1,11 @@
+﻿@{
+    IncludeRules=@('PSAvoidUsingCmdletAliases',
+                   'PSAvoidUsingWMICmdlet',
+                   'PSAvoidUsingEmptyCatchBlock',
+                   'PSUseCmdletCorrectly',
+                   'PSUseShouldProcessForStateChangingFunctions',
+                   'PSAvoidUsingPositionalParameters',
+                   'PSAvoidGlobalVars',
+                   'PSUseDeclaredVarsMoreThanAssignments',
+                   'PSAvoidUsingInvokeExpression')
+}
diff --git a/Engine/Configurations/ScriptSecurity.psd1 b/Engine/Configurations/ScriptSecurity.psd1
@@ -0,0 +1,8 @@
+﻿@{
+    IncludeRules=@('PSAvoidUsingPlainTextForPassword',
+                   'PSAvoidUsingComputerNameHardcoded',
+                   'PSAvoidUsingConvertToSecureStringWithPlainText',
+                   'PSUsePSCredentialType',
+                   'PSAvoidUsingUserNameAndPasswordParams',
+                   'PSAvoidUsingFilePath')
+}
diff --git a/Engine/Configurations/ScriptingStyle.psd1 b/Engine/Configurations/ScriptingStyle.psd1
@@ -0,0 +1,4 @@
+﻿@{
+    IncludeRules=@('PSProvideCommentHelp',
+                   'PSAvoidUsingWriteHost')
+}
diff --git a/Engine/ScriptAnalyzerEngine.csproj b/Engine/ScriptAnalyzerEngine.csproj
@@ -104,6 +104,8 @@
     <PostBuildEvent>mkdir "$(SolutionDir)$(SolutionName)"
 copy /y "$(ProjectDir)\*.ps1xml" "$(SolutionDir)$(SolutionName)"
 copy /y "$(ProjectDir)\*.psd1" "$(SolutionDir)$(SolutionName)"
+mkdir "$(SolutionDir)$(SolutionName)\Configurations"
+copy /y "$(ProjectDir)\Configurations\*.psd1" "$(SolutionDir)$(SolutionName)\Configurations"
 copy /y "$(TargetPath)" "$(SolutionDir)$(SolutionName)"
 mkdir "$(SolutionDir)$(SolutionName)\en-US"
 copy /y "$(ProjectDir)\about_*.help.txt" "$(SolutionDir)$(SolutionName)\en-US"

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+@{`
	`2`	`+ IncludeRules=@('PSDSC*')`
	`3`	`+}`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +@{
 +    IncludeRules=@('PSProvideCommentHelp',
 +                   'PSAvoidUsingWriteHost')
 +}