Commit build changes [ci skip]

MathieuBuisson · May 6, 2017 · 0daac3e · 0daac3e
1 parent 66109d6
commit 0daac3e
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 2 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.1.79'
+ModuleVersion = '0.1.80'
 
 # ID used to uniquely identify this module
 GUID = 'ca22dabd-bbb6-4805-9c90-a8aad6dbbfd3'

diff --git a/docs/Functions/Invoke-PSCodeHealth.md b/docs/Functions/Invoke-PSCodeHealth.md
@@ -6,7 +6,8 @@ Gets quality and maintainability metrics for PowerShell code contained in script
 ## SYNTAX
 
 ```
-Invoke-PSCodeHealth [[-Path] <String>] [[-TestsPath] <String>] [-Recurse] [-Exclude <String[]>]
+Invoke-PSCodeHealth [[-Path] <String>] [[-TestsPath] <String>] [[-TestsResult] <PSObject>] [-Recurse]
+ [-Exclude <String[]>]
 ```
 
 ## DESCRIPTION
@@ -74,6 +75,27 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -TestsResult
+To use an existing Pester tests result object for generating the following metrics :  
+  - NumberOfTests  
+  - NumberOfFailedTests  
+  - NumberOfPassedTests  
+  - TestsPassRate (%)  
+  - TestCoverage (%)  
+  - CommandsMissedTotal
+
+```yaml
+Type: PSObject
+Parameter Sets: (All)
+Aliases: 
+
+Required: False
+Position: 3
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -Recurse
 To search PowerShell files in the Path directory and all subdirectories recursively.