Skip to content

Commit

Permalink
Commit build changes [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
MathieuBuisson committed Jun 29, 2017
1 parent b3712b6 commit 20a0b7e
Show file tree
Hide file tree
Showing 3 changed files with 73 additions and 1 deletion.
2 changes: 1 addition & 1 deletion PSCodeHealth/PSCodeHealth.psd1
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
RootModule = '.\PSCodeHealth.psm1'

# Version number of this module.
ModuleVersion = '0.1.143'
ModuleVersion = '0.1.144'

# ID used to uniquely identify this module
GUID = 'ca22dabd-bbb6-4805-9c90-a8aad6dbbfd3'
Expand Down
71 changes: 71 additions & 0 deletions docs/InternalFunctions/Set-PSCodeHealthPlaceholdersValue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Set-PSCodeHealthPlaceholdersValue

## SYNOPSIS
Replaces Placeholders in template files with their specified value.

## SYNTAX

```
Set-PSCodeHealthPlaceholdersValue [-TemplatePath] <String> [-PlaceholdersData] <Hashtable>
```

## DESCRIPTION
Replaces Placeholders in template files with their specified string value and outputs the new content with the replaced value.

## EXAMPLES

### -------------------------- EXAMPLE 1 --------------------------
```
$PlaceholdersData = @{
```

REPORT_TITLE = $HealthReport.ReportTitle
ANALYZED_PATH = $HealthReport.AnalyzedPath
}
PS C:\\\> Set-PSCodeHealthPlaceholdersValue -TemplatePath '.\HealthReportTemplate.html' -PlaceholdersData $PlaceholdersData

Returns the content of the template file with the placeholders 'REPORT_TITLE' and 'ANALYZED_PATH' substituted by the string values specified in the hashtable $PlaceholdersData.

## PARAMETERS

### -TemplatePath
Path of the template file containing placeholders to replace.

```yaml
Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

### -PlaceholdersData
Hashtable with a key-value pair for each placeholder.
The key is corresponds to the name of the placeholder to replace and the value corresponds to its string value.

```yaml
Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```

## INPUTS

## OUTPUTS

### System.String

## NOTES

## RELATED LINKS

1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ pages:
- New-PSCodeHealthComplianceRule: InternalFunctions/New-PSCodeHealthComplianceRule.md
- New-PSCodeHealthReport: InternalFunctions/New-PSCodeHealthReport.md
- New-PSCodeHealthHtmlReport: InternalFunctions/New-PSCodeHealthHtmlReport.md
- Set-PSCodeHealthPlaceholdersValue: InternalFunctions/Set-PSCodeHealthPlaceholdersValue.md
- Get-FunctionDefinition: InternalFunctions/Get-FunctionDefinition.md
- Get-FunctionLinesOfCode: InternalFunctions/Get-FunctionLinesOfCode.md
- Get-FunctionScriptAnalyzerResult: InternalFunctions/Get-FunctionScriptAnalyzerResult.md
Expand Down

0 comments on commit 20a0b7e

Please sign in to comment.