feat: Alias and Breakingchange through PSA

vscode-extension/PSA_custom_Rules/Alias/Get-AliasSpec.psm1

@@ -0,0 +1,16 @@
+#load the alias from the json file
+
+function Get-AliasSpec {
+    param (
+        [Parameter(
+            Mandatory = $true,
+            HelpMessage = "Specify the path to the file that contains alias mapping.")]
+        [System.String]
+        [ValidateNotNullOrEmpty()]
+        $AliasPath
+    )
+
+    $aliasTocmdlets = Get-Content $AliasPath | ConvertFrom-Json
+
+    return $aliasTocmdlets
+}

vscode-extension/PSA_custom_Rules/Alias/avoidAlias.psm1

@@ -0,0 +1,92 @@
+#Requires -Version 3.0
+
+<#
+.SYNOPSI
+    Avoid alias in powershell script.
+.DESCRIPTION
+    Find all aliases that appear in the powershell script. And give the suggestion to change them to formal name.
+.EXAMPLE
+    Measure-AvoidAlias -ScriptBlockAst $ScriptBlockAst
+.INPUTS
+    [System.Management.Automation.Language.ScriptBlockAst]
+.OUTPUTS
+    [OutputType([Microsoft.Windows.Powershell.ScriptAnalyzer.Generic.DiagnosticRecord[]])]
+.NOTES
+    None
+#>
+function Measure-AvoidAlias {
+    [CmdletBinding()]
+    [OutputType([Microsoft.Windows.Powershell.ScriptAnalyzer.Generic.DiagnosticRecord[]])]
+    Param
+    (
+        [Parameter(Mandatory = $true)]
+        [ValidateNotNullOrEmpty()]
+        [System.Management.Automation.Language.ScriptBlockAst]
+        $testAst
+    )
+
+    Process {
+        $results = @()
+        # import functions
+        $findCmdFunctionFile = ".\PSA_custom_Rules\Find-CmdletsInFile.psm1"
+        Import-Module $findCmdFunctionFile
+        $getAliasSpecFunctionFile = ".\PSA_custom_Rules\Alias\Get-AliasSpec.psm1"
+        Import-Module $getAliasSpecFunctionFile
+
+        #get the alias mapping data
+        $aliasSpecFile = ".\PSA_custom_Rules\Alias\AliasSpec.json"
+        $AliasSpec = Get-AliasSpec -AliasPath $aliasSpecFile
+
+        # get the commandAst in the file
+        $foundCmdlets = Find-CmdletsInFile -rootAstNode $testAst
+
+        #list of CorrectionExtents
+        $l = (new-object System.Collections.ObjectModel.Collection["Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.CorrectionExtent"])
+
+        foreach ($cmdletReference in $foundCmdlets) {
+            if ($AliasSpec.cmdlet.psobject.properties.match($cmdletReference.CommandName).Count) {
+                [int]$startLineNumber = $cmdletReference.StartLine
+                [int]$endLineNumber = $cmdletReference.EndLine
+                [int]$startColumnNumber = $cmdletReference.StartColumn
+                [int]$endColumnNumber = $cmdletReference.EndPosition
+                [string]$correction = $AliasSpec.cmdlet.($cmdletReference.CommandName)
+                [string]$filePath = $cmdletReference.FullPath
+                [string]$optionalDescription = 'The alias can be changed to be formal name.'
+
+                $c = (new-object Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.CorrectionExtent $startLineNumber, $endLineNumber, $startColumnNumber, $endColumnNumber, $correction, $filePath, $optionalDescription)
+                $l.Add($c)
+
+            }
+
+            if ($AliasSpec.para_cmdlet.psobject.properties.match($cmdletReference.CommandName).Count){
+                foreach ($para in $cmdletReference.parameters){
+                    if ($AliasSpec.para_cmdlet.($cmdletReference.CommandName).psobject.properties.match($para.Name).Count){
+                        [int]$startLineNumber = $para.StartLine
+                        [int]$endLineNumber = $para.EndLine
+                        [int]$startColumnNumber = $para.StartColumn
+                        [int]$endColumnNumber = $para.EndPosition
+                        [string]$correction = $AliasSpec.para_cmdlet.($cmdletReference.CommandName).($para.Name)
+                        [string]$filePath = $para.FullPath
+                        [string]$optionalDescription = 'The alias can be changed to be formal name.'
+
+                        $c = (new-object Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.CorrectionExtent $startLineNumber, $endLineNumber, $startColumnNumber, $endColumnNumber, $correction, $filePath, $optionalDescription)
+                        $l.Add($c)
+                    }
+                }
+            }
+        }
+
+
+
+        $extent = $null
+
+        #returned anaylse results
+        $dr = New-Object `
+            -Typename "Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.DiagnosticRecord" `
+            -ArgumentList "This is help", $extent, $PSCmdlet.MyInvocation.InvocationName, Warning, "MyRuleSuppressionID", $l
+        $dr.SuggestedCorrections = $l
+        $results += $dr
+        return $results
+    }
+}
+Export-ModuleMember -Function Measure*

vscode-extension/PSA_custom_Rules/Alias/geneAlias.ps1

@@ -0,0 +1,80 @@
+#generate the json file includes alias information
+
+$az_modules = gmo az.* -ListAvailable | Where-object {$_.Name -ne "Az.Tools.Migration"}
+for ([int]$i = 0; $i -lt $az_modules.Count; $i++){
+    import-module $az_modules[$i].name
+}
+
+$aliasResults = @{}
+
+$matchPattern = "(\b[a-zA-z]+-?[a-zA-z]+\b)"
+$matchPatternFormalName = "(\b[a-zA-z]+-?[Az][a-zA-z]+\b)"
+$cmdletRegex = New-Object System.Text.RegularExpressions.Regex($matchPattern)
+$cmdletRegexFormal = New-Object System.Text.RegularExpressions.Regex($matchPatternFormalName)
+$aliasCmdlets = get-alias | where-object {$cmdletRegex.IsMatch($_.Name) -and $cmdletRegexFormal.IsMatch($_.ReferencedCommand.Name)}
+
+for ([int]$i = 0; $i -lt $aliasCmdlets.Count; $i++){
+    $aliasCmdlet = $aliasCmdlets[$i]
+    $aliasResults[$aliasCmdlet.Name] = $aliasCmdlet.ReferencedCommand.Name
+}
+
+# $json = $aliasResults | ConvertTo-Json
+# $json > aliasTocmdlet.json
+
+
+
+class getBreakingchangeResult_paraCmdlet{
+    [System.String] $Name
+    [System.String] $TypeBreakingChange
+}
+
+$results = @{
+}
+
+$results["updateTime"] = Get-Date
+$results["cmdlet"] = $aliasResults
+$results["para_cmdlet"] = @{}
+
+ $results["updateTime"] = $results["updateTime"].ToString()
+
+
+
+for ([int]$i = 0; $i -lt $az_modules.Count; $i++){
+
+    # import-module $az_modules[$i].name
+    $module = get-module $az_modules[$i].name
+
+    $exportedCmdlets = $module.ExportedCmdlets
+
+    foreach ($key in $exportedCmdlets.Keys){
+        $Cmdlet = $exportedCmdlets[$key]
+
+        #attributes of parameters in cmdlet
+        $results["para_cmdlet"][$Cmdlet.Name] = @{}
+
+        foreach ($parameter_key in $Cmdlet.Parameters.keys){
+            $parameter = $Cmdlet.Parameters[$parameter_key]
+
+            for ([int]$j = 0; $j -lt $parameter.Aliases.Count; $j++){
+                $paraAlias = $parameter.Aliases[$j]
+                $paraFormal = $parameter_key
+                $results["para_cmdlet"][$Cmdlet.Name][$paraAlias] = $paraFormal
+            }
+
+
+
+
+        }
+
+
+
+
+    }
+
+
+
+}
+$json = $results | ConvertTo-Json -depth 10
+$json > AliasSpec.json
+
+