PwSh.Fw.Core

Author(s)

• Charles-Antoine Degennes

Tags

Windows Linux MacOS PwSh.Fw core

Functions

Add-PSModulePath ConvertFrom-ConfigFile ConvertFrom-Plist ConvertFrom-Xml Convert-Size ConvertTo-CamelCase ConvertTo-PSCustomObject ConvertTo-SingleString Execute-Command Get-CustomObjectProperties Get-ObjectProperties Get-PropertyValueFromFile Get-ReturnCodeColor Get-ReturnCodeId Get-ReturnCodeString Get-ValidValuesFromPath Load-Module Merge-Hashtables Merge-Object New-TemplateFunction Read-PlistNode Remove-StringLatinCharacters Reset-Indent Resize-Image Resolve-Boolean Resolve-PathExtended Set-Indent Set-ReturnCodePosition Sort-ByProperties Sort-HashTable Test-DirExist Test-FileExist Test-IsUNCPath Test-RegKeyExist Test-RegValueExist Test-Variable Write-Add Write-Begin Write-Debug Write-Devel Write-End Write-Enter Write-EnterFunction Write-Error Write-Fatal Write-Indent Write-Info Write-Leave Write-LeaveFunction Write-MyDebug Write-MyError Write-MyVerbose Write-MyWarning Write-Outdent Write-Question Write-ReturnCode Write-Title Write-ToLogFile Write-Verbose Write-Warning

PSEditions

Core

Dependencies

This module has no dependencies.

Release Notes

## [unreleased]
### Added
- :scroll: `Get-ValidValuesFromPath`. It is a helper function to be used in `ArgumentCompleter` parameter definition. See `Get-Help Get-ValidValuesFromPath -full`.
- :package:`PwSh.Fw.Image`: new module -> :scroll: `Resize-Image` function.
- :package:`PwSh.Fw.Error`: new module to register common return codes, their meaning and their default color
- :package:`PwSh.Fw.Write` - :scroll: `Write-ReturnCode` to properly display a return code. User can choose to display it at the beginning or end of the line by setting default with `Set-ReturnCodePosition` or by overriding default with `-Position` parameter
- if all goes well, `Write-End` will be a wrapper for `Write-ReturnCode -Position END` for the next version (if I remember to do it)
- new :package:`PwSh.Fw.Path`. Functions :scroll: `Test-FileExist` and :scroll: `TEst-DirExist` moved there.
- :package:`PwSh.Fw.Path` : new :scroll: `Resolve-PathExtended` and :scroll: `Test-IsUNCPath` functions.
- :scroll: new `Write-Question` is a wrapper for Read-Host and add DefaultValue capability.
### Changed
- :scroll: `Write-My*` functions renamed to `Write-*` thus overriding Powershell default ones. e.g. `Write-MyWarning` -> `Write-Warning`. Aliases are created but are already considered obsoletes.
- :scroll: `ConvertFrom-ConfigFile` read yaml/yml files
- :scroll: `Add-PSModulePath` use `[Environment]::GetEnvironmentVariable()` and `[Environment]::SetEnvironmentVariable()`
### Deprecated
- `Write-My*` aliases to keep old behavior are deprecated
### Removed
- :scroll: `Write-My*` functions have been replaced by `Write-*` functions, overriding Powershell natives ones (like `Write-Warning`)
### Fixed
### Security