Title: PSSA should have a new rule to check for properly used Process blocks · Issue #1571 · PowerShell/PSScriptAnalyzer · GitHub
Open Graph Title: PSSA should have a new rule to check for properly used Process blocks · Issue #1571 · PowerShell/PSScriptAnalyzer
X Title: PSSA should have a new rule to check for properly used Process blocks · Issue #1571 · PowerShell/PSScriptAnalyzer
Description: For some cases the formatter is changing code where it cannot run. Rules that trigger this are: PSUseConsistentWhitespace.CheckParameter when $True PSAvoidUsingCmdletAliases when $True The source script triggering this bug is not valid, ...
Open Graph Description: For some cases the formatter is changing code where it cannot run. Rules that trigger this are: PSUseConsistentWhitespace.CheckParameter when $True PSAvoidUsingCmdletAliases when $True The source s...
X Description: For some cases the formatter is changing code where it cannot run. Rules that trigger this are: PSUseConsistentWhitespace.CheckParameter when $True PSAvoidUsingCmdletAliases when $True The source s...
Opengraph URL: https://github.com/PowerShell/PSScriptAnalyzer/issues/1571
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"PSSA should have a new rule to check for properly used Process blocks","articleBody":"For some cases the formatter is changing code where it cannot run. Rules that trigger this are:\r\n\r\n- `PSUseConsistentWhitespace.CheckParameter` when `$True`\r\n- `PSAvoidUsingCmdletAliases` when `$True`\r\n\r\nThe source script triggering this bug is not valid, however\r\n\r\n- the `PSAvoidUsingCmdletAliases`: `pwsh` **will execute** this with no errors (It runs normally, it never assigns `$x`)\r\n- the `CheckParameter`: This code is broken, `pwsh` **will not execute** this\r\n\r\n### Possible Cause of `PSAvoidUsingCmdletAliases`\r\n\r\n>From the docs: If your function defines a `Begin`, `Process` or `End` block, all of your code must reside inside those blocks. No code will be recognized outside the blocks if any of the blocks are defined.\r\n\r\nI think the cause is the script reaches a statement that is not inside a `begin/process/end` block -- so it assumes the function is a non-pipeline function. In that context, `process` is not a keyword but an identifier. It replaces `process` with `Get-Process` (which would the correct behavior if it was a normal function)\r\n\r\n`Invoke-ScriptAnalyzer` has the same behavior. \r\n\r\n\r\n\r\n### Potential fix for `PSAvoidUsingCmdletAliases` ?\r\n\r\n- PSSA should have a rule to check for functions that have code outside `begin/process/end` blocks. \r\n- Can the parser test if there are any `begin/process/end` statements, then treat it as a pipeline function?\r\n- Can the formatter abort if errors occur? (Right now there's no errors on mutation)\r\n\r\nSteps to reproduce\r\n------------------\r\n\r\n```PowerShell\r\n$script = @'\r\nfunction Do-Stuff {\r\n$x = 2\r\nProcess { }\r\n}\r\n'@\r\n$scriptFixed = @'\r\nfunction Do-Stuff {\r\n#$x = 2\r\nProcess { }\r\n}\r\n'@\r\n\r\n$settings = @{\r\n IncludeRules = @('PSUseCorrectCasing', 'PSUseConsistentIndentation')\r\n Rules = @{\r\n PSAvoidUsingCmdletAliases = @{\r\n Enable = $false\r\n }\r\n PSUseConsistentIndentation = @{\r\n Enable = $true\r\n Kind = 'space'\r\n PipelineIndentation = 'IncreaseIndentationAfterEveryPipeline'\r\n IndentationSize = 4\r\n }\r\n\r\n }\r\n}\r\n\r\nInvoke-Formatter -ScriptDefinition $script -Settings $settings\r\nInvoke-Formatter -ScriptDefinition $scriptFixed -Settings $settings\r\n```\r\n\r\nExpected behavior\r\n-----------------\r\n\r\nIndent and replace aliases. \r\n\r\n```ps1\r\nfunction Do-Stuff {\r\n $x = 2\r\n Process { }\r\n}\r\n\r\nfunction Do-Stuff {\r\n #$x = 2\r\n Process { }\r\n}\r\n```\r\n\r\nActual behavior\r\n---------------\r\n\r\nIndent, and replaces keyword as if it was not in the keyword context.\r\n\r\n```ps1\r\nfunction Do-Stuff {\r\n $x = 2\r\n Get-Process { }\r\n}\r\n\r\nfunction Do-Stuff {\r\n #$x = 2\r\n Process { }\r\n}\r\n```\r\n\r\n### Another example not using pipeline functions\r\n\r\nSteps to reproduce\r\n------------------\r\n\r\n```\r\n$Original = @'\r\nFunction BadCode {\r\n \"stuff\" | Format-CodeColor\" 'ps1'\r\n\r\n $InputList | ForEach-Object {\r\n } | Select-Object -First 2\r\n | Join-String -sep \", \" -OutputPrefix 'Results: '\r\n}\r\n'@\r\n\r\n$settings = @{\r\n IncludeRules = @(\r\n \"PSUseConsistentWhitespace\"\r\n )\r\n Rules = @{\r\n PSUseConsistentWhitespace = @{\r\n Enable = $True\r\n CheckParameter = $false\r\n }\r\n }\r\n}\r\n\r\n$out1 = Invoke-Formatter -ScriptDefinition $Original -Settings $settings\r\n\r\n$settings.rules.PSUseConsistentWhitespace.CheckParameter = $True\r\n$out2 = Invoke-Formatter -ScriptDefinition $Original -Settings $settings\r\n\r\n$out1\r\n'+' * 30\r\n$out2\r\n\r\nif ($out1 -ne $out2) {\r\n Write-Error 'formatting does not match'\r\n}\r\n```\r\n\r\nExpected behavior 2\r\n-----------------\r\n\r\nGive an error, or don't mutate code\r\n\r\nActual behavior 2\r\n---------------\r\n\r\n```powershell\r\nFunction BadCode {\r\n \"`nPS> Top | Bot | Se\" -OutputPrefix 'Results: '\r\n}\r\n```\r\n\r\nEnvironment data\r\n----------------\r\n\r\n\u003c!-- Provide the output of the following 2 commands -->\r\n\r\n```PowerShell\r\n>> $PSVersionTable | ft\r\n\r\nName Value\r\n---- -----\r\nPSVersion 7.0.3\r\nPSEdition Core\r\nGitCommitId 7.0.3\r\nOS Microsoft Windows 10.0.19041\r\nPlatform Win32NT\r\nPSCompatibleVersions {1.0, 2.0, 3.0, 4.0…}\r\nPSRemotingProtocolVersion 2.3\r\nSerializationVersion 1.1.0.1\r\nWSManStackVersion 3.0\r\n\r\n>> (Get-Module -ListAvailable PSScriptAnalyzer).Version | ForEach-Object { $_.ToString() }\r\n\r\n1.19.1\r\n\r\n>> $psEditor | select EditorServicesVersion\r\n\r\nEditorServicesVersion\r\n---------------------\r\n2.3.0.0\r\n\r\n```\r\n\r\n","author":{"url":"https://github.com/jbolton-corvalgroup","@type":"Person","name":"jbolton-corvalgroup"},"datePublished":"2020-08-16T23:58:08Z","url":"https://github.com/PowerShell/PSScriptAnalyzer/issues/1571"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:f748732e-cf3b-6fb5-b166-90304cb5eed7 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | A6A6:218437:3A54C2:4CF373:6AFCE749 |
| html-safe-nonce | 28474ec380a67770db850561168914cfc2ed5b705d88a48b4cae174f82124c05 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJBNkE2OjIxODQzNzozQTU0QzI6NENGMzczOjZBRkNFNzQ5IiwidmlzaXRvcl9pZCI6IjE1NTk1MzkwMzExMTUzNjAwNzMiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | e1db600241c9ffb1a67f2057eeeec1d0533181c2dc2dd217b7e0153b435962ec |
| hovercard-subject-tag | issue:679853310 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/PowerShell/PSScriptAnalyzer/1571/issue_layout |
| twitter:image | https://opengraph.githubassets.com/f63706f680c5b592aaa99cde107f9afca159d87feb6abdda44b55a7de97f054c/PowerShell/PSScriptAnalyzer/issues/1571 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/f63706f680c5b592aaa99cde107f9afca159d87feb6abdda44b55a7de97f054c/PowerShell/PSScriptAnalyzer/issues/1571 |
| og:image:alt | For some cases the formatter is changing code where it cannot run. Rules that trigger this are: PSUseConsistentWhitespace.CheckParameter when $True PSAvoidUsingCmdletAliases when $True The source s... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | jbolton-corvalgroup |
| hostname | github.com |
| expected-hostname | github.com |
| None | 99aede4c5f55ec5cf06666a8c9e03ebf9f85f7231223e7f1c38c16e5504835b3 |
| turbo-cache-control | no-preview |
| go-import | github.com/PowerShell/PSScriptAnalyzer git https://github.com/PowerShell/PSScriptAnalyzer.git |
| octolytics-dimension-user_id | 11524380 |
| octolytics-dimension-user_login | PowerShell |
| octolytics-dimension-repository_id | 33149177 |
| octolytics-dimension-repository_nwo | PowerShell/PSScriptAnalyzer |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 33149177 |
| octolytics-dimension-repository_network_root_nwo | PowerShell/PSScriptAnalyzer |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | ecfd63ca125ec74b42f74eeb158b3fa081c8c497 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width