René's URL Explorer Experiment


Title: Inconsistent and unclear error messaging · Issue #10056 · PowerShell/PowerShell · GitHub

Open Graph Title: Inconsistent and unclear error messaging · Issue #10056 · PowerShell/PowerShell

X Title: Inconsistent and unclear error messaging · Issue #10056 · PowerShell/PowerShell

Description: When a user provides an invalid value to a parameter, the error message that they receive should be crystal clear. Today, that is not the case. For example, consider these empty command definitions: function Test-Mandatory { param( [Para...

Open Graph Description: When a user provides an invalid value to a parameter, the error message that they receive should be crystal clear. Today, that is not the case. For example, consider these empty command definitions...

X Description: When a user provides an invalid value to a parameter, the error message that they receive should be crystal clear. Today, that is not the case. For example, consider these empty command definitions...

Opengraph URL: https://github.com/PowerShell/PowerShell/issues/10056

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Inconsistent and unclear error messaging","articleBody":"When a user provides an invalid value to a parameter, the error message that they receive should be crystal clear. Today, that is not the case. For example, consider these empty command definitions:\r\n\r\n```powershell\r\nfunction Test-Mandatory {\r\n    param(\r\n        [Parameter(Mandatory, ParameterSetName='StringTest')]\r\n        [string]\r\n        $String,\r\n\r\n        [Parameter(Mandatory, ParameterSetName='ObjectTest')]\r\n        [object]\r\n        $Object\r\n    )\r\n}\r\n\r\nfunction Test-Validator {\r\n    param(\r\n        [ValidateNotNullOrEmpty()]\r\n        [string]\r\n        $String,\r\n\r\n        [ValidateNotNull()]\r\n        [object]\r\n        $Object\r\n    )\r\n}\r\n```\r\n\r\nWhen a parameter is marked as `Mandatory`, if it's a string, it cannot be empty. If it's a non-value type object, it cannot be null. That's built in behavior. Command authors can also add `ValidatNotNullOrEmpty` or `ValidateNotNull` validators that ensure that a parameter is not null or empty, or not null, respectively. These are more or less the same thing: logic to ensure that non-null or non-empty values are provided to parameters; however, the error messages returned to users are not consistent and not necessarily as clear as they should be. Below are some command invocations along with the errors that are produced in PowerShell Core 6.2.1 today. Note that these are just the error message -- the command name, position and other details have been stripped.\r\n\r\n|Command|Error Message|\r\n|--|--|\r\n|`Test-Mandatory -String $null`|`Cannot bind argument to parameter 'String' because it is an empty string.`|\r\n|`Test-Mandatory -Object $null`|`Cannot bind argument to parameter 'Object' because it is null.`|\r\n|`Test-Validator -String $null`|`Cannot validate argument on parameter 'String'. The argument is null or empty. Provide an argument that is not null or empty, and then try the command again.`|\r\n|`Test-Validator -Object $null`|`Cannot validate argument on parameter 'Object'. The argument is null. Provide a valid value for the argument, and then try running the command again.`|\r\n\r\nThe message that each of these errors tries to convey to the caller is that they provided an invalid value into a parameter, and sometimes they suggest what should be done while encouraging them to try again. Unfortunately, the error message that appears does not actually convey that message very well.\r\n\r\n`Cannot bind argument to parameter...`\r\n\r\nWhile it is true that the parameter binder was unable to bind the value provided to a certain parameter, the end user doesn't need to know those technical details.\r\n\r\n`Cannot validate argument on parameter...`\r\n\r\nThese error messages are misleading, and could sound like PowerShell was unable to perform the validation on a parameter value.\r\n\r\n`...because it is an empty string.`\r\n\r\nThis does not properly cover the case where `$null` is accidentally passed into a mandatory string parameter, which is not helpful to end users.\r\n\r\nAlso, the `Mandatory` error messages do not suggest the user try again, but the `Validator` error messages do.\r\n\r\nIn all cases, these error messages should be clear, consistent, and since PowerShell is used interactively in a shell, directed towards the end user so that they can more easily correct the problem.\r\n\r\nI propose that we change the error messages for the commands shown above to the messages shown below instead.\r\n\r\n|Command|Error Message|\r\n|--|--|\r\n|`Test-Mandatory -String $null`|`The null or empty value provided for the 'String' parameter is invalid. Try running the command again with a value for the 'String' parameter that is not null or empty.`|\r\n|`Test-Mandatory -Object $null`|`The null value provided for the 'Object' parameter is invalid. Try running the command again with a value for the 'Object' parameter that is not null.`|\r\n|`Test-Validator -String $null`|`The null or empty value provided for the 'String' parameter is invalid. Try running the command again with a value for the 'String' parameter that is not null or empty.`|\r\n|`Test-Validator -Object $null`|`The null value provided for the 'Object' parameter is invalid. Try running the command again with a value for the 'Object' parameter that is not null.`|\r\n\r\nThese messages are targeted towards the end user who is invoking the command, consistent regardless of whether the parameter is `Mandatory` or using a `ValidateNotNull` or `ValidateNotNullOrEmpty` validator, they clearly identify the problem, and they tell the user what to do to fix the problem.\r\n\r\nBetter, yes?\r\n\r\n# Environment data\r\n\r\n```none\r\nName                           Value\r\n----                           -----\r\nPSVersion                      6.2.1\r\nPSEdition                      Core\r\nGitCommitId                    6.2.1\r\nOS                             Microsoft Windows 10.0.17763\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/KirkMunro","@type":"Person","name":"KirkMunro"},"datePublished":"2019-07-03T16:36:38Z","url":"https://github.com/PowerShell/PowerShell/issues/10056"}

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:a09aab45-e13b-76c8-d4d0-1d279183c940
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-idC8D2:25F138:169B50:1EA310:6AFD4E57
html-safe-nonce95e865a79c1b28eb15b9dcf88733f4c1d1edd287a21b5b97cb1114d9f40fc6e8
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJDOEQyOjI1RjEzODoxNjlCNTA6MUVBMzEwOjZBRkQ0RTU3IiwidmlzaXRvcl9pZCI6IjM0MTMzNTUwOTM0MTAyNzA4MDciLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ==
visitor-hmac09c701b679f031332076dedb9e45b9626c8f2736a469e265aa70a7ffccd3a733
hovercard-subject-tagissue:463849976
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/10056/issue_layout
twitter:imagehttps://opengraph.githubassets.com/300b888156bcdef91665e5f8b85315b5c250d52707b95a0399e2c0e47ae603f8/PowerShell/PowerShell/issues/10056
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/300b888156bcdef91665e5f8b85315b5c250d52707b95a0399e2c0e47ae603f8/PowerShell/PowerShell/issues/10056
og:image:altWhen a user provides an invalid value to a parameter, the error message that they receive should be crystal clear. Today, that is not the case. For example, consider these empty command definitions...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernameKirkMunro
hostnamegithub.com
expected-hostnamegithub.com
None66653c2e55a6fff2930be1bdf07ee4f8aa137e3956d056c822563be6f878755e
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
releaseb6f01f7cb9f35f8c09949773241a3d49dd04b340
ui-targetfull
theme-color#1e2327
color-schemelight dark
react-app-nameissues

Links:

Skip to contenthttps://github.com/PowerShell/PowerShell/issues/10056#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2FPowerShell%2FPowerShell%2Fissues%2F10056
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%2F10056
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/10056
Reloadhttps://github.com/PowerShell/PowerShell/issues/10056
Reloadhttps://github.com/PowerShell/PowerShell/issues/10056
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/10056
New issuehttps://github.com/login?return_to=https://github.com/PowerShell/PowerShell/issues/10056
Inconsistent and unclear error messaginghttps://github.com/PowerShell/PowerShell/issues/10056#top
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-No ActivityIssue has had no activity for 6 months or morehttps://github.com/PowerShell/PowerShell/issues?q=state%3Aopen%20label%3A%22Resolution-No%20Activity%22
WG-Enginecore PowerShell engine, interpreter, and runtimehttps://github.com/PowerShell/PowerShell/issues?q=state%3Aopen%20label%3A%22WG-Engine%22
https://github.com/KirkMunro
Kirk Munro (KirkMunro)https://github.com/KirkMunro
on Jul 3, 2019https://github.com/PowerShell/PowerShell/issues/10056#issue-463849976
Kirk Munro (KirkMunro)https://github.com/KirkMunro
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 Jul 3, 2019https://github.com/PowerShell/PowerShell/issues/10056#event-2458180145
https://github.com/iSazonov
Ilya (iSazonov)https://github.com/iSazonov
on Jul 4, 2019https://github.com/PowerShell/PowerShell/issues/10056#issuecomment-508526056
https://github.com/KirkMunro
Kirk Munro (KirkMunro)https://github.com/KirkMunro
on Jul 4, 2019https://github.com/PowerShell/PowerShell/issues/10056#issuecomment-508535966
Ilya (iSazonov)https://github.com/iSazonov
WG-Enginecore PowerShell engine, interpreter, and runtimehttps://github.com/PowerShell/PowerShell/issues?q=state%3Aopen%20label%3A%22WG-Engine%22
on Oct 13, 2019https://github.com/PowerShell/PowerShell/issues/10056#event-2708785253
https://github.com/apps/microsoft-github-policy-service
microsoft-github-policy-servicehttps://github.com/apps/microsoft-github-policy-service
on Nov 16, 2023https://github.com/PowerShell/PowerShell/issues/10056#issuecomment-1813813162
Microsoft GitHub Policy Servicehttps://aka.ms/1es-gitops
microsoft-github-policy-servicehttps://github.com/apps/microsoft-github-policy-service
Resolution-No ActivityIssue has had no activity for 6 months or morehttps://github.com/PowerShell/PowerShell/issues?q=state%3Aopen%20label%3A%22Resolution-No%20Activity%22
on Nov 16, 2023https://github.com/PowerShell/PowerShell/issues/10056#event-10975843040
https://github.com/apps/microsoft-github-policy-service
microsoft-github-policy-servicehttps://github.com/apps/microsoft-github-policy-service
on Nov 23, 2023https://github.com/PowerShell/PowerShell/issues/10056#issuecomment-1824369386
Microsoft GitHub Policy Servicehttps://aka.ms/1es-gitops
microsoft-github-policy-servicehttps://github.com/apps/microsoft-github-policy-service
completedhttps://github.com/PowerShell/PowerShell/issues?q=is%3Aissue%20state%3Aclosed%20archived%3Afalse%20reason%3Acompleted
on Nov 23, 2023https://github.com/PowerShell/PowerShell/issues/10056#event-11047269199
Sign up for freehttps://github.com/signup?return_to=https://github.com/PowerShell/PowerShell/issues/10056
Sign in to commenthttps://github.com/login?return_to=https://github.com/PowerShell/PowerShell/issues/10056
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-No ActivityIssue has had no activity for 6 months or morehttps://github.com/PowerShell/PowerShell/issues?q=state%3Aopen%20label%3A%22Resolution-No%20Activity%22
WG-Enginecore PowerShell engine, interpreter, and runtimehttps://github.com/PowerShell/PowerShell/issues?q=state%3Aopen%20label%3A%22WG-Engine%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.