Add Get-Karma function, rename Measure-Karma to Show-Karma #238

vexx32 · 2019-09-07T03:32:48Z

PR Summary

Restructure the module's main command(s) a bit.

Context

Measure-Karma is a bit of a misleading command name, as it is more of a display-only command. It is better if we have it labeled Show-Karma, and this gives us room to add Get-Karma which will simply return data, which can be used directly or consumed by other scripts and functions if the user desires.

Changes

Rename Measure-Karma to Show-Karma, leaving old name as an alias.
Add Get-Karma command.
Restructure Show-Karma to use `Get-Karma internally, and then simple make some extra calls as needed for more interactive functionality.
Added help documentation for Get-Karma and updated help documentation for various module cmdlets.
Update tests.

Checklist

Pull Request has a meaningful title.
Summarised changes.
Pull Request is ready to merge & is not WIP.
Added tests / only testable interactively.
- Make sure you add a new test if old tests do not effectively test the code changed.
Added documentation / opened issue to track adding documentation at a later date.

Function name more appropriate for purpose. Alias left behind for Measure-Karma for backwards-compatibility.

Move internal logic from Show-Karma to Get-Karma where reasonable

This adds a short sleep between each status check for Invoke-Koan. Constantly keeping tabs on the other thread is a waste of cpu.

Removed tests only applicable to Show-Karma Fixed mock & test conditions

steviecoaster

This all makes sense to me. I don't see anything glaringly wrong here.

✅ Update tests

vexx32 added PR-Needs-Review 🔍 Let's take a closer look! Category-Module Pertaining to the module's functionality itself. Category-Docs 📝 Pertaining to CBH, readme, other documentation labels Sep 7, 2019

vexx32 requested a review from steviecoaster as a code owner September 7, 2019 03:32

vexx32 added 16 commits September 7, 2019 09:08

🚚 Rename file before renaming function

4942774

💄 Rename Measure-Karma -> Show-Karma

17a0457

Function name more appropriate for purpose. Alias left behind for Measure-Karma for backwards-compatibility.

✨ Make Get-PSKoanFile a public function

537ffd8

📝 Update docs and doc links for Show-Karma

5ec6663

📝 Update Get-Blank docs

8c92721

📝 Update Register-Advice docs

f2c9026

📝 Update Reset-PSKoan docs

efdbb54

📝 Update help for Set-PSKoanLocation

c8a3b26

📝 Update help for Show-Advice

1957870

📝 add blank at EOF

71b62fa

📝 Update help uris

6ab9d31

✨ Add Get-Karma command

c071591

Move internal logic from Show-Karma to Get-Karma where reasonable

✅ Update Show-Karma tests

948a257

✅ Update Show-Karma tests

216f75c

✅ Add Get-Karma tests

67e1141

♻️ Use Get-PSKoanFile for completions

ee3af28

vexx32 force-pushed the Get-Karma branch from 2569e81 to ee3af28 Compare September 7, 2019 13:08

vexx32 added 4 commits September 7, 2019 09:55

🔧 Invoke-Koan needs to chill

2335ba8

This adds a short sleep between each status check for Invoke-Koan. Constantly keeping tabs on the other thread is a waste of cpu.

🎨 Remove some tabs in Get-Koan

9d4e658

🔧 Recurse into Get-Karma, not Show-Karma

7abfb75

✅ Fix failing tests, trim tests

6c4fe30

Removed tests only applicable to Show-Karma Fixed mock & test conditions

vexx32 force-pushed the Get-Karma branch 2 times, most recently from 2bc59b8 to 5988c0c Compare September 7, 2019 14:08

vexx32 added this to High priority in Module Features / Bugfixes Progress Sep 7, 2019

vexx32 force-pushed the Get-Karma branch from 5988c0c to 7fd2c19 Compare September 7, 2019 14:12

✅ Fix mock in Show-Karma tests

688971a

vexx32 force-pushed the Get-Karma branch from 7fd2c19 to 688971a Compare September 7, 2019 14:20

📝 Quick update pass for documentation

8b21ea9

vexx32 changed the title ~~Add Get-Karma function, rename Measure-Karma to Show-Karm~~ Add Get-Karma function, rename Measure-Karma to Show-Karma Sep 7, 2019

steviecoaster previously approved these changes Sep 8, 2019

View reviewed changes

✨ Change Get-Karma output

194d2ec

✅ Update tests

vexx32 dismissed steviecoaster’s stale review via 194d2ec September 8, 2019 05:30

vexx32 added 3 commits September 8, 2019 01:41

🔧 Fix CurrentTopic references

52487ae

🎨 Update type display

3b567a4

✅ Update tests

c013291

vexx32 force-pushed the Get-Karma branch from a379862 to c013291 Compare September 8, 2019 05:51

vexx32 merged commit 0cf03c8 into master Sep 8, 2019

Module Features / Bugfixes Progress automation moved this from High priority to Closed Sep 8, 2019

vexx32 deleted the Get-Karma branch September 8, 2019 15:21

vexx32 removed the PR-Needs-Review 🔍 Let's take a closer look! label Sep 25, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Get-Karma function, rename Measure-Karma to Show-Karma #238

Add Get-Karma function, rename Measure-Karma to Show-Karma #238

vexx32 commented Sep 7, 2019 •

edited

steviecoaster left a comment

Add Get-Karma function, rename Measure-Karma to Show-Karma #238

Add Get-Karma function, rename Measure-Karma to Show-Karma #238

Conversation

vexx32 commented Sep 7, 2019 • edited

PR Summary

Context

Changes

Checklist

steviecoaster left a comment

Choose a reason for hiding this comment

vexx32 commented Sep 7, 2019 •

edited