Use interpolated strings 5 by CarloToso · Pull Request #18982 · PowerShell/PowerShell · GitHub

PR Summary

Replace string.Format() with new string.Create((IFormatProvider? provider, [InterpolatedStringHandlerArgument(nameof(provider))] ref DefaultInterpolatedStringHandler handler).

PR Context

#18974

PR Checklist

PR has a meaningful title
- Use the present tense and imperative mood when describing your changes
Summarized changes
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.
Breaking changes
- None
- OR
- Experimental feature(s) needed
  - Experimental feature name(s):
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
Tooling
- I have considered the user experience from a tooling perspective and don't believe tooling will be impacted.
- OR
- I have considered the user experience from a tooling perspective and opened an issue in the relevant tool repository. This may include:
  - Impact on PowerShell Editor Services which is used in the PowerShell extension for VSCode
    (which runs in a different PS Host).
    - Issue filed:
  - Impact on Completions (both in the console and in editors) - one of PowerShell's most powerful features.
    - Issue filed:
  - Impact on PSScriptAnalyzer (which provides linting & formatting in the editor extensions).
    - Issue filed:
  - Impact on EditorSyntax (which provides syntax highlighting with in VSCode, GitHub, and many other editors).
    - Issue filed:

CarloToso Something wrong in the PR (module manifest test fails). Need investigate.

This PR has 50 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       : +24 -26
Percentile : 20%

Total files changed: 14

Change summary by file extension:
.cs : +24 -26

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.

What could we use to replace streamWriter.NewLine?

Environment.NewLine but only for test. If you think this is a root of issue revert the change to string.Format.

NewModuleManifestCommand.cs is the problem (after we merge #18996 and #18997 we can close this PR)

14 files

47982f2

CarloToso requested a review from Paul Higinbotham (PaulHigin) as a code owner January 19, 2023 18:11

ghost assigned Dongbo Wang (daxian-dbw) Jan 19, 2023

fix error

71a99ce

pull-request-quantifier-deprecated Bot added the Small label Jan 19, 2023

Ilya (iSazonov) closed this Jan 20, 2023

Ilya (iSazonov) reopened this Jan 20, 2023

Ilya (iSazonov) reviewed Jan 20, 2023

View reviewed changes

Comment thread src/System.Management.Automation/engine/Modules/ModuleCmdletBase.cs Outdated

Add suggestion, revert 2 to try find error

fb9e632

pull-request-quantifier-deprecated Bot added Extra Small and removed Small labels Jan 20, 2023

CarloToso commented Jan 20, 2023

View reviewed changes

This was referenced Jan 20, 2023

Use interpolated strings 5b #18996

Merged

Use interpolated strings 5c #18997

Merged

CarloToso closed this Jan 21, 2023

CarloToso deleted the Use-interpolated-strings-split-5 branch January 21, 2023 13:47

Use interpolated strings 5 by CarloToso · Pull Request #18982 · PowerShell/PowerShell · GitHub

Uh oh!

Use interpolated strings 5 - #18982

Use interpolated strings 5#18982
CarloToso wants to merge 3 commits into
PowerShell:masterfrom
CarloToso:Use-interpolated-strings-split-5

CarloToso commented Jan 19, 2023

Uh oh!

Ilya (iSazonov) left a comment

Uh oh!

Uh oh!

pull-request-quantifier-deprecated Bot commented Jan 20, 2023

Uh oh!

CarloToso Jan 20, 2023

Uh oh!

Ilya (iSazonov) Jan 20, 2023 •
edited
Loading

Uh oh!

Uh oh!

CarloToso Jan 21, 2023 •
edited
Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

                       private string ManifestFragmentForNonSpecifiedManifestMember(string key, string resourceString, string value, StreamWriter streamWriter)
                       {
-                          return string.Format(CultureInfo.InvariantCulture, "{0}# {1}{2}{0}# {3:19} = {4}{2}{2}",
-                              _indent, resourceString, streamWriter.NewLine, key, value);

Use interpolated strings 5 by CarloToso · Pull Request #18982 · PowerShell/PowerShell · GitHub

Uh oh!

Use interpolated strings 5 - #18982

Use interpolated strings 5#18982CarloToso wants to merge 3 commits intoPowerShell:masterPowerShell/PowerShell:masterfrom CarloToso:Use-interpolated-strings-split-5CarloToso/PowerShell:Use-interpolated-strings-split-5Copy head branch name to clipboard

Conversation

CarloToso commented Jan 19, 2023

PR Summary

PR Context

PR Checklist

Uh oh!

Ilya (iSazonov) left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

pull-request-quantifier-deprecated Bot commented Jan 20, 2023

What can I do to optimize my changes

How to interpret the change counts in git diff output

Uh oh!

CarloToso Jan 20, 2023

Choose a reason for hiding this comment

Uh oh!

Ilya (iSazonov) Jan 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

CarloToso Jan 21, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Use interpolated strings 5#18982
CarloToso wants to merge 3 commits into
PowerShell:masterfrom
CarloToso:Use-interpolated-strings-split-5

Ilya (iSazonov) Jan 20, 2023 •
edited
Loading

CarloToso Jan 21, 2023 •
edited
Loading