GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Move CommandNotFoundException suggestion to an experimental feature by SteveL-MSFT · Pull Request #8805 · PowerShell/PowerShell

Conversation

@SteveL-MSFT

@SteveL-MSFT Steve Lee (SteveL-MSFT) commented Jan 31, 2019 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member

PR Summary

Make the suggestion on a CommandNotFoundException an ExperimentalFeature.

PR Context

The current design of suggestions is closely tied to the host (ConsoleHost in this case). The ConsoleHost checks if there was anything from the last command and initiates an evaluation of suggestions. The evaluation of suggestions checks if the last command failed by looking at $?. If so, then it applies each suggestion. In the case of CommandNotFound, this is based on looking at the ErrorRecord at $Error[0] which is one problem with the suggestion framework as it only looks at the most recent error. If found, it applies this new suggestion and it outputs the possible commands. The problem is if a script is run in the command line (or part of a pipeline), and the ErrorAction is SilentlyContinue, the error still shows up in $Error so the suggestion applies, but because you don't see the non-terminating error message, you have no context of how the suggestion applies.

A proper fix is much more complicated as it requires redesigning the suggestion framework:

  • Currently, suggestions are initiated by the host (consolehost in this case) and should be part of the ErrorRecord so that it works correctly remotely and in other hosts
  • ErrorRecord has a member called RecommendedAction that should contain the suggestion
  • The code to invoke getting suggestions needs to be moved out of consolehost and closer to where the ErrorRecord is created
  • Formatter for ErrorRecord needs to be updated to show the RecommendedAction member
  • Suggestions should be in its own stream or Information stream rather than written directly to the host

Temporary resolution to #8793

No test added/modified as suggestions are currently written directly to the host.

PR Checklist

  • PR has a meaningful title
    • Use the present tense and imperative mood when describing your changes
  • Summarized changes
  • Change is not breaking
  • Make sure all .h, .cpp, .cs, .ps1 and .psm1 files have the correct copyright header
  • This PR is ready to merge and is not Work in Progress.
    • If the PR is work in progress, please add the prefix WIP: or [ WIP ] to the beginning of the title (the WIP bot will keep its status check at Pending while the prefix is present) and remove the prefix when the PR is ready.
  • User-facing changes
    • Not Applicable
    • OR
    • Documentation needed
      • Issue filed:
  • Testing - New and feature
    • N/A or can only be tested interactively
    • OR
    • Make sure you've added a new test if existing tests do not effectively test the code changed
      • Add [feature] to your commit messages if the change is significant or affects feature tests

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@SteveL-MSFT
move CommandNotFoundException suggestion to an experimental feature
3b270b3
@SteveL-MSFT Steve Lee (SteveL-MSFT) assigned Andrew (anmenaga) Jan 31, 2019
@SteveL-MSFT
Steve Lee (SteveL-MSFT) requested review from Andrew (anmenaga) and Rob Holt (rjmholt) January 31, 2019 22:58
@SteveL-MSFT
Steve Lee (SteveL-MSFT) requested review from Bruce Payette (BrucePay) and Dongbo Wang (daxian-dbw) as code owners January 31, 2019 22:58
@SteveL-MSFT
address CodeFactor
aa23c3f
iSazonov
Ilya (iSazonov) approved these changes Feb 1, 2019
View reviewed changes
@SteveL-MSFT

Steve Lee (SteveL-MSFT) commented Feb 6, 2019

Copy link
Copy Markdown
Member Author

Andrew (@anmenaga) I believe we can merge this

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

anmenaga
Andrew (anmenaga) approved these changes Feb 6, 2019
View reviewed changes
@anmenaga
Andrew (anmenaga) merged commit d9be648 into PowerShell:master Feb 6, 2019
@anmenaga Andrew (anmenaga) added the CL-Experimental Indicates that a PR should be marked as an Experimental Feature in the Change Log label Feb 6, 2019
@SteveL-MSFT
Steve Lee (SteveL-MSFT) deleted the command-suggestion-experimental branch February 7, 2019 01:00
Thatgfsj (Thatgfsj) pushed a commit to Thatgfsj-contribs/PowerShell that referenced this pull request Aug 6, 2026
@SteveL-MSFT Andrew
Move CommandNotFoundException suggestion to an experimental feature (P…
4cd2305
…owerShell#8805)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@iSazonov Ilya (iSazonov) iSazonov approved these changes
@rjmholt Rob Holt (rjmholt) Awaiting requested review from rjmholt
@BrucePay Bruce Payette (BrucePay) Awaiting requested review from BrucePay
@daxian-dbw Dongbo Wang (daxian-dbw) Awaiting requested review from daxian-dbw
+1 more reviewer
@anmenaga Andrew (anmenaga) anmenaga approved these changes
Reviewers whose approvals may not affect merge requirements

Uh oh!

There was an error while loading. Please reload this page.

Assignees

@anmenaga Andrew (anmenaga)

Labels

CL-Experimental Indicates that a PR should be marked as an Experimental Feature in the Change Log

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

3 participants

@SteveL-MSFT @anmenaga @iSazonov
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.