Thank you for your patience @mkht - sadly I get almost no time on DSC anymore, but I try 😁

Reviewed 5 of 10 files at r1, 1 of 1 files at r3, all commit messages.
Reviewable status: 6 of 11 files reviewed, 12 unresolved discussions (waiting on @mkht)

CHANGELOG.md line 8 at r3 (raw file):

## [Unreleased]

### Changed

Can you also add the change to the buildpipeline GitVersion.Tool to v5?

CHANGELOG.md line 26 at r3 (raw file):

- Automatically publish documentation to GitHub Wiki - Fixes [Issue #51](https://github.com/dsccommunity/FileContentDsc/issues/51).
- Renamed `master` branch to `main` - Fixes [Issue #53](https://github.com/dsccommunity/FileContentDsc/issues/53).
- Added `UTF8BOM` and `UTF8NoBOM` for Encoding parameter of the KeyValuePairFile and ReplaceText - Fixes [Issue #56](https://github.com/dsccommunity/FileContentDsc/issues/56).

nit:

Suggestion:

- Added `UTF8BOM` and `UTF8NoBOM` options to the Encoding parameter of the KeyValuePairFile and ReplaceText - Fixes [Issue #56](https://github.com/dsccommunity/FileContentDsc/issues/56).

source/DSCResources/DSC_KeyValuePairFile/DSC_KeyValuePairFile.psm1 line 201 at r3 (raw file):

    Assert-ParametersValid @PSBoundParameters

    $fileEncoding = Get-FileEncoding $Path -ErrorAction SilentlyContinue

I notice this code block is almost identical to the code block in Test-TargetResource. (except this one uses ErrorAction SilientlyContinue). I'm wondering if:

1. We shouldn't remove the ErrorAction SilentlyContinue (not sure why I did this at all - it worries me a bit).
2. Refactor this into a Get-FileContent function to reduce code duplication but also make this easier to test.

What do you think?

source/DSCResources/DSC_KeyValuePairFile/DSC_KeyValuePairFile.psm1 line 274 at r3 (raw file):

            {
                if ($PSBoundParameters.ContainsKey('Encoding') -and `
                    (($Encoding -eq $fileEncoding) -or `

Would it be possible to refactor this code logic into a separate function (like Test-FileCodingEqual or something). This would make it simpler to test?

source/DSCResources/DSC_KeyValuePairFile/DSC_KeyValuePairFile.psm1 line 408 at r3 (raw file):

    }

    $fileEncoding = Get-FileEncoding $Path -ErrorAction SilentlyContinue

See comment above about possible reduction in code duplication by refactoring into a new function.

source/DSCResources/DSC_ReplaceText/DSC_ReplaceText.psm1 line 45 at r3 (raw file):

    $fileEncoding = Get-FileEncoding $Path -ErrorAction SilentlyContinue
    if ($null -eq $fileEncoding)

See comment above about possible reduction in code duplication by refactoring into a new function.

source/DSCResources/DSC_ReplaceText/DSC_ReplaceText.psm1 line 158 at r3 (raw file):

    $fileEncoding = Get-FileEncoding $Path -ErrorAction SilentlyContinue
    if ($null -eq $fileEncoding)

See comment above about possible reduction in code duplication by refactoring into a new function.

source/DSCResources/DSC_ReplaceText/DSC_ReplaceText.psm1 line 290 at r3 (raw file):

    $fileEncoding = Get-FileEncoding $Path -ErrorAction SilentlyContinue
    if ($null -eq $fileEncoding)

See comment above about possible reduction in code duplication by refactoring into a new function.

source/Modules/FileContentDsc.Common/FileContentDsc.Common.psm1 line 180 at r3 (raw file):

    $ByteParam = if ($PSVersionTable.PSVersion.Major -ge 6)
    {
        @{AsByteStream = $true }

Can you adjust the formatting of this hashtable to fix the HQRM tests. It should be:

@{
    AsByteStream = $true
}

source/Modules/FileContentDsc.Common/FileContentDsc.Common.psm1 line 184 at r3 (raw file):

    else
    {
        @{Encoding = 'byte' }

Can you adjust the formatting of this hashtable to fix the HQRM tests. It should be:

@{
    Encoding = 'byte'
}

tests/TestHelpers/CommonTestHelper.psm1 line 115 at r3 (raw file):

    $ByteParam = if ($PSVersionTable.PSVersion.Major -ge 6)
    {
        @{AsByteStream = $true }

Can you adjust the formatting of this hashtable to fix the HQRM tests. It should be:

@{
    AsByteStream = $true
}

tests/TestHelpers/CommonTestHelper.psm1 line 119 at r3 (raw file):

    else
    {
        @{Encoding = 'byte' }

Can you adjust the formatting of this hashtable to fix the HQRM tests. It should be:

@{
    Encoding = 'byte'
}

Reviewable status: 3 of 11 files reviewed, 11 unresolved discussions (waiting on @PlagueHO)

CHANGELOG.md line 8 at r3 (raw file):

Done.

source/DSCResources/DSC_KeyValuePairFile/DSC_KeyValuePairFile.psm1 line 201 at r3 (raw file):

Done.

Refactored to Get-FileContent, leaving SilentlyContinue in place.
It seems to me that SilentlyContinue was specified to avoid an error if the file does not exist. It might be better to be consistent since there are places in the code where the file is checked for existence in advance and other places where it is not.

source/DSCResources/DSC_KeyValuePairFile/DSC_KeyValuePairFile.psm1 line 274 at r3 (raw file):

Done.

source/DSCResources/DSC_KeyValuePairFile/DSC_KeyValuePairFile.psm1 line 408 at r3 (raw file):

Done.

source/DSCResources/DSC_ReplaceText/DSC_ReplaceText.psm1 line 45 at r3 (raw file):

Done.

source/DSCResources/DSC_ReplaceText/DSC_ReplaceText.psm1 line 158 at r3 (raw file):

Done.

source/DSCResources/DSC_ReplaceText/DSC_ReplaceText.psm1 line 290 at r3 (raw file):

Done.

source/Modules/FileContentDsc.Common/FileContentDsc.Common.psm1 line 180 at r3 (raw file):

Done.

source/Modules/FileContentDsc.Common/FileContentDsc.Common.psm1 line 184 at r3 (raw file):

Done.

tests/TestHelpers/CommonTestHelper.psm1 line 115 at r3 (raw file):

Done.

tests/TestHelpers/CommonTestHelper.psm1 line 119 at r3 (raw file):

Done.