René's URL Explorer Experiment


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

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@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-profiling0
react-import-mapreact,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-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:611d08e0-c50d-f511-819c-d962a2dc4c26
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-idB180:28C95D:25EEF21:34EA681:6AFD4481
html-safe-nonce9872d4d05496a5a99200b4c8f651090315df8db8a39077c03bc6a5f6223cdd9c
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCMTgwOjI4Qzk1RDoyNUVFRjIxOjM0RUE2ODE6NkFGRDQ0ODEiLCJ2aXNpdG9yX2lkIjoiMzQ5MjM5NzMxMzU4ODgwNjc4NSIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9
visitor-hmac73683ae00866d884d7c45dbdf0cac12143c2b6d5c192260e48aad3dae8012f65
hovercard-subject-tagissue:494560063
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/PowerShell/PowerShell/10562/issue_layout
twitter:imagehttps://opengraph.githubassets.com/fe0623832364026a350028bde43b4db1433ee464be3b6394998feb1425d5cc22/PowerShell/PowerShell/issues/10562
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/fe0623832364026a350028bde43b4db1433ee464be3b6394998feb1425d5cc22/PowerShell/PowerShell/issues/10562
og:image:altThere 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:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernamejazzdelightsme
hostnamegithub.com
expected-hostnamegithub.com
Nonebdbacc25b921224ff0befcb9e629560a1255be51aec9991d6e3f95b5e9151474
turbo-cache-controlno-preview
go-importgithub.com/PowerShell/PowerShell git https://github.com/PowerShell/PowerShell.git
octolytics-dimension-user_id11524380
octolytics-dimension-user_loginPowerShell
octolytics-dimension-repository_id49609581
octolytics-dimension-repository_nwoPowerShell/PowerShell
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id49609581
octolytics-dimension-repository_network_root_nwoPowerShell/PowerShell
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release556dd37bb0aceffb25724e151b5d858b3265b40b
ui-targetfull
theme-color#1e2327
color-schemelight dark
react-app-nameissues

Links:

Skip to contenthttps://github.com/PowerShell/PowerShell/issues/10562#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2FPowerShell%2FPowerShell%2Fissues%2F10562
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2FPowerShell%2FPowerShell%2Fissues%2F10562
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=PowerShell%2FPowerShell
Reloadhttps://github.com/PowerShell/PowerShell/issues/10562
Reloadhttps://github.com/PowerShell/PowerShell/issues/10562
Reloadhttps://github.com/PowerShell/PowerShell/issues/10562
PowerShellhttps://github.com/PowerShell
PowerShellhttps://github.com/PowerShell/PowerShell
Codehttps://github.com/PowerShell/PowerShell
Issues1.3k (1.3k)https://github.com/PowerShell/PowerShell/issues
Pull requests365 (365)https://github.com/PowerShell/PowerShell/pulls
Discussionshttps://github.com/PowerShell/PowerShell/discussions
Actionshttps://github.com/PowerShell/PowerShell/actions
Projectshttps://github.com/PowerShell/PowerShell/projects
Security and quality3 (3)https://github.com/PowerShell/PowerShell/security
Insightshttps://github.com/PowerShell/PowerShell/insights
https://github.com/PowerShell/PowerShell
New issuehttps://github.com/login?return_to=https://github.com/PowerShell/PowerShell/issues/10562
New issuehttps://github.com/login?return_to=https://github.com/PowerShell/PowerShell/issues/10562
#10563https://github.com/PowerShell/PowerShell/pull/10563
Help output formatting is not tolerant of StrictModehttps://github.com/PowerShell/PowerShell/issues/10562#top
#10563https://github.com/PowerShell/PowerShell/pull/10563
Issue-Questionideally support can be provided via other mechanisms, but sometimes folks do open an issue to get ahttps://github.com/PowerShell/PowerShell/issues?q=state%3Aopen%20label%3A%22Issue-Question%22
Resolution-FixedThe issue is fixed.https://github.com/PowerShell/PowerShell/issues?q=state%3Aopen%20label%3A%22Resolution-Fixed%22
WG-Interactive-HelpSystemhelp infrastructure and formatting of helphttps://github.com/PowerShell/PowerShell/issues?q=state%3Aopen%20label%3A%22WG-Interactive-HelpSystem%22
https://github.com/jazzdelightsme
Dan Thompson (jazzdelightsme)https://github.com/jazzdelightsme
on Sep 17, 2019https://github.com/PowerShell/PowerShell/issues/10562#issue-494560063
herehttps://github.com/PowerShell/PowerShell/blob/4af3068566b2218bc37ea19785ded589c2a5c42f/src/System.Management.Automation/FormatAndOutput/DefaultFormatters/HelpV3_format_ps1xml.cs#L127
#6497https://github.com/PowerShell/PowerShell/issues/6497
Dan Thompson (jazzdelightsme)https://github.com/jazzdelightsme
Issue-Questionideally support can be provided via other mechanisms, but sometimes folks do open an issue to get ahttps://github.com/PowerShell/PowerShell/issues?q=state%3Aopen%20label%3A%22Issue-Question%22
on Sep 17, 2019https://github.com/PowerShell/PowerShell/issues/10562#event-2639504695
Dan Thompson (jazzdelightsme)https://github.com/jazzdelightsme
on Sep 17, 2019https://github.com/PowerShell/PowerShell/issues/10562#event-2639616389
Tweak help formatting script to be more StrictMode toleranthttps://github.com/jazzdelightsme/PowerShell/commit/92f802b87f34703f5c3a2c52d0476dd75c40f9d7
92f802bhttps://github.com/jazzdelightsme/PowerShell/commit/92f802b87f34703f5c3a2c52d0476dd75c40f9d7
Ilya (iSazonov)https://github.com/iSazonov
WG-Interactive-HelpSystemhelp infrastructure and formatting of helphttps://github.com/PowerShell/PowerShell/issues?q=state%3Aopen%20label%3A%22WG-Interactive-HelpSystem%22
on Sep 17, 2019https://github.com/PowerShell/PowerShell/issues/10562#event-2640696529
Aditya Patwardhan (adityapatwardhan)https://github.com/adityapatwardhan
completedhttps://github.com/PowerShell/PowerShell/issues?q=is%3Aissue%20state%3Aclosed%20archived%3Afalse%20reason%3Acompleted
#10563https://github.com/PowerShell/PowerShell/pull/10563
on Oct 4, 2019https://github.com/PowerShell/PowerShell/issues/10562#event-2685833886
Ilya (iSazonov)https://github.com/iSazonov
Resolution-FixedThe issue is fixed.https://github.com/PowerShell/PowerShell/issues?q=state%3Aopen%20label%3A%22Resolution-Fixed%22
on Oct 29, 2019https://github.com/PowerShell/PowerShell/issues/10562#event-2752368255
Sign up for freehttps://github.com/signup?return_to=https://github.com/PowerShell/PowerShell/issues/10562
Sign in to commenthttps://github.com/login?return_to=https://github.com/PowerShell/PowerShell/issues/10562
Issue-Questionideally support can be provided via other mechanisms, but sometimes folks do open an issue to get ahttps://github.com/PowerShell/PowerShell/issues?q=state%3Aopen%20label%3A%22Issue-Question%22
Resolution-FixedThe issue is fixed.https://github.com/PowerShell/PowerShell/issues?q=state%3Aopen%20label%3A%22Resolution-Fixed%22
WG-Interactive-HelpSystemhelp infrastructure and formatting of helphttps://github.com/PowerShell/PowerShell/issues?q=state%3Aopen%20label%3A%22WG-Interactive-HelpSystem%22
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.