Commit build changes [ci skip]

MathieuBuisson · Jul 14, 2017 · 9088a7c · 9088a7c
1 parent 0229f98
commit 9088a7c
Show file tree

Hide file tree

Showing 5 changed files with 124 additions and 52 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.154'
+ModuleVersion = '0.1.155'
 
 # ID used to uniquely identify this module
 GUID = 'ca22dabd-bbb6-4805-9c90-a8aad6dbbfd3'

diff --git a/docs/InternalFunctions/New-PSCodeHealthHtmlReport.md b/docs/InternalFunctions/New-PSCodeHealthHtmlReport.md
diff --git a/docs/InternalFunctions/Set-PSCodeHealthHtmlColor.md b/docs/InternalFunctions/Set-PSCodeHealthHtmlColor.md
@@ -0,0 +1,100 @@
+# Set-PSCodeHealthHtmlColor
+
+## SYNOPSIS
+Sets classes to the elements in the HTML report which use color coding to reflect their compliance, and returns the modified HTML.
+
+## SYNTAX
+
+```
+Set-PSCodeHealthHtmlColor [-HealthReport] <PSObject> [-Compliance] <PSObject[]>
+ [-PerFunctionCompliance] <PSObject[]> [-Html] <String[]>
+```
+
+## DESCRIPTION
+Sets the class attribute to the elements in the HTML report which use color coding to reflect their compliance.
+
+These classes corresponds to CSS declaration blocks to apply the appropriate styling to the elements, in particular the colors.
+
+Then, it returns the modified HTML content to the caller.
+
+## EXAMPLES
+
+### -------------------------- EXAMPLE 1 --------------------------
+```
+Set-PSCodeHealthHtmlColor -HealthReport $HealthReport -Compliance $OverallCompliance -PerFunctionCompliance $PerFunctionCompliance -Html $HtmlContent
+```
+
+This sets classes to the elements in the HTML report which use color coding to reflect their compliance and returns the modified HTML content.
+
+## PARAMETERS
+
+### -HealthReport
+To specify the input PSCodeHealth.Overall.HealthReport object containing the data.
+
+```yaml
+Type: PSObject
+Parameter Sets: (All)
+Aliases: 
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Compliance
+To input the overall compliance information, based on the current health report and the compliance rules.
+
+```yaml
+Type: PSObject[]
+Parameter Sets: (All)
+Aliases: 
+
+Required: True
+Position: 2
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -PerFunctionCompliance
+To input the per-function compliance information, based on the functions in the current health report and the compliance rules.
+
+```yaml
+Type: PSObject[]
+Parameter Sets: (All)
+Aliases: 
+
+Required: True
+Position: 3
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Html
+To input the original HTML content (containing placeholders to be substituted with the appropriate class values).
+
+```yaml
+Type: String[]
+Parameter Sets: (All)
+Aliases: 
+
+Required: True
+Position: 3
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+## INPUTS
+
+## OUTPUTS
+
+### System.String
+
+## NOTES
+
+## RELATED LINKS
+
diff --git a/docs/InternalFunctions/Set-PSCodeHealthPlaceholdersValue.md b/docs/InternalFunctions/Set-PSCodeHealthPlaceholdersValue.md
@@ -5,10 +5,16 @@ Replaces Placeholders in template files with their specified value.
 
 ## SYNTAX
 
+### File (Default)
 ```
 Set-PSCodeHealthPlaceholdersValue [-TemplatePath] <String> [-PlaceholdersData] <Hashtable>
 ```
 
+### Html
+```
+Set-PSCodeHealthPlaceholdersValue [-PlaceholdersData] <Hashtable> [-Html] <String[]>
+```
+
 ## DESCRIPTION
 Replaces Placeholders in template files with their specified string value and outputs the new content with the replaced value.
 
@@ -33,7 +39,7 @@ Path of the template file containing placeholders to replace.
 
 ```yaml
 Type: String
-Parameter Sets: (All)
+Parameter Sets: File
 Aliases: 
 
 Required: True
@@ -59,6 +65,21 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -Html
+{{Fill Html Description}}
+
+```yaml
+Type: String[]
+Parameter Sets: Html
+Aliases: 
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ## INPUTS
 
 ## OUTPUTS

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -23,8 +23,8 @@ pages:
     - New-PSCodeHealthComplianceResult: InternalFunctions/New-PSCodeHealthComplianceResult.md
     - New-PSCodeHealthComplianceRule: InternalFunctions/New-PSCodeHealthComplianceRule.md
     - New-PSCodeHealthReport: InternalFunctions/New-PSCodeHealthReport.md
-    - New-PSCodeHealthHtmlReport: InternalFunctions/New-PSCodeHealthHtmlReport.md
     - New-PSCodeHealthTableData: InternalFunctions/New-PSCodeHealthTableData.md
+    - Set-PSCodeHealthHtmlColor: InternalFunctions/Set-PSCodeHealthHtmlColor.md
     - Set-PSCodeHealthPlaceholdersValue: InternalFunctions/Set-PSCodeHealthPlaceholdersValue.md
     - Get-FunctionDefinition: InternalFunctions/Get-FunctionDefinition.md
     - Get-FunctionLinesOfCode: InternalFunctions/Get-FunctionLinesOfCode.md