Add "`foreach` with `Write-Progress`" snippet #4423

ian-mor · 2023-02-17T02:57:57Z

PR Summary

Add a foreach loop snippet which includes Write-Progress already initialized. This helps streamline the setup and monitoring of a long-running process.

PR Checklist

Note: Tick the boxes below that apply to this pull request by putting an x between the square brackets.
Please mark anything not applicable to this PR NA.

PR has a meaningful title
Summarized changes
PR has tests
This PR is ready to merge and is not work in progress
- If the PR is work in progress, please add the prefix WIP: to the beginning of the title and remove the prefix when the PR is ready

ian-mor · 2023-02-17T03:01:03Z

@microsoft-github-policy-service agree

ian-mor · 2023-02-18T00:39:12Z

@ian-mor please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
@microsoft-github-policy-service agree [company="{your company}"]
Options:

(default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
(when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

Definitions.
“Code” means the computer software code, whether in human-readable or machine-executable form,
that is delivered by You to Microsoft under this Agreement.
“Project” means any of the projects owned or managed by Microsoft and offered under a license
approved by the Open Source Initiative (www.opensource.org).
“Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
Project, including but not limited to communication on electronic mailing lists, source code control
systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
discussing and improving that Project, but excluding communication that is conspicuously marked or
otherwise designated in writing by You as “Not a Submission.”
“Submission” means the Code and any other copyrightable material Submitted by You, including any
associated comments and documentation.

Your Submission. You must agree to the terms of this Agreement before making a Submission to any
Project. This Agreement covers any and all Submissions that You, now or in the future (except as
described in Section 4 below), Submit to any Project.

Originality of Work. You represent that each of Your Submissions is entirely Your original work.
Should You wish to Submit materials that are not Your original work, You may Submit them separately
to the Project if You (a) retain all copyright and license information that was in the materials as You
received them, (b) in the description accompanying Your Submission, include the phrase “Submission
containing materials of a third party:” followed by the names of the third party and any licenses or other
restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
guidelines concerning Submissions.

Your Employer. References to “employer” in this Agreement include Your employer or anyone else
for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
Submission is made in the course of Your work for an employer or Your employer has intellectual
property rights in Your Submission by contract or applicable law, You must secure permission from Your
employer to make the Submission before signing this Agreement. In that case, the term “You” in this
Agreement will refer to You and the employer collectively. If You change employers in the future and
desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
and secure permission from the new employer before Submitting those Submissions.

Licenses.

Copyright License. You grant Microsoft, and those who receive the Submission directly or
indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
parties.

Patent License. You grant Microsoft, and those who receive the Submission directly or
indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
Your patent claims that are necessarily infringed by the Submission or the combination of the
Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
import or otherwise dispose of the Submission alone or with the Project.

Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
granted by implication, exhaustion, estoppel or otherwise.

Representations and Warranties. You represent that You are legally entitled to grant the above
licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
have disclosed under Section 3). You represent that You have secured permission from Your employer to
make the Submission in cases where Your Submission is made in the course of Your work for Your
employer or Your employer has intellectual property rights in Your Submission by contract or applicable
law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.

Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
You later become aware that would make Your representations in this Agreement inaccurate in any
respect.

Information about Submissions. You agree that contributions to Projects and information about
contributions may be maintained indefinitely and disclosed publicly, including Your name and other
information that You submit with Your Submission.

Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
defenses of lack of personal jurisdiction and forum non-conveniens.

Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
supersedes any and all prior agreements, understandings or communications, written or oral, between
the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

@microsoft-github-policy-service agree

ghost · 2023-04-14T17:32:24Z

@ian-mor please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
@microsoft-github-policy-service agree [company="{your company}"]
Options:

(default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
(when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

andyleejordan

Hey @ian-mor, is this still a work-in-progress or ready for review?

ian-mor · 2023-08-29T11:18:59Z

@andyleejordan, apologies. This is ready for review.

JustinGrote

Looks good to me otherwise!

snippets/PowerShell.json

JustinGrote

Looks good to me otherwise!

JustinGrote · 2024-01-30T01:18:23Z

@ian-mor thanks for your submission and sorry it took so long to get to. It looks pretty good to me, just a minor nit about where count should go.

I also think "your code goes here" should be part of the final tabstop, so when you start typing it just replaces it, otherwise doing a bunch of snippets now sees a bunch of "your code goes here" comments.

JustinGrote · 2024-01-30T01:19:43Z

snippets/PowerShell.json

+		  "Foreach ($${2:item} in $${1:array}) {",
+		  "    \\$progPercent = \"{0:n2}\" -f ([math]::round(\\$i/\\$total,4) * 100)",
+		  "    Write-Progress -Activity \"${3:activityName}\" -Status \"\\$i of \\$total - \\$progPercent% Complete:\" -PercentComplete \\$progPercent",
+		  "    # Insert Code Here",


{0} tabstop should include the Insert Code Here comment so when you start typing it overwrites it

andyleejordan · 2024-09-04T20:56:56Z

@ian-mor @JustinGrote would love to get this in; is that last suggested change either blocking or something that could get merged in beforehand?

JustinGrote · 2024-09-04T21:04:09Z

I don't really recall but I don't think it's a deal breaker, especially since Snippets are just UI and we can always fix-forward.

Co-authored-by: Justin Grote <JustinGrote@users.noreply.github.com>

Changes done

snippets/PowerShell.json

--------- Co-authored-by: Ian Morozoff <ian@ssfcu.org> Co-authored-by: Justin Grote <JustinGrote@users.noreply.github.com> Co-authored-by: Andy Jordan <2226434+andyleejordan@users.noreply.github.com>

WIP: Add Foreach with Status snippet

a88c546

ian-mor requested a review from a team as a code owner February 17, 2023 02:57

andyleejordan reviewed Apr 14, 2023

View reviewed changes

ghost mentioned this pull request Apr 14, 2023

 PowerShell/PowerShell#19512

Closed

andyleejordan marked this pull request as draft April 26, 2023 18:09

ian-mor added 2 commits June 6, 2023 21:56

Merge branch 'PowerShell:main' into snippet-foreach-progress

da8fc71

Merge branch 'PowerShell:main' into snippet-foreach-progress

afabf8e

ian-mor changed the title ~~WIP: Add Foreach with Progress snippet~~ Add Foreach with Progress snippet Aug 29, 2023

ian-mor marked this pull request as ready for review August 29, 2023 11:19

andyleejordan force-pushed the main branch from c3b49cc to 9d8d8a4 Compare November 16, 2023 00:26

JustinGrote self-requested a review January 30, 2024 01:07

JustinGrote self-assigned this Jan 30, 2024

JustinGrote added the Area-Snippets label Jan 30, 2024

Merge branch 'main' into snippet-foreach-progress

bff9179

JustinGrote requested changes Jan 30, 2024

View reviewed changes

snippets/PowerShell.json Outdated Show resolved Hide resolved

JustinGrote previously requested changes Jan 30, 2024

View reviewed changes

JustinGrote reviewed Jan 30, 2024

View reviewed changes

andyleejordan force-pushed the main branch 4 times, most recently from f73c9ad to a544102 Compare February 14, 2024 23:05

andyleejordan force-pushed the main branch from b50d068 to f6f9f07 Compare April 26, 2024 03:14

andyleejordan force-pushed the main branch from 5869d96 to 0093415 Compare May 3, 2024 23:05

andyleejordan force-pushed the main branch 2 times, most recently from 486e86e to ef038c8 Compare June 6, 2024 23:17

ian-mor and others added 2 commits October 1, 2024 21:33

Merge branch 'main' into snippet-foreach-progress

7222ba6

Update total handling in foreach-progress snip

995039e

Co-authored-by: Justin Grote <JustinGrote@users.noreply.github.com>

ian-mor requested a review from JustinGrote October 2, 2024 02:43

andyleejordan approved these changes Oct 7, 2024

View reviewed changes

andyleejordan changed the title ~~Add Foreach with Progress snippet~~ Add "foreach with Write-Progress" snippet Oct 7, 2024

andyleejordan reviewed Oct 7, 2024

View reviewed changes

snippets/PowerShell.json Outdated Show resolved Hide resolved

Update snippets/PowerShell.json

978ca37

andyleejordan enabled auto-merge October 7, 2024 21:37

andyleejordan added this pull request to the merge queue Oct 7, 2024

Merged via the queue into PowerShell:main with commit 5f8a641 Oct 7, 2024
4 checks passed

ian-mor deleted the snippet-foreach-progress branch October 22, 2024 04:38

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add "`foreach` with `Write-Progress`" snippet #4423

Add "`foreach` with `Write-Progress`" snippet #4423

ian-mor commented Feb 17, 2023 •

edited

Loading

ian-mor commented Feb 17, 2023

ian-mor commented Feb 18, 2023

Contribution License Agreement

ghost commented Apr 14, 2023

andyleejordan left a comment

ian-mor commented Aug 29, 2023

JustinGrote left a comment

JustinGrote left a comment

JustinGrote commented Jan 30, 2024

JustinGrote Jan 30, 2024

andyleejordan commented Sep 4, 2024

JustinGrote commented Sep 4, 2024

Add "foreach with Write-Progress" snippet #4423

Add "foreach with Write-Progress" snippet #4423

Conversation

ian-mor commented Feb 17, 2023 • edited Loading

PR Summary

PR Checklist

ian-mor commented Feb 17, 2023

ian-mor commented Feb 18, 2023

Contribution License Agreement

ghost commented Apr 14, 2023

andyleejordan left a comment

Choose a reason for hiding this comment

ian-mor commented Aug 29, 2023

JustinGrote left a comment

Choose a reason for hiding this comment

JustinGrote left a comment

Choose a reason for hiding this comment

JustinGrote commented Jan 30, 2024

JustinGrote Jan 30, 2024

Choose a reason for hiding this comment

andyleejordan commented Sep 4, 2024

JustinGrote commented Sep 4, 2024

Add "`foreach` with `Write-Progress`" snippet #4423

Add "`foreach` with `Write-Progress`" snippet #4423

ian-mor commented Feb 17, 2023 •

edited

Loading