Update.

Date update and other user suggestions

Author: Antony Bragg

Class/Write-Log/Write-Log-Class.psm1

@@ -1,5 +1,6 @@
 class WriteLog {
-    [string]$LogLocation = "$PSScriptRoot\log.log"
+    hidden [string]$LogLocation
+    [string]$DateFormat
 
     AddError([string]$Message) {
         $this.AddEntry($message,"Error")
@@ -15,14 +16,30 @@ class WriteLog {
 
     WriteLog([string]$LogLocation) {
         $this.LogLocation = $LogLocation
+        if(!($this.ValidateLogFile($this.LogLocation))) { throw "Invalid log file extension. Please use .log or .txt" }
+    }
+
+    hidden [bool]ValidateLogFile([string]$logFIle) {
+        $extension = [System.IO.Path]::GetExtension($logFIle)
+        if(($extension -eq ".log") -or ($extension -eq ".txt")) {
+            return $true
+        } else {
+            return $false
+        }
     }
 
     hidden AddEntry([string]$Message,[string]$severity) {
         if(!(test-path $this.LogLocation)) {
             new-item $this.LogLocation -Force
         }
 
-        $timeStamp = Get-date -Format "dd/MM/yyyy HH:mm:ss"
+        if($null -eq $this.DateFormat) {
+            [DateTime]$Date = Get-Date
+            $timeStamp = $date.ToShortDateString() + " " + $date.ToShortTimeString()
+        } else {
+            $timeStamp = Get-date -Format $this.DateFormat
+        }
+        
         $Output = "$timeStamp - [$($severity)] $($Message)"
         Add-Content $this.logLocation -value $Output
         Write-Host "$Output"

Module/Write-Log/Write-Log.psm1

@@ -26,7 +26,77 @@ write-log -Message "Oh no Jurgen was here"
 write-log -Message "Oh no Jurgen was here" -severity "Error"
 .EXAMPLE
 write-log -Message "Oh no Jurgen was here" -severity "Error" -LogLocation "C:\temp\ffsJurgen.log"
+<#
+.SYNOPSIS
+Creates entries to a log file.
+
+.DESCRIPTION
+Creates an entry of a specified severity into the log file.
+
+.OUTPUTS
+A *.log or *.txt file with specific name or location.
+
+.PARAMETER Message
+The log message entered into the log file.
+
+.PARAMETER severity
+The severity set for the log message within the log file. (Info, Warning, Error).
+
+.PARAMETER logLocation
+The directory of the log file.  If left blank the log will be located in the Write-Log module folder.
+
+.PARAMETER DateFormat
+String format if a specific date format is desired.
+
+.EXAMPLE
+write-log -Message "Info worthy log"
+.EXAMPLE
+write-log -Message "Error message!! OH NO!" -severity "Error"
+.EXAMPLE
+write-log -Message "Errorrrr!!!!" -severity "Error" -LogLocation "C:\temp\Events.log"
+
+.NOTES
+This module can be found in the following GitHub Repo: https://github.com/PowershellGroup/Write-Log-Module
+#>
+
+Function Write-Log {
+  Param(
+      [Parameter(Position=0, Mandatory=$true, HelpMessage="Enter your log message.")]
+      [string]$Message,
+
+      [Parameter(Position=1, HelpMessage="Enter the log level severity between.")]
+      [ArgumentCompleter({'Info','Warning','Error'})]
+      [string]$severity = "Info",
+
+      [Parameter(Position=2, HelpMessage="Directory for the log file. Extension must be .log or .txt")]
+      [string]$logLocation = "$PSScriptRoot\Events.log",
+
+      [Parameter(Position=3, HelpMessage="String format of the date. E.g. dd/MM/yyyy")]
+      [string]$DateFormat
+  )
+
+  $extension = [System.IO.Path]::GetExtension($logLocation)
+  if(!($extension -eq ".log") -and !($extension -eq ".txt")) {
+    throw "Invalid log file extension. Please use .log or .txt" 
+  }
+
+  if(!(test-path $logLocation)) {
+    new-item $logLocation -Force | out-null
+  }
+
+  if($null -eq $DateFormat) {
+    [DateTime]$Date = Get-Date
+    $timeStamp = $date.ToShortDateString() + " " + $date.ToShortTimeString()
+  } else {
+      $timeStamp = Get-date -Format $DateFormat
+  }
+
+  $Output = "$timeStamp - [$severity] $Message"
+  Add-Content $logLocation -value $Output
+  Write-Host "$Output"
+}
 
+Export-ModuleMember -Function Write-Log
 .NOTES
 This module can be found in the following GitHub Repo: https://github.com/captainqwerty/Write-Log
 #>

README.md

@@ -26,11 +26,11 @@ This project was to just offer people a easy way to quickly add the ability to o
 
 ### Class Version
 
-The class Version is the preferred version however this version is limited to PowerShell Version 5.0 and greater and utilizes the *Using* statement.
+The class Version is the preferred version however this version is limited to PowerShell Version 5.0 and greater and utilises the *Using* statement.
 
 ### Module Version
 
-The Module Version is available for those preferring to use *Import-Module* and those using older versions of PowerShell as the Class version will not work on PowerShell versions prior to 5.0.
+The Module Version is available for those prefering to use *Import-Module* and those using older versions of PowerShell as the Class version will not work on PowerShell versions prior to 5.0.
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 
@@ -43,7 +43,6 @@ To get a local copy up and running follow these simple example steps.
 ### Prerequisites
 
 This is an example of how to list things you need to use the software and how to install them.
-
 * PowerShell version 2.0 or greater - Module Version.
 * PowerShell version 5.0 or greater - Either version.
 
@@ -52,21 +51,18 @@ This is an example of how to list things you need to use the software and how to
 1. Download the <a href="https://github.com/PowershellGroup/Write-Log-Module/release">latest release</a>.
 2. Extract the zipped folder.
 3. Place the "Write-Log" folder in your project's folder or in a location the script can access under the context it will be ran.
-4. Add the Using statement pointing to the Write-Log-Class.psm1 file, please note using statements must be the very first lines of your script.  In this example the Write-Log folder containing the file is in the root folder with the script calling it.
-
+4. Add the Using satement pointing to the Write-Log-Class.psm1 file, please note using statements must be the very first lines of your script.  In this example the Write-Log folder containing the file is in the root folder with the script calling it.
 ```ps1
 using module ".\Write-Log\Write-Log-Class.psm1"
 ```
-
-1. See <a href="#usage-of-the-class-version">Class Version Usage</a> section for examples on how to configure the log location and add entries.
+5. See <a href="#usage-of-the-class-version">Class Version Usage</a> section for examples on how to configure the log location and add enteries.
 
 ### Installation of Module Version
 
 1. Download the <a href="https://github.com/PowershellGroup/Write-Log-Module/releases">latest release</a>.
 2. Extra the zipped folder.
 3. Ensure the Write-log.psm1 remains in a folder called "Write-Log" and place the Write-Log folder in your project's folder or in a location the script can access under the context it will be ran.
-4. Import the Module. In this example the Write-Log folder is in the root of the project folder.
-
+4. Import the Module. In this example the Write-Log folder is in the root of the project folder. 
 ```ps1
 $module = "$PSScriptRoot\Write-Log"
 if(!(test-path $module)){
@@ -75,10 +71,8 @@ if(!(test-path $module)){
 }
 Import-Module $module
 ```
-
-1. See <a href="#usage-of-the-module-version">Module Version Usage</a> section for examples on how to configure the log location and add entries.
-2. Add the Remove-Module line to the bottom of your script.
-
+5. See <a href="#usage-of-the-module-version">Module Version Usage</a> section for examples on how to configure the log location and add enteries.
+6. Add the Remove-Module line to the bottom of your script.
 ```ps1
 Remove-Module Write-Log
 ```
@@ -87,7 +81,6 @@ Remove-Module Write-Log
 
 <!-- USAGE EXAMPLES -->
 ## Usage of the Class Version
-
 ```ps1
 using module ".\Class\Write-Log\Write-Log-Class.psm1"
 
@@ -98,8 +91,7 @@ $Log.AddError("There was a huge error!")
 $Log.AddWarning("Oh dear, I should really warn you about this!")
 $Log.AddEntry("Testing","Test Severity") #This method is hidden but can be used for custom severities
 ```
-
-The below example shows having multiple Write-Log objects to store different types or log entries in different logs.
+The below example shows having mutliple Write-Log objects to store different types or log enteries in different logs.
 
 ```ps1
 using module ".\Class\Write-Log\Write-Log-Class.psm1"
@@ -114,7 +106,6 @@ $WarningLog.AddWarning("Oh dear, I should really warn you about this!")
 ```
 
 ## Usage of the Module version
-
 ```ps1
 $module = "$PSScriptRoot\Module\Write-Log"
 if(!(test-path $module)){
@@ -131,9 +122,7 @@ write-log "This is an example Warning" -severity "Warning" -logLocation $logLoca
 
 Remove-Module Write-Log
 ```
-
-Below is an example of having separate logs for Info, Error and Warning entries.
-
+Below is an example of having seperate logs for Info, Error and Warning enteries.
 ```ps1
 $module = "$PSScriptRoot\Module\Write-Log"
 if(!(test-path $module)){
@@ -152,7 +141,6 @@ write-log "This is an example Warning" -severity "Warning" -logLocation $Warning
 
 Remove-Module Write-Log
 ```
-
 <p align="right">(<a href="#top">back to top</a>)</p>
 
 <!-- CONTRIBUTING -->
@@ -175,6 +163,8 @@ Don't forget to give the project a star! Thanks again!
 ## Acknowledgments
 
 * [Othneildrew's Best-README-Template](https://github.com/othneildrew/Best-README-Template)
+* [matthewjdegarmo](https://github.com/matthewjdegarmo) - Excellent suggestion on moving from ValidationSet in the module version and improvements / corrections to the ReadMe
+* [SeidChr](https://github.com/SeidChr) - For prompting the addition of .txt
 
 <p align="right">(<a href="#top">back to top</a>)</p>