Merge pull request #14 from StartAutomating/NewEvents

New event - On@LocationChanged

Author: StartAutomating

CHANGELOG.md

@@ -1,13 +1,22 @@
+## 0.1.6
+* Adding LocationChanged event source (Fixes #12)
+
+---
+
 ## 0.1.5
 * Adding On@Event (#2)
 * Send-Event support for piping existing events (#4)
 * Adding /docs (#5)
+
 ---
+
 ## 0.1.4
 
 * Module Rebranded to Eventful.
 * Get-EventHandler added
+
 ---
+
 ## 0.1.3
 New Event Source:
 * VariableSet
@@ -16,18 +25,24 @@ Receive-Event now returns event most-recent to least-recent.
 Receive-Event now has -First and -Skip.
 
 Bugfix:  On@Repeat now actually starts it's timer.
+
 ---
+
 ## 0.1.2
 New Event Source:
 * UDP
 
 PowerShellAsync Event Source now allows for a -Parameter dictionaries.
+
 ---
+
 ## 0.1.1
 New Event Sources:
 * HTTPResponse
 * PowerShellAsync
+
 ---
+
 New Event Source Capabilities:
 
 Event Sources can now return an InitializeEvent property or provide a ComponentModel.InitializationEvent attribute.
@@ -38,4 +53,6 @@ Initial Module Release.
 
 Fun simple event syntax (e.g. on mysignal {"do this"} or on delay "00:00:01" {"do that"})
 Better pipelining support for Sending events.
+
 ---
+'@

EventSources/@Event.ps1

@@ -2,7 +2,9 @@
 .Synopsis
     Watches for new events.
 .Description
+    Watches for any new events.
     
+    Subscribing to this event will preempt all other events.
 #>
 [Diagnostics.Tracing.EventSource(Name='PSEventReceived')]
 param()

EventSources/@LocationChanged.ps1

@@ -0,0 +1,22 @@
+<#
+.Synopsis
+    Sends events when the directory changes.
+.Description
+    Sends events when the PowerShell current directory changes.
+.EXAMPLE
+    On@LocationChanged
+.EXAMPLE
+    On@LocationChanged  -Then  { $event | Out-Host } 
+#>
+param()
+
+process {
+    $global:ExecutionContext.SessionState.InvokeCommand.LocationChangedAction = {
+        param($LocationChangedArgs)
+
+        New-Event -SourceIdentifier "PowerShell.LocationChanged" $LocationChangedArgs -Sender $ExecutionContext
+    }
+    [PSCustomObject]@{
+        SourceIdentifier = "PowerShell.LocationChanged"
+    }
+}

Eventful.HelpOut.ps1

@@ -12,7 +12,6 @@ if ($EventfulLoaded) {
 }
 
 Save-MarkdownHelp -Module Eventful -OutputPath $wikiPath -ScriptPath '@*' -ReplaceScriptName '^@', 
-    '\.ps1$' -ReplaceScriptNameWith '',"-EventSource" -SkipCommandType Alias -PassThru -IncludeTopic *.help.txt |
-    Add-Member -Name CommitMessage -MemberType ScriptProperty  -value { "Updating $($this.Name) [skip ci]" } -Force -PassThru
+    '\.ps1$' -ReplaceScriptNameWith '',"-EventSource" -SkipCommandType Alias -PassThru -IncludeTopic *.help.txt
 
 Pop-Location

Eventful.psd1

@@ -1,7 +1,7 @@
 @{
     RootModule = 'Eventful.psm1'
     Description = 'Easy Eventful Asynchronous Scripting with PowerShell'
-    ModuleVersion = '0.1.5'
+    ModuleVersion = '0.1.6'
     GUID = 'f4d780da-be78-49c6-921a-436e053cb97c'
     Author = 'James Brundage'
     Copyright = '2021 Start-Automating'
@@ -16,16 +16,25 @@
             Tags = 'Eventful', 'Events'
 
             ReleaseNotes = @'
+## 0.1.6
+* Adding LocationChanged event source (Fixes #12)
+
+---
+
 ## 0.1.5
 * Adding On@Event (#2)
 * Send-Event support for piping existing events (#4)
 * Adding /docs (#5)
+
 ---
+
 ## 0.1.4
 
 * Module Rebranded to Eventful.
 * Get-EventHandler added
+
 ---
+
 ## 0.1.3
 New Event Source:
 * VariableSet
@@ -34,18 +43,24 @@ Receive-Event now returns event most-recent to least-recent.
 Receive-Event now has -First and -Skip.
 
 Bugfix:  On@Repeat now actually starts it's timer.
+
 ---
+
 ## 0.1.2
 New Event Source:
 * UDP
 
 PowerShellAsync Event Source now allows for a -Parameter dictionaries.
+
 ---
+
 ## 0.1.1
 New Event Sources:
 * HTTPResponse
 * PowerShellAsync
+
 ---
+
 New Event Source Capabilities:
 
 Event Sources can now return an InitializeEvent property or provide a ComponentModel.InitializationEvent attribute.
@@ -56,6 +71,7 @@ Initial Module Release.
 
 Fun simple event syntax (e.g. on mysignal {"do this"} or on delay "00:00:01" {"do that"})
 Better pipelining support for Sending events.
+
 ---
 '@
         }
@@ -72,6 +88,7 @@ Better pipelining support for Sending events.
             'VariableSet' = 'EventSources/@VariableSet.ps1'
             'UDP' = 'EventSources/@UDP.ps1'
             'Event' = 'EventSources/@Event.ps1'
+            'LocationChanged' = 'EventSources/@LocationChanged.ps1'
         }
     }
 }

README.md

@@ -4,17 +4,6 @@
 Easy Eventful Asynchronous Scripting with PowerShell
 ----------------
 
-### Commands
------------------------
-|   Verb|Noun         |
-|------:|:------------|
-|  Clear|-EventSource |
-|    Get|-EventHandler|
-|       |-EventSource |
-|Receive|-Event       |
-|   Send|-Event       |
-|  Watch|-Event       |
------------------------
 ### Getting Started with Eventful
 
 

docs/Clear-EventSource-EventSource.md

@@ -1,3 +1,4 @@
 Clear-EventSource.ps1 
 
 
+

docs/Clear-EventSource.md

@@ -12,6 +12,9 @@ Clears any active subscriptions for any event source.
 ---
 ### Related Links
 * [Get-EventSource](Get-EventSource.md)
+
+
+
 ---
 ### Examples
 #### EXAMPLE 1
@@ -27,9 +30,16 @@ The name of the event source.
 
 
 
-|Type            |Requried|Postion|PipelineInput        |
-|----------------|--------|-------|---------------------|
-|```[String[]]```|false   |1      |true (ByPropertyName)|
+> **Type**: ```[String[]]```
+
+> **Required**: false
+
+> **Position**: 1
+
+> **PipelineInput**:true (ByPropertyName)
+
+
+
 ---
 #### **WhatIf**
 -WhatIf is an automatic variable that is created when a command has ```[CmdletBinding(SupportsShouldProcess)]```.
@@ -45,7 +55,9 @@ If the command sets a ```[ConfirmImpact("Medium")]``` which is lower than ```$co
 
 ---
 ### Outputs
-System.Nullable
+* [Nullable](https://learn.microsoft.com/en-us/dotnet/api/System.Nullable)
+
+
 
 
 ---

docs/Delay-EventSource.md

@@ -24,9 +24,16 @@ The amount of time to wait
 
 
 
-|Type            |Requried|Postion|PipelineInput        |
-|----------------|--------|-------|---------------------|
-|```[TimeSpan]```|true    |1      |true (ByPropertyName)|
+> **Type**: ```[TimeSpan]```
+
+> **Required**: true
+
+> **Position**: 1
+
+> **PipelineInput**:true (ByPropertyName)
+
+
+
 ---
 ### Syntax
 ```PowerShell
@@ -35,3 +42,4 @@ The amount of time to wait
 ---
 
 
+

docs/Event-EventSource.md

@@ -6,6 +6,11 @@ Watches for new events.
 
 ---
 ### Description
+
+Watches for any new events.
+
+Subscribing to this event will preempt all other events.
+
 ---
 ### Syntax
 ```PowerShell
@@ -14,3 +19,5 @@ EventSources/@Event.ps1 [<CommonParameters>]
 ---
 
 
+
+