Commit build changes [ci skip]

MathieuBuisson · May 10, 2018 · e335794 · e335794
1 parent 24b9981
commit e335794
Show file tree

Hide file tree

Showing 28 changed files with 236 additions and 152 deletions.
diff --git a/PSCodeHealth/PSCodeHealth.psd1 b/PSCodeHealth/PSCodeHealth.psd1
@@ -12,7 +12,7 @@
 RootModule = '.\PSCodeHealth.psm1'
 
 # Version number of this module.
-ModuleVersion = '0.2.9'
+ModuleVersion = '0.2.25'
 
 # ID used to uniquely identify this module
 GUID = 'ca22dabd-bbb6-4805-9c90-a8aad6dbbfd3'

diff --git a/docs/InternalFunctions/Get-ExternalHelpCommand.md b/docs/InternalFunctions/Get-ExternalHelpCommand.md
@@ -6,15 +6,15 @@ Gets the name of the commands listed in external help files.
 ## SYNTAX
 
 ```
-Get-ExternalHelpCommand [-Path] <String[]>
+Get-ExternalHelpCommand [-Path] <String[]> [<CommonParameters>]
 ```
 
 ## DESCRIPTION
 Gets the name of the commands listed in external (MAML-formatted) help files.
 
 ## EXAMPLES
 
-### -------------------------- EXAMPLE 1 --------------------------
+### EXAMPLE 1
 ```
 Get-ExternalHelpCommand -Path 'C:\GitRepos\MyModule'
 ```
@@ -31,7 +31,7 @@ The function looks for files with a name ending with "-help.xml" in a "en-US" su
 ```yaml
 Type: String[]
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: True
 Position: 1
@@ -40,6 +40,10 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### CommonParameters
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
+For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
+
 ## INPUTS
 
 ## OUTPUTS
@@ -48,4 +52,3 @@ Accept wildcard characters: False
 https://info.sapien.com/index.php/scripting/scripting-help/writing-xml-help-for-advanced-functions
 
 ## RELATED LINKS
-
diff --git a/docs/InternalFunctions/Get-FunctionDefinition.md b/docs/InternalFunctions/Get-FunctionDefinition.md
@@ -6,15 +6,15 @@ Gets all the function definitions in the specified files.
 ## SYNTAX
 
 ```
-Get-FunctionDefinition [-Path] <String[]>
+Get-FunctionDefinition [-Path] <String[]> [<CommonParameters>]
 ```
 
 ## DESCRIPTION
 Gets all the function definitions (including private functions but excluding nested functions) in the specified PowerShell file.
 
 ## EXAMPLES
 
-### -------------------------- EXAMPLE 1 --------------------------
+### EXAMPLE 1
 ```
 Get-FunctionDefinition -Path C:\GitRepos\MyModule\MyModule.psd1
 ```
@@ -29,7 +29,7 @@ To specify the path of the file to analyze.
 ```yaml
 Type: String[]
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: True
 Position: 1
@@ -38,6 +38,10 @@ Accept pipeline input: True (ByValue)
 Accept wildcard characters: False
 ```
 
+### CommonParameters
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
+For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
+
 ## INPUTS
 
 ## OUTPUTS
@@ -47,4 +51,3 @@ Accept wildcard characters: False
 ## NOTES
 
 ## RELATED LINKS
-
diff --git a/docs/InternalFunctions/Get-FunctionLinesOfCode.md b/docs/InternalFunctions/Get-FunctionLinesOfCode.md
@@ -6,7 +6,7 @@ Gets the number of lines in the specified function definition (excluding comment
 ## SYNTAX
 
 ```
-Get-FunctionLinesOfCode [-FunctionDefinition] <FunctionDefinitionAst>
+Get-FunctionLinesOfCode [-FunctionDefinition] <FunctionDefinitionAst> [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -15,7 +15,7 @@ The single line comments, multiple lines comments and comment-based help are not
 
 ## EXAMPLES
 
-### -------------------------- EXAMPLE 1 --------------------------
+### EXAMPLE 1
 ```
 Get-FunctionLinesOfCode -FunctionDefinition $MyFunctionAst
 ```
@@ -30,7 +30,7 @@ To specify the function definition to analyze.
 ```yaml
 Type: FunctionDefinitionAst
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: True
 Position: 1
@@ -39,6 +39,10 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### CommonParameters
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
+For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
+
 ## INPUTS
 
 ## OUTPUTS
@@ -48,4 +52,3 @@ Accept wildcard characters: False
 ## NOTES
 
 ## RELATED LINKS
-
diff --git a/docs/InternalFunctions/Get-FunctionScriptAnalyzerResult.md b/docs/InternalFunctions/Get-FunctionScriptAnalyzerResult.md
@@ -6,7 +6,7 @@ Gets the best practices violations details in the specified function definition,
 ## SYNTAX
 
 ```
-Get-FunctionScriptAnalyzerResult [-FunctionDefinition] <FunctionDefinitionAst>
+Get-FunctionScriptAnalyzerResult [-FunctionDefinition] <FunctionDefinitionAst> [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -15,7 +15,7 @@ It uses the PSScriptAnalyzer PowerShell module.
 
 ## EXAMPLES
 
-### -------------------------- EXAMPLE 1 --------------------------
+### EXAMPLE 1
 ```
 Get-FunctionScriptAnalyzerResult -FunctionDefinition $MyFunctionAst
 ```
@@ -30,7 +30,7 @@ To specify the function definition to analyze.
 ```yaml
 Type: FunctionDefinitionAst
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: True
 Position: 1
@@ -39,6 +39,10 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### CommonParameters
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
+For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
+
 ## INPUTS
 
 ## OUTPUTS
@@ -48,4 +52,3 @@ Accept wildcard characters: False
 ## NOTES
 
 ## RELATED LINKS
-
diff --git a/docs/InternalFunctions/Get-FunctionTestCoverage.md b/docs/InternalFunctions/Get-FunctionTestCoverage.md
@@ -7,6 +7,7 @@ Gets test coverage information for the specified function.
 
 ```
 Get-FunctionTestCoverage [-FunctionDefinition] <FunctionDefinitionAst> [[-TestsPath] <String>]
+ [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -19,7 +20,7 @@ It uses Pester with its CodeCoverage parameter.
 
 ## EXAMPLES
 
-### -------------------------- EXAMPLE 1 --------------------------
+### EXAMPLE 1
 ```
 Get-FunctionTestCoverage -FunctionDefinition $MyFunctionAst -TestsPath $MyModule.ModuleBase
 ```
@@ -34,7 +35,7 @@ To specify the function definition to analyze.
 ```yaml
 Type: FunctionDefinitionAst
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: True
 Position: 1
@@ -51,7 +52,7 @@ If not specified, the directory of the file containing the specified function, a
 ```yaml
 Type: String
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: False
 Position: 2
@@ -60,6 +61,10 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### CommonParameters
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
+For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
+
 ## INPUTS
 
 ## OUTPUTS
@@ -69,4 +74,3 @@ Accept wildcard characters: False
 ## NOTES
 
 ## RELATED LINKS
-
diff --git a/docs/InternalFunctions/Get-PowerShellFile.md b/docs/InternalFunctions/Get-PowerShellFile.md
@@ -6,7 +6,7 @@ Gets all PowerShell files in the specified directory.
 ## SYNTAX
 
 ```
-Get-PowerShellFile [-Path] <String> [-Recurse] [-Exclude <String[]>]
+Get-PowerShellFile [-Path] <String> [-Recurse] [-Exclude <String[]>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -15,14 +15,14 @@ The following PowerShell-related files are excluded : format data files, type da
 
 ## EXAMPLES
 
-### -------------------------- EXAMPLE 1 --------------------------
+### EXAMPLE 1
 ```
 Get-PowerShellFile -Path C:\GitRepos\MyModule\ -Recurse
 ```
 
 Gets all PowerShell files in the directory C:\GitRepos\MyModule\ and any subdirectories.
 
-### -------------------------- EXAMPLE 2 --------------------------
+### EXAMPLE 2
 ```
 Get-PowerShellFile -Path C:\GitRepos\MyModule\ -Recurse -Exclude "*example*"
 ```
@@ -37,7 +37,7 @@ To specify the path of the directory to search.
 ```yaml
 Type: String
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: True
 Position: 1
@@ -52,7 +52,7 @@ To search the Path directory and all subdirectories recursively.
 ```yaml
 Type: SwitchParameter
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: False
 Position: Named
@@ -70,7 +70,7 @@ Wildcards are permitted.
 ```yaml
 Type: String[]
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: False
 Position: Named
@@ -79,6 +79,10 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### CommonParameters
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
+For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
+
 ## INPUTS
 
 ## OUTPUTS
@@ -88,4 +92,3 @@ Accept wildcard characters: False
 ## NOTES
 
 ## RELATED LINKS
-
diff --git a/docs/InternalFunctions/Measure-FunctionComplexity.md b/docs/InternalFunctions/Measure-FunctionComplexity.md
@@ -6,7 +6,7 @@ Measures the code complexity.
 ## SYNTAX
 
 ```
-Measure-FunctionComplexity [-FunctionDefinition] <FunctionDefinitionAst>
+Measure-FunctionComplexity [-FunctionDefinition] <FunctionDefinitionAst> [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -17,7 +17,7 @@ The number of possible paths depends on the number of conditional logic construc
 
 ## EXAMPLES
 
-### -------------------------- EXAMPLE 1 --------------------------
+### EXAMPLE 1
 ```
 Measure-FunctionComplexity -FunctionDefinition $MyFunctionAst
 ```
@@ -32,7 +32,7 @@ To specify the function definition to analyze.
 ```yaml
 Type: FunctionDefinitionAst
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: True
 Position: 1
@@ -41,6 +41,10 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### CommonParameters
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
+For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
+
 ## INPUTS
 
 ## OUTPUTS
@@ -55,4 +59,3 @@ A simple example of measuring the Cyclomatic complexity of a piece od code can b
 https://www.tutorialspoint.com/software_testing_dictionary/cyclomatic_complexity.htm
 
 ## RELATED LINKS
-
diff --git a/docs/InternalFunctions/Measure-FunctionForCodePath.md b/docs/InternalFunctions/Measure-FunctionForCodePath.md
@@ -6,15 +6,15 @@ Gets the number of additional code paths due to For loops.
 ## SYNTAX
 
 ```
-Measure-FunctionForCodePath [-FunctionDefinition] <FunctionDefinitionAst>
+Measure-FunctionForCodePath [-FunctionDefinition] <FunctionDefinitionAst> [<CommonParameters>]
 ```
 
 ## DESCRIPTION
 Gets the number of additional code paths due to For loops (where the For statement contains a condition), in the specified function definition.
 
 ## EXAMPLES
 
-### -------------------------- EXAMPLE 1 --------------------------
+### EXAMPLE 1
 ```
 Measure-FunctionForCodePath -FunctionDefinition $MyFunctionAst
 ```
@@ -29,7 +29,7 @@ To specify the function definition to analyze.
 ```yaml
 Type: FunctionDefinitionAst
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: True
 Position: 1
@@ -38,6 +38,10 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### CommonParameters
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
+For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
+
 ## INPUTS
 
 ## OUTPUTS
@@ -47,4 +51,3 @@ Accept wildcard characters: False
 ## NOTES
 
 ## RELATED LINKS
-