Title: Help output formatting is not tolerant of StrictMode · Issue #10562 · PowerShell/PowerShell · GitHub
Open Graph Title: Help output formatting is not tolerant of StrictMode · Issue #10562 · PowerShell/PowerShell
X Title: Help output formatting is not tolerant of StrictMode · Issue #10562 · PowerShell/PowerShell
Description: There is a PowerShell module at work which has a MAML help file (.dll-Help.xml). While the help content seemed to show up okay for some colleagues, it did not show up well for me. I would see content like: PS C:\Users\jazzdelightsme> ope...
Open Graph Description: There is a PowerShell module at work which has a MAML help file (.dll-Help.xml). While the help content seemed to show up okay for some colleagues, it did not show up well for me. I would see conte...
X Description: There is a PowerShell module at work which has a MAML help file (.dll-Help.xml). While the help content seemed to show up okay for some colleagues, it did not show up well for me. I would see conte...
Opengraph URL: https://github.com/PowerShell/PowerShell/issues/10562
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Help output formatting is not tolerant of StrictMode","articleBody":"\u003c!--\r\n\r\nFor Windows PowerShell 5.1 issues, suggestions, or feature requests please use the following link instead:\r\nWindows PowerShell [UserVoice](https://windowsserver.uservoice.com/forums/301869-powershell)\r\n\r\nThis repository is **ONLY** for PowerShell Core 6 issues.\r\n\r\n- Make sure you are able to repro it on the [latest released version](https://github.com/PowerShell/PowerShell/releases)\r\n- Search the existing issues.\r\n- Refer to the [FAQ](https://github.com/PowerShell/PowerShell/blob/master/docs/FAQ.md).\r\n- Refer to the [known issues](https://docs.microsoft.com/powershell/scripting/whats-new/known-issues-ps6?view=powershell-6).\r\n\r\n-->\r\nThere is a PowerShell module at work which has a MAML help file (.dll-Help.xml). While the help content seemed to show up okay for some colleagues, it did not show up well for me. I would see content like:\r\n\r\n```none\r\nPS C:\\Users\\jazzdelightsme> open-foo -?\r\n\r\nNAME\r\n Open-Foo\r\n\r\nSYNOPSIS\r\n Opens a new connection to a foo.\r\n\r\n\r\nSYNTAX\r\n Open-Foo [-FooName] \u003cstring> [\u003cCommonParameters>]\r\n\r\n Open-Foo [\u003cCommonParameters>]\r\n\r\n Open-Foo [\u003cCommonParameters>]\r\n\r\n Open-Foo [\u003cCommonParameters>]\r\n\r\n\r\nDESCRIPTION\r\n Lorem ipsum dolor blah blah blah ...\r\n\r\n\r\nRELATED LINKS\r\n\r\nREMARKS\r\n To see the examples, type: \"get-help Open-Foo -examples\".\r\n For more information, type: \"get-help Open-Foo -detailed\".\r\n For technical information, type: \"get-help Open-Foo -full\".\r\n\r\n\r\nPS C:\\Users\\jazzdelightsme>\r\n\r\n```\r\n\r\nAfter some troubleshooting, I found that this was due to the fact that I `Set-StrictMode -Version Latest` in my `$profile` script. It turns out there is some script run during formatting of help output, and the MAML was perhaps not as complete as it should be. I discovered clues in `$error`, like:\r\n\r\n```none\r\nThe property 'required' cannot be found on this object. Verify that the property exists.\r\nAt line:1 char:1\r\n+ $optional = $_.required -ne 'true'\r\n+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\r\n+ CategoryInfo : NotSpecified: (:) [], PropertyNotFoundException\r\n+ FullyQualifiedErrorId : PropertyNotFoundStrict\r\n```\r\n\r\nThis can be worked around by filling out the MAML a bit more, but it is rather large, and hand-tweaking MAML is not my idea of a good time. (I'm not sure if the MAML was originally hand-crafted, or some tool was used, or what, but it's quite old.)\r\n\r\nPerhaps help formatting could be upgraded to be more tolerant of StrictMode errors?\r\n\r\nIn fact, it seems that *some* help formatting script already does this. See [here](https://github.com/PowerShell/PowerShell/blob/4af3068566b2218bc37ea19785ded589c2a5c42f/src/System.Management.Automation/FormatAndOutput/DefaultFormatters/HelpV3_format_ps1xml.cs#L127)--the script includes a call to `Set-StrictMode -Off`:\r\n\r\n```csharp\r\n var RelatedLinksHelpInfoControl = CustomControl.Create()\r\n .StartEntry()\r\n .StartFrame(leftIndent: 4)\r\n .AddScriptBlockExpressionBinding(StringUtil.Format(@\"Set-StrictMode -Off\r\nif (($_.relatedLinks -ne $()) -and ($_.relatedLinks.navigationLink -ne $()) -and ($_.relatedLinks.navigationLink.Length -ne 0))\r\n```\r\n\r\nSee also: #6497\r\n\r\n# Environment data\r\n\r\n\u003c!-- provide the output of $PSVersionTable -->\r\n\r\n```none\r\nName Value\r\n---- -----\r\nPSVersion 7.0.0-preview.3\r\nPSEdition Core\r\nGitCommitId 7.0.0-preview.3\r\nOS Microsoft Windows 10.0.18985\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","author":{"url":"https://github.com/jazzdelightsme","@type":"Person","name":"jazzdelightsme"},"datePublished":"2019-09-17T11:16:29Z","url":"https://github.com/PowerShell/PowerShell/issues/10562"}
| 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:611d08e0-c50d-f511-819c-d962a2dc4c26 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | B180:28C95D:25EEF21:34EA681:6AFD4481 |
| html-safe-nonce | 9872d4d05496a5a99200b4c8f651090315df8db8a39077c03bc6a5f6223cdd9c |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCMTgwOjI4Qzk1RDoyNUVFRjIxOjM0RUE2ODE6NkFGRDQ0ODEiLCJ2aXNpdG9yX2lkIjoiMzQ5MjM5NzMxMzU4ODgwNjc4NSIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 73683ae00866d884d7c45dbdf0cac12143c2b6d5c192260e48aad3dae8012f65 |
| hovercard-subject-tag | issue:494560063 |
| 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/PowerShell/10562/issue_layout |
| twitter:image | https://opengraph.githubassets.com/fe0623832364026a350028bde43b4db1433ee464be3b6394998feb1425d5cc22/PowerShell/PowerShell/issues/10562 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/fe0623832364026a350028bde43b4db1433ee464be3b6394998feb1425d5cc22/PowerShell/PowerShell/issues/10562 |
| og:image:alt | There is a PowerShell module at work which has a MAML help file (.dll-Help.xml). While the help content seemed to show up okay for some colleagues, it did not show up well for me. I would see conte... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | jazzdelightsme |
| hostname | github.com |
| expected-hostname | github.com |
| None | bdbacc25b921224ff0befcb9e629560a1255be51aec9991d6e3f95b5e9151474 |
| turbo-cache-control | no-preview |
| go-import | github.com/PowerShell/PowerShell git https://github.com/PowerShell/PowerShell.git |
| octolytics-dimension-user_id | 11524380 |
| octolytics-dimension-user_login | PowerShell |
| octolytics-dimension-repository_id | 49609581 |
| octolytics-dimension-repository_nwo | PowerShell/PowerShell |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 49609581 |
| octolytics-dimension-repository_network_root_nwo | PowerShell/PowerShell |
| 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 | 556dd37bb0aceffb25724e151b5d858b3265b40b |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width