Migrate AppDeployToolkitExtensions.ps1 from v3 to v4

[Rudi422]

Summary of the new feature / enhancement

With the Convert-ADTDeployment you can convert Deploy-Application.ps1 files. But we have lot of home brew functions in AppDeployToolkitExtensions.ps1 . when trying to convert that it gives an error "Convert-ADTDeployment : The expected if statement was not found in the input script."
Can the convert function be changed so that it is also possible to convert the extensions.ps1. I realize that we will have to do some specific work on it but if this functions could do the bulk then that would be amazing for us.

v4, nice work by the way.

Proposed technical implementation details (optional)

No response

[DanGough]

I will look into adding support for this - in the meantime you can try experimenting with this:

$CustomRulePath = "$((Get-Module PSAppDeployToolkit.Tools -ListAvailable).ModuleBase)\PSScriptAnalyzer\Measure-ADTCompatibility.psm1"
Invoke-ScriptAnalyzer -Path <PathToExtensionsFile> -CustomRulePath $CustomRulePath

To list the changes, and add -Fix to that to actually update the file (making sure you have a backup of course!).

[Rudi422]

I did try the code you gave. Without the -Fix it indeed shows all the issues like it should. But with the -Fix the issues are not corrected in the file and I don't see what i am doing wrong here. I am using the following PS version.

Name Value

---

PSVersion 5.1.22621.4391
PSEdition Desktop
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0...}
BuildVersion 10.0.22621.4391
CLRVersion 4.0.30319.42000
WSManStackVersion 3.0
PSRemotingProtocolVersion 2.3
SerializationVersion 1.1.0.1

With these modules loaded.

Name Version

---

PSAppDeployToolkit 4.0.4
PSAppDeployToolkit.Tools 0.2.2
PSScriptAnalyzer 1.23.0

This is the commandline I am using as you suggested.
$CustomRulePath = "$((Get-Module PSAppDeployToolkit.Tools -ListAvailable).ModuleBase)\PSScriptAnalyzer\Measure-ADTCompatibility.psm1"
Invoke-ScriptAnalyzer -Path 'C:\Temp\extensions\PSAppDeployToolkit.Extensions\AppDeployToolkitExtensions.ps1' -CustomRulePath $CustomRulePath -Fix
Any idea what I am doing wrong here?

I tested a bit more and when I have a plain ps1 file without functions defined it works ok.
Plain without functions the Write-Log will be converted to Write-ADTLogEntry.

##===============================================
## FUNCTION LISTINGS
##*===============================================

Write-Log -Message "This one is not in a function."

##===============================================
## END FUNCTION LISTINGS
##*===============================================

But as soon that one function is defined then the conversion is not done.
With function, nothing is converted.
##===============================================
## FUNCTION LISTINGS
##*===============================================

Write-Log -Message "This one is not in a function."

function Set-LogMessage-Test {
Write-Log -Message "This one is in a function."
}

##===============================================
## END FUNCTION LISTINGS
##*===============================================

[CoyoteProd]

For workaround only (feel free to delete if inappropriate):

As I see Invoke-ScriptAnalyzer output an object array which have all modifications to do.
I'm using simple Search/Replace for doing changes:

# Define the file path
$filePath = "C:\TEMP\Scripts\Customscript.ps1"

$CustomRulePath = "$((Get-Module PSAppDeployToolkit.Tools -ListAvailable).ModuleBase)\PSScriptAnalyzer\Measure-ADTCompatibility.psm1"
$replacements = Invoke-ScriptAnalyzer -Path $filePath -CustomRulePath $CustomRulePath -Fix

Write-Output "$($replacements.SuggestedCorrections.count) changes"

# Read the file
$fileContent = Get-Content -Path $filePath

# Iterate through each replacement
foreach ($replacement in $replacements) 
{
    foreach ($SuggestedCorrection in $replacements.SuggestedCorrections) 
    {        
        $startLineNumber = $SuggestedCorrection.StartLineNumber
        $newText =  $SuggestedCorrection.Text
        $oldText = $replacement.Extent.Text
        
        # Check if the line exists
        if ($startLineNumber -le $fileContent.Length) {
            # Get the specific line
            $line = $fileContent[$startLineNumber - 1]

            # Replace the target text with the new text
            $fileContent[$startLineNumber - 1] = $line.Replace($oldText, $newText)
        }
    }
}

# Write the changes to the file
Set-Content -Path $filePath -Value $fileContent

Write-Output "The replacements have been successfully made."