Skip to content

Add -CommandWithArgs parameter to pwsh #18726

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
PaulHigin merged 4 commits into from
Jan 5, 2023
Merged

Add -CommandWithArgs parameter to pwsh #18726

PaulHigin merged 4 commits into from
Jan 5, 2023

Conversation

@SteveL-MSFT
Copy link
Member

@SteveL-MSFT SteveL-MSFT commented Dec 5, 2022 •
edited
Loading

PR Summary

There are situations where you want to run a PS pipeline from pwsh -c, but need to provide arguments. This adds a new -CommandWithArgs parameter where the first string is the command and subsequent space delimited strings are arguments.

This is advertised as an Experimental Feature, but is not code fenced. It reuses the arg parsing logic as -File so that switch parameters can be turned off. This makes the diff look a bit more complex than it is as the arg parsing code was moved from ParseFile() to a separate CollectPSArgs() method.

PR Context

Fix #15417

PR Checklist

@ghost ghost assigned PaulHigin Dec 5, 2022
@SteveL-MSFT SteveL-MSFT mentioned this pull request Dec 5, 2022
Closed
2 tasks
iSazonov
iSazonov reviewed Dec 6, 2022
View reviewed changes
michaeltlombardi
michaeltlombardi suggested changes Dec 6, 2022
View reviewed changes
Copy link
Contributor

@michaeltlombardi michaeltlombardi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Made a minor note about the existing docs to fix a typo and some grammar. Looking over the PR, do I understand correctly that this parameter works even if the experimental feature isn't enabled?

Follow up questions, if that's the case:

  1. Should the parameter documentation itself note that this is experimental functionality, especially since it may be removed in the future?
  2. This documentation is shown at the command line even when the feature isn't enabled, correct?

@ghost ghost added Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept and removed Waiting on Author The PR was reviewed and requires changes or comments from the author before being accept labels Dec 6, 2022
@SteveL-MSFT SteveL-MSFT closed this Dec 8, 2022
@SteveL-MSFT SteveL-MSFT reopened this Dec 8, 2022
@pull-request-quantifier-deprecated
Copy link

pull-request-quantifier-deprecated bot commented Dec 8, 2022

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

Quantification details 

Label      : Medium
Size       : +75 -31
Percentile : 41.2%

Total files changed: 5

Change summary by file extension:
.cs : +44 -30
.resx : +14 -1
.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 detected.
  • 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.

@iSazonov iSazonov added the CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log label Dec 13, 2022
@ghost ghost added the Review - Needed The PR is being reviewed label Dec 21, 2022
@ghost
Copy link

ghost commented Dec 21, 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

@PaulHigin PaulHigin merged commit 9ea887f into PowerShell:master Jan 5, 2023
@ghost ghost removed the Review - Needed The PR is being reviewed label Jan 5, 2023
@SteveL-MSFT SteveL-MSFT deleted the console-commandwithargs branch January 6, 2023 00:24
@mklement0 mklement0 mentioned this pull request Jan 13, 2023
Closed
@adityapatwardhan
Copy link
Member

adityapatwardhan commented Feb 1, 2023 •
edited by unfurl-links bot
Loading

@SteveL-MSFT I believe new experimental features should be added to the following files:

https://github.com/PowerShell/PowerShell/blob/master/experimental-feature-windows.json
https://github.com/PowerShell/PowerShell/blob/master/experimental-feature-linux.json

GitHub
PowerShell for every system! Contribute to PowerShell/PowerShell development by creating an account on GitHub.
GitHub
PowerShell for every system! Contribute to PowerShell/PowerShell development by creating an account on GitHub.

@ghost
Copy link

ghost commented Mar 14, 2023

🎉v7.4.0-preview.2 has been released which incorporates this pull request.:tada:

Handy links:

@ghost ghost mentioned this pull request Mar 14, 2023
Closed
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

@anmenaga anmenaga Awaiting requested review from anmenaga

+2 more reviewers

@michaeltlombardi michaeltlombardi michaeltlombardi requested changes

@PaulHigin PaulHigin PaulHigin approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@PaulHigin PaulHigin

Labels

CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log Medium

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Feature Request: Support passing command line args with -Command option.

5 participants

@SteveL-MSFT @adityapatwardhan @PaulHigin @michaeltlombardi @iSazonov