ScriptLog

0.4.0

ScriptLog.psd1

                                #

# Module manifest for module 'ScriptLog'

#

# Generated by: Kaare Overgaard

#

# Generated on: 09-07-2022

#

@{

    # Script module or binary module file associated with this manifest.

    RootModule        = 'ScriptLog.psm1'

    # Version number of this module.

    ModuleVersion     = '0.4.0'

    # Supported PSEditions

    # CompatiblePSEditions = @()

    # ID used to uniquely identify this module

    GUID              = 'd689273f-5cdf-44d1-95c4-2051f05c86ae'

    # Author of this module

    Author            = 'Kaare Overgaard'

    # Company or vendor of this module

    CompanyName       = ''

    # Copyright statement for this module

    Copyright         = '(c) Kaare Overgaard. All rights reserved.'

    # Description of the functionality provided by this module

    Description       = 'A module providing consistent and rich logging for your PowerShell scripts.'

    # Minimum version of the PowerShell engine required by this module

    # PowerShellVersion = ''

    # Name of the PowerShell host required by this module

    # PowerShellHostName = ''

    # Minimum version of the 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 = @('Get-ScriptLog','New-ScriptLog','Out-ScriptLog','Remove-ScriptLog')

    # 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 = @{

            Prerelease = ''

            # Tags applied to this module. These help with module discovery in online galleries.

            Tags       = @('Module', 'Log', 'Logging', 'Windows', 'AzureAutomation', 'Azure', 'Automation', 'Runbook')

            # A URL to the license for this module.

            LicenseUri = 'https://github.com/kovergard/ScriptLog/blob/main/LICENSE.md'

            # A URL to the main website for this project.

            ProjectUri = 'https://github.com/kovergard/ScriptLog'

            # A URL to an icon representing this module.

            # IconUri = ''

            # ReleaseNotes of this module

              ReleaseNotes = '## [0.4.0] - 2023-08-20

### Added

- New function Remove-ScriptLog added, to allow for removing active logs during a session. This only removes the log object from memory, any files remains on disk. 

- Logs can now be given a name upon creation, to make it easier to distinguish between them when using multiple logs. In the future, this will be the only way to target a specific log.

### Changed

- The parameter AppendDateTime in function New-ScriptLog is now a switch instead of a boolean.

- Internal test quality improved.

### Deprecated

- Over time, it has been found that manipulating the ScriptLog objects directly have some unforeseen side effects. Due to this, functions will be changed so that the new Name attribute can be used to target a specific log. For now, logs can still be accessed by passing the ScriptLog object. At some future release, the New-ScriptLog and Get-ScriptLog functions will stop returning the actual object, but instead return a new customobject containing the log properties.

### Fixed

- It is no longer possible to have two ScrtipLogs using the same file.

'

            # 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 = ''

}