Vscode-powershell: PSAvoidUsingDoubleQuotesForConstantString doesn't work

[revolter]

System Details

System Details Output

### VSCode version: 1.53.2 622cb03f7e070a9670c94bae1a45d78d7181fbd4 x64

### VSCode extensions:
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]
[email protected]


### PSES version: 2.2.0.0

### PowerShell version:

Name                           Value
----                           -----
PSVersion                      7.1.2
PSEdition                      Core
GitCommitId                    7.1.2
OS                             Darwin 20.3.0 Darwin Kernel Version 20.3.0: Thu Jan 21 00:07:06 PST 2021; root:xnu-7195.81.3~1/RELEASE_X86_64
Platform                       Unix
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1
WSManStackVersion              3.0

Issue Description

I am experiencing a problem with PSAvoidUsingDoubleQuotesForConstantString not working.

Expected Behaviour

It should print

RuleName                            Severity     ScriptName Line  Message
--------                            --------     ---------- ----  -------
PSAvoidUsingDoubleQuotesForConstant Information  Test.ps1   1     Use single quotes when a string is constant.
String

Actual Behaviour

No problem is reported.

Also, running:

Invoke-ScriptAnalyzer -Path Test.ps1 -Settings PSScriptAnalyzerSettings.psd1

or

Invoke-ScriptAnalyzer -Path Test.ps1 -Settings PSScriptAnalyzerSettings.psd1 -Severity Information

doesn't print anything.

Attached Logs

Here are the files: 1614203961.zip.

[rjmholt]

Is this a problem you're only seeing in the Integrated Console in VSCode, or are you also seeing it in an ordinary pwsh console?

[revolter]

Both.

[revolter]

Wait, I thought you asked something else. Running Invoke-ScriptAnalyzer after pwsh prints:

Invoke-ScriptAnalyzer: The term 'Invoke-ScriptAnalyzer' is not recognized as a name of a cmdlet, function, script file, or executable program.
Check the spelling of the name, or if a path was included, verify that the path is correct and try again.

[revolter]

I had to install it. Running in iTerm works:

PS /Users/revolt/1614203961> Invoke-ScriptAnalyzer -Path Test.ps1 -Settings PSScriptAnalyzerSettings.psd1 -Severity Information

RuleName                            Severity     ScriptName Line  Message
--------                            --------     ---------- ----  -------
PSAvoidUsingDoubleQuotesForConstant Information  Test.ps1   1     Use single quotes when a string is constant.
String

[rjmholt]

What are the contents of Test.ps1?

[rjmholt]

And what's in your PSScriptAnalyzerSettings.psd1?

[revolter]

It's in the zip file from the issue description, but here is it again:

$asd = "asd"

Write-Output $asd

[revolter]

That file is in there as well, but here is it again:

@{
    Severity = @('Error', 'Warning', 'Information')
    Rules = @{
        PSAvoidUsingDoubleQuotesForConstantString = @{
            Enable = $true
        }
    }
}

[rjmholt]

In both the Integrated Console and in iTerm, what are the results of:

• $PSVersionTable
• gmo PSScriptAnalyzer

[rjmholt]

FWIW I'm also seeing this behaviour in the ordinary non-integrated console:

[revolter]

Integrated Console:

PS /Users/revolt/1614203961> $PSVersionTable


Name                           Value
----                           -----
PSVersion                      7.1.2
PSEdition                      Core
GitCommitId                    7.1.2
OS                             Darwin 20.3.0 Darwin Kernel Version 20.3.0: Thu Jan 21 00:07:06 PST 2021; root:xnu-7195.81.3~1/RELEASE_X86_64
Platform                       Unix
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1
WSManStackVersion              3.0

PS /Users/revolt/1614203961> gmo PSScriptAnalyzer


ModuleType Version    PreRelease Name                                ExportedCommands
---------- -------    ---------- ----                                ----------------
Script     1.19.0                PSScriptAnalyzer                    {Get-ScriptAnalyzerRule, Invoke-Formatter, Invoke-ScriptAnalyzer}

iTerm:

PS /Users/revolt/1614203961> $PSVersionTable

Name                           Value
----                           -----
PSVersion                      7.1.2
PSEdition                      Core
GitCommitId                    7.1.2
OS                             Darwin 20.3.0 Darwin Kernel Version 20.3.0: Thu Jan 21 00:07:06 PST 2021; root:xnu-7195.81.3~1/RELEASE_X86_64
Platform                       Unix
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1
WSManStackVersion              3.0

PS /Users/revolt/1614203961> gmo PSScriptAnalyzer

ModuleType Version    PreRelease Name                                ExportedCommands
---------- -------    ---------- ----                                ----------------
Script     1.19.1                PSScriptAnalyzer                    {Get-ScriptAnalyzerRule, Invoke-Formatter, Invoke-ScriptAnalyzer}

[revolter]

It looks like Visual Studio Code is using 1.19.0.

[rjmholt]

Upgrading from PSScriptAnalyzer 1.19.0 to 1.19.1 fixed this for me. I suspect when you installed the module to use in iTerm you got the newest version.

Now that you have that installed on your machine, try restarting your integrated console and running the command again. The extension should pick up the latest version from the module path.

[rjmholt]

This newer version of PSScriptAnalyzer will also be shipped by default in the next release of the extension too (it shipped in the new preview yesterday)

[revolter]

try restarting your integrated console

But I completely restarted Visual Studio Code before. Shouldn't that have been enough?

Also, running gmo PSScriptAnalyzer doesn't print anything now. Do you know why?

[revolter]

I ran the Invoke-ScriptAnalyzer and then gmo PSScriptAnalyzer again and now it does print

ModuleType Version    PreRelease Name                                ExportedCommands
---------- -------    ---------- ----                                ----------------
Script     1.19.1                PSScriptAnalyzer                    {Get-ScriptAnalyzerRule, Invoke-Formatter, Invoke-ScriptAnalyzer}

And yes, the problem is now reported, thanks for the help!

[rjmholt]

But I completely restarted Visual Studio Code before. Shouldn't that have been enough?

After you installed the new module in iTerm, a reload of the Integrated Console will pick that up. That's the difference.

Also, running gmo PSScriptAnalyzer doesn't print anything now. Do you know why?

The module won't be loaded until you import it or autoload it by running a command from it. Running Invoke-ScriptAnalyzer autoloaded it, so then gmo succeeded.