Add context, cleanup parameters and param handling

PSModule · Dec 4, 2024 · 96143ec · 96143ec
1 parent 8278e48
commit 96143ec
Show file tree

Hide file tree

Showing 56 changed files with 466 additions and 221 deletions.
diff --git a/src/functions/private/Gitignore/Get-GitHubGitignoreByName.ps1 b/src/functions/private/Gitignore/Get-GitHubGitignoreByName.ps1
@@ -18,13 +18,17 @@ filter Get-GitHubGitignoreByName {
     #>
     [CmdletBinding()]
     param (
+        [Parameter(Mandatory)]
+        [string] $Name,
+
+        # The context to run the command in.
         [Parameter()]
-        [ValidateNotNullOrEmpty()]
-        [string] $Name
+        [string] $Context
     )
 
     process {
         $inputObject = @{
+            Context     = $Context
             APIEndpoint = "/gitignore/templates/$Name"
             Accept      = 'application/vnd.github.raw+json'
             Method      = 'GET'

diff --git a/src/functions/private/Gitignore/Get-GitHubGitignoreList.ps1 b/src/functions/private/Gitignore/Get-GitHubGitignoreList.ps1
@@ -18,15 +18,19 @@ filter Get-GitHubGitignoreList {
     #>
     [OutputType([string[]])]
     [CmdletBinding()]
-    param ()
+    param (
+        # The context to run the command in.
+        [Parameter()]
+        [string] $Context
+    )
 
     $inputObject = @{
+        Context     = $Context
         APIEndpoint = '/gitignore/templates'
         Method      = 'GET'
     }
 
     Invoke-GitHubAPI @inputObject | ForEach-Object {
         Write-Output $_.Response
     }
-
 }
diff --git a/src/functions/private/License/Get-GitHubLicenseByName.ps1 b/src/functions/private/License/Get-GitHubLicenseByName.ps1
@@ -20,14 +20,18 @@ filter Get-GitHubLicenseByName {
     [CmdletBinding()]
     param (
         # The license keyword, license name, or license SPDX ID. For example, mit or mpl-2.0.
-        [Parameter()]
-        [ValidateNotNullOrEmpty()]
+        [Parameter(Mandatory)]
         [Alias('license')]
-        [string] $Name
+        [string] $Name,
+
+        # The context to run the command in.
+        [Parameter()]
+        [string] $Context
     )
 
     process {
         $inputObject = @{
+            Context     = $Context
             APIEndpoint = "/licenses/$Name"
             Accept      = 'application/vnd.github+json'
             Method      = 'GET'
@@ -36,6 +40,5 @@ filter Get-GitHubLicenseByName {
         Invoke-GitHubAPI @inputObject | ForEach-Object {
             Write-Output $_.Response
         }
-
     }
 }
diff --git a/src/functions/private/License/Get-GitHubLicenseList.ps1 b/src/functions/private/License/Get-GitHubLicenseList.ps1
@@ -19,9 +19,14 @@ filter Get-GitHubLicenseList {
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidLongLines', '', Justification = 'Contains a long link.')]
     [OutputType([string[]])]
     [CmdletBinding()]
-    param ()
+    param (
+        # The context to run the command in.
+        [Parameter()]
+        [string] $Context
+    )
 
     $inputObject = @{
+        Context     = $Context
         APIEndpoint = '/licenses'
         Method      = 'GET'
     }

diff --git a/src/functions/private/License/Get-GitHubRepositoryLicense.ps1 b/src/functions/private/License/Get-GitHubRepositoryLicense.ps1
@@ -21,15 +21,20 @@ filter Get-GitHubRepositoryLicense {
     [CmdletBinding()]
     param (
         # The account owner of the repository. The name is not case sensitive.
-        [Parameter()]
-        [string] $Owner = (Get-GitHubContextSetting -Name Owner),
+        [Parameter(Mandatory)]
+        [string] $Owner,
 
         # The name of the repository without the .git extension. The name is not case sensitive.
+        [Parameter(Mandatory)]
+        [string] $Repo,
+
+        # The context to run the command in.
         [Parameter()]
-        [string] $Repo = (Get-GitHubContextSetting -Name Repo)
+        [string] $Context
     )
 
     $inputObject = @{
+        Context     = $Context
         APIEndpoint = "/repos/$Owner/$Repo/license"
         Accept      = 'application/vnd.github+json'
         Method      = 'GET'

diff --git a/src/functions/private/Organization/Blocking/Block-GitHubUserByOrganization.ps1 b/src/functions/private/Organization/Blocking/Block-GitHubUserByOrganization.ps1
@@ -36,11 +36,15 @@
             ValueFromPipeline,
             ValueFromPipelineByPropertyName
         )]
-        [Alias('login')]
-        [string] $Username
+        [string] $Username,
+
+        # The context to run the command in.
+        [Parameter()]
+        [string] $Context
     )
 
     $inputObject = @{
+        Context     = $Context
         APIEndpoint = "/orgs/$OrganizationName/blocks/$Username"
         Method      = 'PUT'
     }

diff --git a/src/functions/private/Organization/Blocking/Get-GitHubBlockedUserByOrganization.ps1 b/src/functions/private/Organization/Blocking/Get-GitHubBlockedUserByOrganization.ps1
@@ -27,14 +27,19 @@
         # The number of results per page (max 100).
         [Parameter()]
         [ValidateRange(1, 100)]
-        [int] $PerPage = 30
+        [int] $PerPage = 30,
+
+        # The context to run the command in.
+        [Parameter()]
+        [string] $Context
     )
 
     $body = @{
         per_page = $PerPage
     }
 
     $inputObject = @{
+        Context     = $Context
         APIEndpoint = "/orgs/$OrganizationName/blocks"
         Method      = 'GET'
         Body        = $body

diff --git a/src/functions/private/Organization/Blocking/Test-GitHubBlockedUserByOrganization.ps1 b/src/functions/private/Organization/Blocking/Test-GitHubBlockedUserByOrganization.ps1
@@ -35,10 +35,15 @@
             Mandatory,
             ValueFromPipelineByPropertyName
         )]
-        [string] $Username
+        [string] $Username,
+
+        # The context to run the command in.
+        [Parameter()]
+        [string] $Context
     )
 
     $inputObject = @{
+        Context     = $Context
         APIEndpoint = "/orgs/$OrganizationName/blocks/$Username"
         Method      = 'GET'
     }

diff --git a/src/functions/private/Organization/Blocking/Unblock-GitHubUserByOrganization.ps1 b/src/functions/private/Organization/Blocking/Unblock-GitHubUserByOrganization.ps1
@@ -36,10 +36,15 @@
             ValueFromPipelineByPropertyName
         )]
         [Alias('login')]
-        [string] $Username
+        [string] $Username,
+
+        # The context to run the command in.
+        [Parameter()]
+        [string] $Context
     )
 
     $inputObject = @{
+        Context     = $Context
         APIEndpoint = "/orgs/$OrganizationName/blocks/$Username"
         Method      = 'DELETE'
     }

diff --git a/src/functions/private/Organization/Get-GitHubAllOrganization.ps1 b/src/functions/private/Organization/Get-GitHubAllOrganization.ps1
@@ -29,7 +29,11 @@
         # The number of results per page (max 100).
         [Parameter()]
         [ValidateRange(1, 100)]
-        [int] $PerPage = 30
+        [int] $PerPage = 30,
+
+        # The context to run the command in.
+        [Parameter()]
+        [string] $Context
     )
 
     $body = @{
@@ -38,6 +42,7 @@
     }
 
     $inputObject = @{
+        Context     = $Context
         APIEndpoint = '/organizations'
         Method      = 'GET'
         Body        = $body

diff --git a/src/functions/private/Organization/Get-GitHubMyOrganization.ps1 b/src/functions/private/Organization/Get-GitHubMyOrganization.ps1
@@ -28,14 +28,19 @@
         # The number of results per page (max 100).
         [Parameter()]
         [ValidateRange(1, 100)]
-        [int] $PerPage = 30
+        [int] $PerPage = 30,
+
+        # The context to run the command in.
+        [Parameter()]
+        [string] $Context
     )
 
     $body = @{
         per_page = $PerPage
     }
 
     $inputObject = @{
+        Context     = $Context
         APIEndpoint = '/user/orgs'
         Method      = 'GET'
         Body        = $body

diff --git a/src/functions/private/Organization/Get-GitHubOrganizationByName.ps1 b/src/functions/private/Organization/Get-GitHubOrganizationByName.ps1
@@ -34,11 +34,16 @@
         [Alias('login')]
         [Alias('org')]
         [Alias('owner')]
-        [string] $OrganizationName
+        [string] $OrganizationName,
+
+        # The context to run the command in.
+        [Parameter()]
+        [string] $Context
     )
 
 
     $inputObject = @{
+        Context     = $Context
         APIEndpoint = "/orgs/$OrganizationName"
         Method      = 'GET'
     }

diff --git a/src/functions/private/Organization/Get-GitHubUserOrganization.ps1 b/src/functions/private/Organization/Get-GitHubUserOrganization.ps1
@@ -30,14 +30,19 @@
         # The number of results per page (max 100).
         [Parameter()]
         [ValidateRange(1, 100)]
-        [int] $PerPage = 30
+        [int] $PerPage = 30,
+
+        # The context to run the command in.
+        [Parameter()]
+        [string] $Context
     )
 
     $body = @{
         per_page = $PerPage
     }
 
     $inputObject = @{
+        Context     = $Context
         APIEndpoint = "/users/$Username/orgs"
         Method      = 'GET'
         Body        = $body

diff --git a/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByID.ps1 b/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByID.ps1
@@ -21,20 +21,25 @@
     [CmdletBinding()]
     param (
         # The account owner of the repository. The name is not case sensitive.
-        [Parameter()]
-        [string] $Owner = (Get-GitHubContextSetting -Name Owner),
+        [Parameter(Mandatory)]
+        [string] $Owner,
 
         # The name of the repository without the .git extension. The name is not case sensitive.
-        [Parameter()]
-        [string] $Repo = (Get-GitHubContextSetting -Name Repo),
+        [Parameter(Mandatory)]
+        [string] $Repo,
 
         # The unique identifier of the asset.
         [Parameter(Mandatory)]
         [Alias('asset_id')]
-        [string] $ID
+        [string] $ID,
+
+        # The context to run the command in.
+        [Parameter()]
+        [string] $Context
     )
 
     $inputObject = @{
+        Context     = $Context
         APIEndpoint = "/repos/$Owner/$Repo/releases/assets/$ID"
         Method      = 'GET'
     }

diff --git a/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByReleaseID.ps1 b/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByReleaseID.ps1
@@ -18,12 +18,12 @@
     [CmdletBinding()]
     param (
         # The account owner of the repository. The name is not case sensitive.
-        [Parameter()]
-        [string] $Owner = (Get-GitHubContextSetting -Name Owner),
+        [Parameter(Mandatory)]
+        [string] $Owner,
 
         # The name of the repository without the .git extension. The name is not case sensitive.
-        [Parameter()]
-        [string] $Repo = (Get-GitHubContextSetting -Name Repo),
+        [Parameter(Mandatory)]
+        [string] $Repo,
 
         # The unique identifier of the release.
         [Parameter(
@@ -36,13 +36,19 @@
         # The number of results per page (max 100).
         [Parameter()]
         [ValidateRange(1, 100)]
-        [int] $PerPage = 30
+        [int] $PerPage = 30,
+
+        # The context to run the command in.
+        [Parameter()]
+        [string] $Context
     )
 
-    $body = $PSBoundParameters | ConvertFrom-HashTable | ConvertTo-HashTable -NameCasingStyle snake_case
-    Remove-HashtableEntry -Hashtable $body -RemoveNames 'Owner', 'Repo', 'ID'
+    $body = @{
+        per_page = $PerPage
+    }
 
     $inputObject = @{
+        Context     = $Context
         APIEndpoint = "/repos/$Owner/$Repo/releases/$ID/assets"
         Method      = 'GET'
         Body        = $body

diff --git a/src/functions/private/Releases/Releases/Get-GitHubReleaseAll.ps1 b/src/functions/private/Releases/Releases/Get-GitHubReleaseAll.ps1
@@ -20,23 +20,29 @@
     [CmdletBinding()]
     param (
         # The account owner of the repository. The name is not case sensitive.
-        [Parameter()]
-        [string] $Owner = (Get-GitHubContextSetting -Name Owner),
+        [Parameter(Mandatory)]
+        [string] $Owner,
 
         # The name of the repository without the .git extension. The name is not case sensitive.
-        [Parameter()]
-        [string] $Repo = (Get-GitHubContextSetting -Name Repo),
+        [Parameter(Mandatory)]
+        [string] $Repo,
 
         # The number of results per page (max 100).
         [Parameter(ParameterSetName = 'AllUsers')]
         [ValidateRange(1, 100)]
-        [int] $PerPage = 30
+        [int] $PerPage = 30,
+
+        # The context to run the command in.
+        [Parameter()]
+        [string] $Context
     )
 
-    $body = $PSBoundParameters | ConvertFrom-HashTable | ConvertTo-HashTable -NameCasingStyle snake_case
-    Remove-HashtableEntry -Hashtable $body -RemoveNames 'Owner', 'Repo'
+    $body = @{
+        per_page = $PerPage
+    }
 
     $inputObject = @{
+        Context     = $Context
         APIEndpoint = "/repos/$Owner/$Repo/releases"
         Method      = 'GET'
         Body        = $body