KrakenExchange.psm1
|
# Import all functions in the Functions directory $Functions = @( Get-ChildItem -Path $PSScriptRoot\Functions\*.ps1 -ErrorAction SilentlyContinue ) Foreach ($Function in $Functions) { Try { . $Function.fullname } Catch { Write-Error -Message "Failed to import function $($Function.FullName): $($_.Exception.Message)" } } $oldProtocol = [Net.ServicePointManager]::SecurityProtocol # We switch to using TLS 1.2 because GitHub closes the connection if it uses 1.0 or 1.1 [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 # Get the name of the current module $ModuleName = "KrakenExchange" #$reponame = "KrakenExchangeAPI-PowerShell" # Get the installed version of the module $ModuleVersion = [version]"1.0.1" $LatestModule = Find-Module -Name $ModuleName -Repository PSGallery if ($ModuleVersion -lt $LatestModule.Version) { Write-Host "An update is available for $($ModuleName). Installed version: $($InstalledModule.Version). Latest version: $($LatestModule.Version)." } else { Write-Host "The $($ModuleName) module is up-to-date." } <# # Create a URL for the latest release of the module on GitHub $GitHubAPIUrl = "https://api.github.com/repos/{USERNAME}/{REPO}/releases/latest" $GitHubAPIUrl = $GitHubAPIUrl -replace "{USERNAME}", "voytas75" -replace "{REPO}", $reponame # Invoke the GitHub API to get information about the latest release $Response = Invoke-WebRequest -Uri $GitHubAPIUrl # Convert the JSON response to a PowerShell object $ReleaseInfo = ConvertFrom-Json $Response.Content # Get the version number of the latest release $LatestVersion = $ReleaseInfo.tag_name # Compare the installed version to the latest version $InstalledVersion $LatestVersion if ($InstalledVersion -lt $LatestVersion) { Write-Host "A new version of the $ModuleName module is available. Latest version: $LatestVersion" } else { Write-Host "You have the latest version of the $ModuleName module installed." } #> [Net.ServicePointManager]::SecurityProtocol = $oldProtocol #region Best Practise <# Use approved verbs: Use approved PowerShell verbs to name your functions. This helps ensure that your function names are consistent with other PowerShell cmdlets, making them easier to remember and reducing the likelihood of naming conflicts. You can use the Get-Verb cmdlet to see a list of approved verbs. Use a module manifest: Use a module manifest (*.psd1) file to define metadata about your module, such as the module name, version, author, and other properties. This makes it easier to manage your module, load it into PowerShell, and publish it to a repository. Use a functions folder: Store your module's functions in a subdirectory named "Functions" within your module folder. This helps keep your module organized and makes it easier to find and manage your functions. Use script-based functions: Use script-based functions instead of binary cmdlets whenever possible. Script-based functions are easier to develop and test, and they can be easily modified and updated. Use a consistent naming convention: Use a consistent naming convention for your functions and other resources, such as variables and aliases. This makes it easier to understand your code and reduces the likelihood of naming conflicts. Use proper error handling: Use proper error handling techniques in your functions to ensure that errors are reported accurately and clearly. Use the Throw statement to throw exceptions when errors occur, and use the Write-Error cmdlet to report non-terminating errors. Use proper documentation: Use proper documentation in your functions to describe what they do and how to use them. Use the Comment-Based Help syntax to add help content to your functions. #> #endregion Best Practise |