JT.WriteLog

2.2.0.0

JT.WriteLog.psd1

#
# Module manifest for module 'JT.WriteLog'
#
# Generated by: Johnny Tse
#
# Generated on: 2025.03.16
#

@{

# Script module or binary module file associated with this manifest.
RootModule = 'JT.WriteLog.psm1'

# Version number of this module.
ModuleVersion = '2.2.0.0'

# Supported PSEditions
# CompatiblePSEditions = @()

# ID used to uniquely identify this module
GUID = '7735d8cc-5c4f-46d6-a254-a3bc995fb3d9'

# Author of this module
Author = 'Johnny Tse'

# Company or vendor of this module
CompanyName = 'None'

# Copyright statement for this module
Copyright = '(c) 2024 Johnny Tse. All rights reserved.'

# Description of the functionality provided by this module
Description = '
Write-Log is a Powershell logging script.
 
Write-Log write the log on the console with color and create a ''Log'' folder for the log file. The default name of the log is "{Scriptname}_log.txt".
 
The console color for the log:
 
ErrorLevel Color
---------- ----------
INFO White
SUCCESS Green
WARNING Yellow
ERROR Red
DEBUG DarkYellow
 
Usage:
Write-Log [-errorLevel] {INFO | SUCCESS | WARNING | ERROR | DEBUG} [[-message] <String>] [[-logRecycling]
    {Continue | Daily | Hourly}] [[-logPath] <String>] [-debugMode] [<CommonParameters>]
'

# Minimum version of the Windows PowerShell engine required by this module
# PowerShellVersion = ''

# Name of the Windows PowerShell host required by this module
# PowerShellHostName = ''

# Minimum version of the Windows PowerShell host required by this module
# PowerShellHostVersion = ''

# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
# DotNetFrameworkVersion = ''

# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
# CLRVersion = ''

# Processor architecture (None, X86, Amd64) required by this module
# ProcessorArchitecture = ''

# Modules that must be imported into the global environment prior to importing this module
# RequiredModules = @()

# Assemblies that must be loaded prior to importing this module
# RequiredAssemblies = @()

# Script files (.ps1) that are run in the caller's environment prior to importing this module.
# ScriptsToProcess = @()

# Type files (.ps1xml) to be loaded when importing this module
# TypesToProcess = @()

# Format files (.ps1xml) to be loaded when importing this module
# FormatsToProcess = @()

# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
# NestedModules = @()

# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
FunctionsToExport = '*'

# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
CmdletsToExport = '*'

# Variables to export from this module
VariablesToExport = '*'

# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
AliasesToExport = '*'

# DSC resources to export from this module
# DscResourcesToExport = @()

# List of all modules packaged with this module
# ModuleList = @()

# List of all files packaged with this module
# FileList = @()

# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
PrivateData = @{

    PSData = @{

        # Tags applied to this module. These help with module discovery in online galleries.
        # Tags = @()

        # A URL to the license for this module.
        # LicenseUri = ''

        # A URL to the main website for this project.
        # ProjectUri = ''

        # A URL to an icon representing this module.
        # IconUri = ''

        # ReleaseNotes of this module
        ReleaseNotes = '
Version 2.0.0.2: Bug fix: Write-Log created log file using module name when instead of {ScriptName}.
                    Enhance: It can use $LengthOfFunctionName to adjust the lenght of the ''Function Name'' field.
Version 2.0.0.3: Fix: Correct EXAMPLE message.
Version 2.0.0.4: Bug fix: Failure to write file under PowerShell v5.1 or below version.
Version 2.1.0.0: Bug fix: The log file location may be incorrect.
                    Enhance: Add ''<Job>'' after the function name field to identify it is call from [Start-Job] / [Start-ThreadJob].
                             Auto adjust the length of ''Function Name'' for write message into log file.
                             Standardize encoding (to UTF8) between Powershell 5.1 and Powershell Core.
Version 2.2.0.0: Enhance: Improve performance if it did not have write to file or display debug information.
'

        # Prerelease string of this module
        # Prerelease = ''

        # Flag to indicate whether the module requires explicit user acceptance for install/update/save
        # RequireLicenseAcceptance = $false

        # External dependent modules of this module
        # ExternalModuleDependencies = @()

    } # End of PSData hashtable

} # End of PrivateData hashtable

# HelpInfo URI of this module
# HelpInfoURI = ''

# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
# DefaultCommandPrefix = ''

}