20230206A

Author: hugoalh

.github/dependabot.yml

@@ -15,7 +15,7 @@ updates:
       separator: "/"
     rebase-strategy: "disabled"
   - package-ecosystem: "npm"
-    directory: "/hugoalh.GitHubActionsToolkit/module/nodejs-wrapper"
+    directory: "/nodejs-wrapper-source"
     schedule:
       interval: "daily"
       time: "00:00"

CONTRIBUTING.md

@@ -4,22 +4,17 @@ This Contributing Guide includes the guidelines, methods, and ways to contribute
 
 - those guidelines, methods, and/or ways are separated from this Contributing Guide and exist and/or store in their corresponding places,
 - those categories, items, and/or types are easy to understand how to correctly contributing, or
-- maintainers and/or owners forgot to edit this Contributing Guide.
+- the maintainers and/or owners forgot to edit this Contributing Guide.
 
 If you have any questions and/or still confused, try to create a discussion.
 
 ## Codes
 
 All of the codes in this project and repository are follow the [hxhS (hugoalh & hugoalh Studio) Coding Guide](https://github.com/hugoalh/hugoalh/blob/main/coding-guide/main.md).
 
-## Deploys, Releases, Tags & Versions
+## Deploys & Versions
 
-These are always the works of:
-
-- the maintainers who in this project and repository, and
-- the owner.
-
-Which are follow the [hxhS (hugoalh & hugoalh Studio) Versioning Guide](https://github.com/hugoalh/hugoalh/blob/main/versioning-guide/main.md).
+These are always the works of the maintainers and/or owners, which are follow the [hxhS (hugoalh & hugoalh Studio) Versioning Guide](https://github.com/hugoalh/hugoalh/blob/main/versioning-guide/main.md).
 
 ## Discussions
 
@@ -37,7 +32,7 @@ To improve the wiki, create an issue.
 
 ## I18ns (Internationalizations) & Translations
 
-This project and repository does not have necessary things to do i18ns and/or translations.
+This project and repository does not need to do i18ns and/or translations.
 
 If you want to do i18ns and/or translations on the documentations, documents and/or wiki, please see the section "[Documentations, Documents & Wiki](#documentations-documents--wiki)".
 
@@ -55,4 +50,4 @@ If you want to do i18ns and/or translations on the documentations, documents and
 - Try to avoid a pull request with too many changes if possible.
   - A large pull request not only stretches the review time, but also makes it much harder to spot issues.
   - It is better to split the pull request to multiple smaller ones.
-- If your pull request is not ready but want to save it first, you can submit it by mark as draft, and no need to add any identifications to the title (e.g.: `[WIP]`).
+- If your pull request is not ready but want to save it first, you can submit it by mark as draft, and no need to add any identifications to the title (e.g.: `[WIP] XXXXXXXX`).

LICENSE.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright © 2021\~2022 hugoalh Studio
+Copyright © 2021\~2023 hugoalh Studio
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

README.md

@@ -2,7 +2,6 @@
 
 [`GitHubActionsToolkit.PowerShell`](https://github.com/hugoalh-studio/ghactions-toolkit-powershell)
 
-![PowerShell](https://img.shields.io/badge/PowerShell-0072C6?logo=powershell&logoColor=ffffff&style=flat-square "PowerShell")
 ![License](https://img.shields.io/static/v1?label=License&message=MIT&style=flat-square "License")
 [![GitHub Stars](https://img.shields.io/github/stars/hugoalh-studio/ghactions-toolkit-powershell?label=Stars&logo=github&logoColor=ffffff&style=flat-square "GitHub Stars")](https://github.com/hugoalh-studio/ghactions-toolkit-powershell/stargazers)
 [![GitHub Contributors](https://img.shields.io/github/contributors/hugoalh-studio/ghactions-toolkit-powershell?label=Contributors&logo=github&logoColor=ffffff&style=flat-square "GitHub Contributors")](https://github.com/hugoalh-studio/ghactions-toolkit-powershell/graphs/contributors)
@@ -22,7 +21,7 @@ A PowerShell module to provide a better and easier way for GitHub Actions to com
 
 ## 📚 Documentation (Excerpt)
 
-For the full documentation, please visit [GitHub Repository Wiki](https://github.com/hugoalh-studio/ghactions-toolkit-powershell/wiki).
+For the full documentation, please visit the [GitHub Repository Wiki](https://github.com/hugoalh-studio/ghactions-toolkit-powershell/wiki).
 
 ### Getting Started
 

hugoalh.GitHubActionsToolkit/LICENSE.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright © 2021\~2022 hugoalh Studio
+Copyright © 2021\~2023 hugoalh Studio
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

hugoalh.GitHubActionsToolkit/hugoalh.GitHubActionsToolkit.psd1

@@ -18,7 +18,7 @@
 	CompanyName = 'hugoalh Studio'
 
 	# Copyright statement for this module
-	Copyright = 'MIT © 2021~2022 hugoalh Studio'
+	Copyright = 'MIT © 2021~2023 hugoalh Studio'
 
 	# Description of the functionality provided by this module
 	Description = 'Provide a better and easier way for GitHub Actions to communicate with the runner machine, and the toolkit for developing GitHub Actions in PowerShell.'
@@ -249,7 +249,7 @@
 			ReleaseNotes = '(Please visit https://github.com/hugoalh-studio/ghactions-toolkit-powershell/releases.)'
 
 			# Prerelease string of this module
-			Prerelease = 'beta1'
+			Prerelease = 'beta2'
 
 			# Flag to indicate whether the module requires explicit user acceptance for install/update/save
 			RequireLicenseAcceptance = $False

hugoalh.GitHubActionsToolkit/module/command-base.psm1

@@ -27,24 +27,45 @@ Function Clear-FileCommand {
 	[CmdletBinding(HelpUri = 'https://github.com/hugoalh-studio/ghactions-toolkit-powershell/wiki/api_function_clear-githubactionsfilecommand#Clear-GitHubActionsFileCommand')]
 	[OutputType([Void])]
 	Param (
-		[Parameter(Mandatory = $True, Position = 0)][Alias('Types')][GitHubActionsFileCommandTypes]$Type
+		[Alias('Env', 'EnvironmentVariables', 'Var', 'Variable', 'Variables')][Switch]$EnvironmentVariable,
+		[Alias('Outputs')][Switch]$Output,
+		[Alias('Paths')][Switch]$Path,
+		[Alias('States')][Switch]$State,
+		[Alias('Summary')][Switch]$StepSummary,
+		[Parameter(Position = 0)][Alias('Types')][GitHubActionsFileCommandTypes]$Type
 	)
-	If (($Type -band [GitHubActionsFileCommandTypes]::EnvironmentVariable) -ieq [GitHubActionsFileCommandTypes]::EnvironmentVariable) {
+	If (
+		$EnvironmentVariable.IsPresent -or
+		($Type -band [GitHubActionsFileCommandTypes]::EnvironmentVariable) -ieq [GitHubActionsFileCommandTypes]::EnvironmentVariable
+	) {
 		Remove-Item -LiteralPath $Env:GITHUB_ENV -Confirm:$False -ErrorAction 'Continue'
 	}
-	If (($Type -band [GitHubActionsFileCommandTypes]::Output) -ieq [GitHubActionsFileCommandTypes]::Output) {
+	If (
+		$Output.IsPresent -or
+		($Type -band [GitHubActionsFileCommandTypes]::Output) -ieq [GitHubActionsFileCommandTypes]::Output
+	) {
 		Remove-Item -LiteralPath $Env:GITHUB_OUTPUT -Confirm:$False -ErrorAction 'Continue'
 	}
-	If (($Type -band [GitHubActionsFileCommandTypes]::Path) -ieq [GitHubActionsFileCommandTypes]::Path) {
+	If (
+		$Path.IsPresent -or
+		($Type -band [GitHubActionsFileCommandTypes]::Path) -ieq [GitHubActionsFileCommandTypes]::Path
+	) {
 		Remove-Item -LiteralPath $Env:GITHUB_PATH -Confirm:$False -ErrorAction 'Continue'
 	}
-	If (($Type -band [GitHubActionsFileCommandTypes]::State) -ieq [GitHubActionsFileCommandTypes]::State) {
+	If (
+		$State.IsPresent -or
+		($Type -band [GitHubActionsFileCommandTypes]::State) -ieq [GitHubActionsFileCommandTypes]::State
+	) {
 		Remove-Item -LiteralPath $Env:GITHUB_STATE -Confirm:$False -ErrorAction 'Continue'
 	}
-	If (($Type -band [GitHubActionsFileCommandTypes]::StepSummary) -ieq [GitHubActionsFileCommandTypes]::StepSummary) {
+	If (
+		$StepSummary.IsPresent -or
+		($Type -band [GitHubActionsFileCommandTypes]::StepSummary) -ieq [GitHubActionsFileCommandTypes]::StepSummary
+	) {
 		Remove-Item -LiteralPath $Env:GITHUB_STEP_SUMMARY -Confirm:$False -ErrorAction 'Continue'
 	}
 }
+Set-Alias -Name 'Clear-FileCommands' -Value 'Clear-FileCommand' -Option 'ReadOnly' -Scope 'Local'
 <#
 .SYNOPSIS
 GitHub Actions (Private) - Format Command Parameter Value
@@ -150,7 +171,7 @@ Function Write-FileCommand {
 		Else {
 			[String]$ItemRaw = "$Name=$Value" -ireplace '\r?\n', ''
 			Do {
-				[String]$Token = New-GitHubActionsRandomToken -Length 16
+				[String]$Token = New-GitHubActionsRandomToken
 			}
 			While ( $ItemRaw -imatch [RegEx]::Escape($Token) )
 			@(
@@ -166,4 +187,6 @@ Export-ModuleMember -Function @(
 	'Clear-FileCommand',
 	'Write-Command',
 	'Write-FileCommand'
+) -Alias @(
+	'Clear-FileCommands'
 )

hugoalh.GitHubActionsToolkit/module/command-control.psm1

@@ -163,7 +163,7 @@ Function New-CommandsEndToken {
 	[OutputType([String])]
 	Param ()
 	Do {
-		[String]$Result = New-GitHubActionsRandomToken -Length 64
+		[String]$Result = New-GitHubActionsRandomToken
 	}
 	While ( $Result -iin $GitHubActionsCommandsEndTokensUsed )
 	$Script:GitHubActionsCommandsEndTokensUsed += $Result

hugoalh.GitHubActionsToolkit/module/environment-variable.psm1

@@ -34,7 +34,7 @@ Function Add-PATH {
 		[Parameter(ValueFromPipelineByPropertyName = $True)][Alias('Scopes')][GitHubActionsEnvironmentVariableScopes]$Scope = [GitHubActionsEnvironmentVariableScopes]3
 	)
 	Begin {
-		[Boolean]$Legacy = [String]::IsNullOrWhiteSpace($Env:GITHUB_PATH)
+		[Boolean]$UseLegacyMethod = [String]::IsNullOrWhiteSpace($Env:GITHUB_PATH)
 	}
 	Process {
 		ForEach ($Item In (
@@ -49,7 +49,7 @@ Function Add-PATH {
 				Add-Content -LiteralPath $Env:PATH -Value "$([System.IO.Path]::PathSeparator)$Item" -Confirm:$False -NoNewLine
 			}
 			If (($Scope -band [GitHubActionsEnvironmentVariableScopes]::Subsequent) -ieq [GitHubActionsEnvironmentVariableScopes]::Subsequent) {
-				If ($Legacy) {
+				If ($UseLegacyMethod) {
 					Write-GitHubActionsCommand -Command 'add-path' -Value $Item
 				}
 				Else {
@@ -88,7 +88,7 @@ Function Set-EnvironmentVariable {
 		[Parameter(ValueFromPipelineByPropertyName = $True)][Alias('Scopes')][GitHubActionsEnvironmentVariableScopes]$Scope = [GitHubActionsEnvironmentVariableScopes]3
 	)
 	Begin {
-		[Boolean]$Legacy = [String]::IsNullOrWhiteSpace($Env:GITHUB_ENV)
+		[Boolean]$UseLegacyMethod = [String]::IsNullOrWhiteSpace($Env:GITHUB_ENV)
 	}
 	Process {
 		If ($PSCmdlet.ParameterSetName -ieq 'Multiple') {
@@ -109,7 +109,7 @@ Function Set-EnvironmentVariable {
 				Out-Null
 		}
 		If (($Scope -band [GitHubActionsEnvironmentVariableScopes]::Subsequent) -ieq [GitHubActionsEnvironmentVariableScopes]::Subsequent) {
-			If ($Legacy) {
+			If ($UseLegacyMethod) {
 				Write-GitHubActionsCommand -Command 'set-env' -Parameter @{ 'name' = $Name } -Value $Value
 			}
 			Else {

hugoalh.GitHubActionsToolkit/module/internal/token.psm1

@@ -19,7 +19,7 @@ Function New-RandomToken {
 	[CmdletBinding()]
 	[OutputType([String])]
 	Param (
-		[Parameter(Position = 0)][ValidateRange(1, [UInt32]::MaxValue)][UInt32]$Length = 8,
+		[Parameter(Position = 0)][ValidateRange(1, [UInt32]::MaxValue)][UInt32]$Length = 16,
 		[Alias('UpperCase')][Switch]$WithUpperCase
 	)
 	[Char[]]$Pool = $PoolLowerCase + $PoolNumber + ($WithUpperCase.IsPresent ? $PoolUpperCase : @()) |