Skip to content

Fix parameter completion when script requirements fail #17687

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 8 commits into from
Mar 7, 2025
Merged

Fix parameter completion when script requirements fail #17687

merged 8 commits into from
Mar 7, 2025

Conversation

MartinGC94
Copy link
Contributor

@MartinGC94 MartinGC94 commented Jul 14, 2022 •
edited
Loading

PR Summary

Allows tab completion for parameters to continue working when script requirements like #requires -RunAsAdministrator fail due to the current session not meeting the script requirements.

PR Context

Fixes #4549

PR Checklist

@MartinGC94 MartinGC94 requested a review from daxian-dbw as a code owner July 14, 2022 22:21
@pull-request-quantifier-deprecated
Copy link

This PR has 36 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

Quantification details 

Label      : Extra Small
Size       : +31 -5
Percentile : 14.4%

Total files changed: 5

Change summary by file extension:
.cs : +14 -5
.ps1 : +17 -0

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

  • Fast and predictable releases to production:
    • Optimal size changes are more likely to be reviewed faster with fewer
      iterations.
    • Similarity in low PR complexity drives similar review times.
  • Review quality is likely higher as complexity is lower:
    • Bugs are more likely to be detected.
    • Code inconsistencies are more likely to be detetcted.
  • Knowledge sharing is improved within the participants:
    • Small portions can be assimilated better.
  • Better engineering practices are exercised:
    • Solving big problems by dividing them in well contained, smaller problems.
    • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

  • Use the PullRequestQuantifier to quantify your PR accurately
    • Create a context profile for your repo using the context generator
    • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
    • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
    • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
  • Change your engineering behaviors
    • For PRs that fall outside of the desired spectrum, review the details and check if:
      • Your PR could be split in smaller, self-contained PRs instead
      • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

  • One line was added: +1 -0
  • One line was deleted: +0 -1
  • One line was modified: +1 -1 (git diff doesn't know about modified, it will
    interpret that line like one addition plus one deletion)
  • Change percentiles: Change characteristics (addition, deletion, modification)
    of this PR in relation to all other PRs within the repository.

Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

@ghost ghost assigned PaulHigin Jul 14, 2022
@MartinGC94
Copy link
Contributor Author

Looking at the test failures, I guess we can't just ignore those errors in every scenario. I assumed I could because Experimental and hidden param attributes are ignored.
One solution could be to only ignore errors for type constraints but that won't help scenarios where scripts are using an attribute that hasn't been loaded yet.
Are there any other solutions?

@iSazonov iSazonov added the WG-Interactive-IntelliSense tab completion label Jul 15, 2022
@iSazonov
Copy link
Collaborator

WG discussion tag.

On the one hand it makes sense to have more freedom with #requires -RunAsAdministrator or hidden scenarios for example, but on the other hand I don't see the point of doing this for types that are not loaded.

@ghost ghost added the Review - Needed The PR is being reviewed label Jul 22, 2022
@ghost
Copy link

ghost commented Jul 22, 2022

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

iSazonov
iSazonov reviewed Dec 20, 2022
View reviewed changes
@daxian-dbw
Copy link
Member

@MartinGC94 Sorry for taking so long to review. Can you please resolve the conflicts for this PR?

@ghost ghost removed the Review - Needed The PR is being reviewed label Apr 25, 2023
@ghost ghost added the Review - Needed The PR is being reviewed label May 3, 2023
@ghost
Copy link

ghost commented May 3, 2023

This pull request has been automatically marked as Review Needed because it has been there has not been any activity for 7 days.
Maintainer, please provide feedback and/or mark it as Waiting on Author

@iSazonov
Copy link
Collaborator

@MartinGC94 Please resolve merge conflicts and rebase.

@microsoft-github-policy-service microsoft-github-policy-service bot removed the Review - Needed The PR is being reviewed label Feb 26, 2025
@iSazonov iSazonov assigned iSazonov and unassigned PaulHigin Feb 26, 2025
@iSazonov iSazonov added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Feb 26, 2025
@MartinGC94
Copy link
Contributor Author

I reverted the compiler changes as I don't think that's the right solution for that problem. So now this PR is only about the #requires completion fix.

iSazonov
iSazonov reviewed Feb 26, 2025
View reviewed changes
iSazonov
iSazonov approved these changes Mar 3, 2025
View reviewed changes
@iSazonov iSazonov self-requested a review March 3, 2025 18:53
MartinGC94 and others added 2 commits March 3, 2025 21:27
@iSazonov
Copy link
Collaborator

iSazonov commented Mar 7, 2025

/azp run

@azure-pipelines Azure Pipelines
Copy link

Azure Pipelines successfully started running 2 pipeline(s).

@iSazonov iSazonov changed the title Fix parameter completion for invalid scripts Fix parameter completion when script requirements fail Mar 7, 2025
@iSazonov iSazonov enabled auto-merge (squash) March 7, 2025 04:11
@iSazonov iSazonov merged commit f7ae422 into PowerShell:master Mar 7, 2025
39 of 41 checks passed
@microsoft-github-policy-service Microsoft GitHub Policy Service
Copy link
Contributor

microsoft-github-policy-service bot commented Mar 7, 2025 •
edited by unfurl-links bot
Loading

📣 Hey @MartinGC94, how did we do? We would love to hear your feedback with the link below! 🗣️

🔗 https://aka.ms/PSRepoFeedback

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@iSazonov iSazonov iSazonov approved these changes

@daxian-dbw daxian-dbw Awaiting requested review from daxian-dbw

@SeeminglyScience SeeminglyScience Awaiting requested review from SeeminglyScience

Assignees

@iSazonov iSazonov

Labels
CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log Extra Small WG-Interactive-IntelliSense tab completion
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Parameter completion should work even when #requires fails
4 participants
@MartinGC94 @iSazonov @daxian-dbw @PaulHigin