Skip to content

Commit 9f23d95

Browse files
committed
Rename private functions
* Rename private functions to more appropriate names
1 parent afad368 commit 9f23d95

File tree

6 files changed

+13
-13
lines changed

6 files changed

+13
-13
lines changed

AsBuiltReport.Core.Style.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AsBuiltReport Default Document Style
2-
Initialize-ReportLocalization -RootPath $PSScriptRoot -LanguageFile 'DefaultStyle'
2+
Initialize-SessionLocalization -ScriptRoot $PSScriptRoot -LanguageFile 'DefaultStyle'
33

44
# Configure document options
55
DocumentOption -EnableSectionNumbering -PageSize A4 -DefaultFont 'Segoe Ui' -MarginLeftAndRight 71 -MarginTopAndBottom 71 -Orientation $Orientation
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
function Draw-AsciiBox {
1+
function Draw-AsciiBanner {
22
param(
33
[string[]]$Lines,
44
[string]$TextColor,

Src/Private/Initialize-ReportLocalization.ps1 renamed to Src/Private/Initialize-SessionLocalization.ps1

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
function Initialize-ReportLocalization {
1+
function Initialize-SessionLocalization {
22
[CmdletBinding()]
33
param(
44
[Parameter(Mandatory = $true)]
5-
[string]$RootPath,
5+
[string]$ScriptRoot,
66

77
[Parameter(Mandatory = $true)]
88
[string]$LanguageFile
@@ -22,7 +22,7 @@ function Initialize-ReportLocalization {
2222
$DirectorySeparatorChar = [System.IO.Path]::DirectorySeparatorChar
2323

2424
# Setup all paths required for script to run
25-
$script:RootPath = $RootPath
25+
$script:RootPath = $ScriptRoot
2626
$script:LangPath = Join-Path $RootPath 'Language'
2727

2828
# Get fallback chain for current culture

Src/Public/New-AsBuiltConfig.ps1

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,15 @@ function New-AsBuiltConfig {
2424
#Run section to prompt user for information about the As Built Report to be exported to JSON format (if saved)
2525
$global:Config = @{ }
2626

27-
Initialize-ReportLocalization -RootPath (Split-Path (Split-Path $PSScriptRoot -Parent) -Parent) -LanguageFile 'New-AsBuiltConfig'
27+
Initialize-SessionLocalization -ScriptRoot (Split-Path (Split-Path $PSScriptRoot -Parent) -Parent) -LanguageFile 'New-AsBuiltConfig'
2828

2929
}
3030

3131
process {
3232
#region Report configuration
3333
Clear-Host
3434
# Show As Built Report configuration banner
35-
Draw-AsciiBox -Lines @($translate.ReportInfo.BannerTitle) -ExtraPadding 4 -TextColor 'Cyan' -BorderColor 'Cyan'
35+
Draw-AsciiBanner -Lines @($translate.ReportInfo.BannerTitle) -ExtraPadding 4 -TextColor 'Cyan' -BorderColor 'Cyan'
3636

3737
$ReportAuthor = Read-Host -Prompt ($translate.ReportInfo.ReportAuthor -f [System.Environment]::Username)
3838
if (($ReportAuthor -like $null) -or ($ReportAuthor -eq "")) {
@@ -47,7 +47,7 @@ function New-AsBuiltConfig {
4747
#region Company configuration
4848
Clear-Host
4949
# Show Company configuration banner
50-
Draw-AsciiBox -Lines @($translate.CompanyConfig.BannerTitle) -ExtraPadding 4 -TextColor 'Cyan' -BorderColor 'Cyan'
50+
Draw-AsciiBanner -Lines @($translate.CompanyConfig.BannerTitle) -ExtraPadding 4 -TextColor 'Cyan' -BorderColor 'Cyan'
5151

5252
$CompanyInfo = Read-Host -Prompt $translate.CompanyConfig.CompanyInfo
5353
while ("y", "n" -notcontains $CompanyInfo) {
@@ -92,7 +92,7 @@ function New-AsBuiltConfig {
9292
#region Email configuration
9393
Clear-Host
9494
# Show Email configuration banner
95-
Draw-AsciiBox -Lines @($translate.EmailConfig.BannerTitle) -ExtraPadding 4 -TextColor 'Cyan' -BorderColor 'Cyan'
95+
Draw-AsciiBanner -Lines @($translate.EmailConfig.BannerTitle) -ExtraPadding 4 -TextColor 'Cyan' -BorderColor 'Cyan'
9696
if (-not ($SendEmail)) {
9797
$ConfigureMailSettings = Read-Host -Prompt $translate.EmailConfig.ConfigureMailSettings
9898
while ("y", "n" -notcontains $ConfigureMailSettings) {
@@ -266,7 +266,7 @@ function New-AsBuiltConfig {
266266
if ($Report -and (-not $ReportConfigFilePath)) {
267267
Clear-Host
268268
# Show Rerport configuration banner
269-
Draw-AsciiBox -Lines @($translate.ReportConfig.BannerTitle) -ExtraPadding 4 -TextColor 'Cyan' -BorderColor 'Cyan'
269+
Draw-AsciiBanner -Lines @($translate.ReportConfig.BannerTitle) -ExtraPadding 4 -TextColor 'Cyan' -BorderColor 'Cyan'
270270
$ReportConfigFolder = Read-Host -Prompt ($translate.ReportConfig.ReportConfigFolder -f $Home + $DirectorySeparatorChar + "AsBuiltReport")
271271
if (($ReportConfigFolder -like $null) -or ($ReportConfigFolder -eq "")) {
272272
$ReportConfigFolder = $Home + $DirectorySeparatorChar + "AsBuiltReport"
@@ -321,7 +321,7 @@ function New-AsBuiltConfig {
321321

322322
#region Save configuration
323323
Clear-Host
324-
Draw-AsciiBox -Lines @($translate.ReportConfig.BannerTitle) -ExtraPadding 4 -TextColor 'Cyan' -BorderColor 'Cyan'
324+
Draw-AsciiBanner -Lines @($translate.ReportConfig.BannerTitle) -ExtraPadding 4 -TextColor 'Cyan' -BorderColor 'Cyan'
325325
$SaveAsBuiltConfig = Read-Host -Prompt $translate.ReportConfig.SaveAsBuiltConfig
326326
while ("y", "n" -notcontains $SaveAsBuiltConfig) {
327327
$SaveAsBuiltConfig = Read-Host -Prompt $translate.ReportConfig.SaveAsBuiltConfig

Src/Public/New-AsBuiltReport.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ function New-AsBuiltReport {
251251
)
252252
#endregion Script Parameters
253253

254-
Initialize-ReportLocalization -RootPath (Split-Path (Split-Path $PSScriptRoot -Parent) -Parent) -LanguageFile 'New-AsBuiltReport'
254+
Initialize-SessionLocalization -ScriptRoot (Split-Path (Split-Path $PSScriptRoot -Parent) -Parent) -LanguageFile 'New-AsBuiltReport'
255255

256256
try {
257257

Src/Public/New-AsBuiltReportConfig.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ function New-AsBuiltReportConfig {
7272
[Switch] $Force
7373
)
7474

75-
Initialize-ReportLocalization -RootPath (Split-Path (Split-Path $PSScriptRoot -Parent) -Parent) -LanguageFile 'New-AsBuiltReportConfig'
75+
Initialize-SessionLocalization -ScriptRoot (Split-Path (Split-Path $PSScriptRoot -Parent) -Parent) -LanguageFile 'New-AsBuiltReportConfig'
7676

7777
# Test to ensure the path the user has specified does exist
7878
if (-not (Test-Path -Path $($FolderPath))) {

0 commit comments

Comments
 (0)