Как работать с System.Manangement.Automation.Language ... ast - PullRequest
0 голосов
/ 14 апреля 2020

Итак, я пытаюсь создать собственное правило PsAnalyzer для офиса, и я впервые использую команды / переменные на основе $ast. В результате я немного растерялся.

Я использовал несколько сайтов, чтобы разобраться с классом объектов [System.Management.Automation.Language], а именно this , this и this .

В целях тестирования я использую приведенную ниже функцию - хитро выглядящие параметры.

Function IE { 

[cmdletbinding()]

Param( 
    $Url,
    $IEWIDTH  = 550,
    $IeHeight = 450 
)


$IE = new-object -comobject InternetExplorer.Application

$IE.top  = 200 ; $IE.width      = $IEWIDTH ; $IE.height  = $IEHEIGHT
$IE.Left = 100 ; $IE.AddressBar = $FALSE   ; $IE.visible = $TRUE
$IE.navigate( "file:///$Url" )

}

Затем с код ниже, я бы ожидал $IEWIDTH в качестве единственного параметра, который потерпит неудачу.

Function Measure-PascalCase {
<#
.SYNOPSIS
The variables names should be in PascalCase.
.DESCRIPTION
Variable names should use a consistent capitalization style, i.e. : PascalCase.
.EXAMPLE
Measure-PascalCase -ScriptBlockAst $ScriptBlockAst
.INPUTS
[System.Management.Automation.Language.ScriptBlockAst]
.OUTPUTS
[Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.DiagnosticRecord[]]
.NOTES
https://msdn.microsoft.com/en-us/library/dd878270(v=vs.85).aspx
https://msdn.microsoft.com/en-us/library/ms229043(v=vs.110).aspx
https://mathieubuisson.github.io/create-custom-rule-psscriptanalyzer/
#>

[CmdletBinding()]
[OutputType([Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.DiagnosticRecord[]])]
Param
(
    [Parameter(Mandatory = $True)]
    [ValidateNotNullOrEmpty()]
    [System.Management.Automation.Language.ScriptBlockAst]
    $ScriptBlockAst
)

Process {

    $Results = @()

    try {
        #region Define predicates to find ASTs.

        [ScriptBlock]$Predicate = {
            Param ([System.Management.Automation.Language.Ast]$Ast)

            [bool]$ReturnValue = $false

            if ( $Ast -is [System.Management.Automation.Language.ParameterAst] ){

                [System.Management.Automation.Language.ParameterAst]$VariableAst = $Ast

                if ( $VariableAst.Left.VariablePath.UserPath -eq 'i' ){
                    $ReturnValue = $false
                } elseif ( $VariableAst.Left.VariablePath.UserPath.Length -eq 3 ){
                    $ReturnValue = $false
                } elseif ($VariableAst.Left.VariablePath.UserPath -cnotmatch '^([A-Z][a-z]+)+$') {
                    $ReturnValue = $True
                }

            }

            return $ReturnValue
        }
        #endregion

        #region Finds ASTs that match the predicates.
        [System.Management.Automation.Language.Ast[]]$Violations = $ScriptBlockAst.FindAll($Predicate, $True)

        If ($Violations.Count -ne 0) {

            Foreach ($Violation in $Violations) {

                $Result = New-Object `
                        -Typename "Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic.DiagnosticRecord" `
                        -ArgumentList "$((Get-Help $MyInvocation.MyCommand.Name).Description.Text)",$Violation.Extent,$PSCmdlet.MyInvocation.InvocationName,Information,$Null

                $Results += $Result
            }
        }
        return $Results
        #endregion
    }
    catch {
        $PSCmdlet.ThrowTerminatingError($_)
    }
}
}
Export-ModuleMember -Function Measure-*

Вместо этого я получаю:

Line Extent          Message                                                                        
---- ------          -------                                                                        
6 $Url            Variable names should use a consistent capitalization style, i.e. : PascalCase.
7 $IEWIDTH  = 550 Variable names should use a consistent capitalization style, i.e. : PascalCase.
8 $IeHeight = 450 Variable names should use a consistent capitalization style, i.e. : PascalCase.
6 $Url            Variable names should use a consistent capitalization style, i.e. : PascalCase.
7 $IEWIDTH  = 550 Variable names should use a consistent capitalization style, i.e. : PascalCase.
8 $IeHeight = 450 Variable names should use a consistent capitalization style, i.e. : PascalCase.

Любые идеи о том, что я делаю неправильно? Я нашел другой сайт здесь , если я использую этот метод для тестирования отдельных переменных одновременно, я получаю результаты, которые ожидаю увидеть.

Для этого добавьте следующую строку в конце функции IE,

[System.Management.Automation.Language.Parser]::ParseInput($MyInvocation.MyCommand.ScriptContents, [ref]$null, [ref]$null)

Тогда этот код ниже даст вам числа длины.

$stuffast = .\FunctionIe.ps1

$left = $Stuffast.FindAll({$args[0] -is [System.Management.Automation.Language.AssignmentStatementAst]},$true) 

$left[0].Left.Extent.Text.Length

$left[0].Left.VariablePath.UserPath.Length

1 Ответ

1 голос
/ 14 апреля 2020

В отличие от AssignmentStatementAst, который имеет свойство значения Left и Right (- hand), ParameterAst имеет свойство Name и DefaultValue, поэтому вы захотите использовать Name в вашем блоке предикатов:

$predicate = {
    # ...
    if ( $Ast -is [System.Management.Automation.Language.ParameterAst] ) {

        [System.Management.Automation.Language.ParameterAst]$VariableAst = $Ast

        if ( $VariableAst.Name.VariablePath.UserPath -eq 'i' ) {
            $ReturnValue = $false
        }
        elseif ( $VariableAst.Name.VariablePath.UserPath.Length -eq 3 ) {
            $ReturnValue = $false
        }
        elseif ($VariableAst.Name.VariablePath.UserPath -cnotmatch '^([A-Z][a-z]+)+$') {
            $ReturnValue = $True
        }
    }
    # ...
}

Либо переверните логи-предикаты c, чтобы найти VariableExpressionAst, где родительский узел - один из AssignmentStatementAst или ParameterAst:

$predicate = {
  param($ast)

  $ValidParents = @(
    [System.Management.Automation.Language.ParameterAst]
    [System.Management.Automation.Language.AssignmentStatementAst]
  )

  if($ast -is [VariableExpressionAst] -and $ValidParents.Where({$ast -is $_}, 'First')){
    [System.Management.Automation.Language.VariableExpressionAst]$variableAst = $ast

    # inspect $variableAst.VariablePath here
  }

  return $false
}
Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...