feat: Allow configuring PowerShell preference variables

[z-Fng]

Description

This PR makes the following changes:

• feat: Allow configuring some of PowerShell preference variables.

  Name	Type	Default Value
  DebugPreference	String	'SilentlyContinue'
  InformationPreference	String	'SilentlyContinue'
  VerbosePreference	String	'SilentlyContinue'
  WarningPreference	String	'Continue'

• chore: Change default VerbosePreference from Continue to SilentlyContinue.

Motivation and Context

• Most Verbose outputs are unnecessary at the moment. Setting VerbosePreference to Continue can suppress these outputs.
  Closes Add configuration items to reduce a large amount of meaningless verbose output #66
• Allow configuring PowerShell preference variables, which lays the groundwork for future code refactoring (such as log level management).
  Relates to Improve GitHub Action log output for reduced debug information and better readability #33

Test Cases

• https://github.com/z-Fng/Scoop-Extras/actions/runs/19240280236/job/55000983538

Summary by CodeRabbit

• Documentation

  • Added a PowerShell preference variables section with defaults and a link to Microsoft docs.

• Behavioral Change

  • Removed explicit global preference settings that previously forced continue behavior, changing default error/verbosity handling.

• Refactor

  • Centralized startup initialization for preference variables with support for optional environment overrides and startup logging of applied settings.

[coderabbitai]

Walkthrough

Removes hardcoded global PowerShell preference assignments from action.ps1, introduces Initialize-PreferenceVariable in src/Variables.psm1 to set preference globals (with optional Env: overrides, ErrorActionPreference ignored), and documents the preference variables in README.md.

Changes

Cohort / File(s)	Summary
Documentation README.md	Adds "PowerShell Preference Variables" subsection under available environment variables with a link to Microsoft docs and a table listing DebugPreference, InformationPreference, VerbosePreference, WarningPreference (type: String) and their default values.
Preference Removal action.ps1	Removes global assignments \$Global:ErrorActionPreference = 'Continue' and \$Global:VerbosePreference = 'Continue' and the preceding comment; no other logic changes.
Preference Initialization src/Variables.psm1	Adds Initialize-PreferenceVariable that defines an ordered map of default preferences, ensures ErrorActionPreference is set first and ignored from environment overrides, applies Env: overrides for other prefs, logs assignments via Write-Host, sets each preference in the Global: scope, and invokes the function immediately.

Sequence Diagram(s)

sequenceDiagram
    autonumber
    participant User
    participant ActionPS as action.ps1
    participant Vars as src/Variables.psm1
    Note over ActionPS,Vars `#DDEEFF`: Startup flow after this PR
    User->>ActionPS: trigger action
    ActionPS->>Vars: import / dot-source Variables module
    Vars->>Vars: Initialize-PreferenceVariable()
    rect rgb(220,238,255)
      Note right of Vars: Build ordered defaults\nSet ErrorActionPreference first (ignored from env)
    end
    alt Env override present (per-variable, except ignored)
        Vars->>Vars: read Env:<Name> -> apply override
    else No env override
        Vars->>Vars: apply defaults
    end
    Vars->>ActionPS: preferences set in Global: scope
    ActionPS->>User: continue execution (no hardcoded global prefs)

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

• Areas to review:
  • src/Variables.psm1: correct handling of ErrorActionPreference ordering and IgnoreEnv behavior, Env: precedence, logging verbosity, and use of Global: scope.
  • action.ps1: ensure removal of globals doesn't unintentionally alter downstream error/verbose behavior.
  • README.md: verify table values and Microsoft docs link.

Poem

🐇 I nudged the prefs with careful paws,
Env whispers chosen without a pause.
Defaults set, the noise grows thin,
Globals freed, the logs can grin.
A hop, a wink — tidy outputs win.

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately summarizes the main feature being added—allowing configuration of PowerShell preference variables—and is directly related to the primary objectives of the pull request.
Linked Issues check	✅ Passed	The PR fulfills the primary requirement from issue #66 by adding configuration capability for PowerShell preference variables to reduce verbose output via VerbosePreference.
Out of Scope Changes check	✅ Passed	All changes are scoped to implementing configurable PowerShell preference variables: README documentation, removal of hardcoded preferences, and new initialization function.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

🧹 Nitpick comments (1)

README.md (1)

28-35: Consider clarifying ErrorActionPreference handling.

The documentation describes four preference variables that can be overridden via environment variables. However, the implementation in src/Variables.psm1 also manages ErrorActionPreference but explicitly prevents environment variable overrides (line 8: IgnoreEnv = $true).

Consider adding a note explaining that ErrorActionPreference is managed internally and cannot be overridden, or briefly mention why it's excluded from user configuration.

Example addition after line 29:

    - If an environment variable with the same name as the following PowerShell preference variable exists, its value will be assigned to the corresponding PowerShell preference variable:
    - Note: `ErrorActionPreference` is managed internally and cannot be overridden via environment variables.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 25a6ee4 and 1f8e54e.

📒 Files selected for processing (3)

• README.md (1 hunks)
• action.ps1 (0 hunks)
• src/Variables.psm1 (1 hunks)

💤 Files with no reviewable changes (1)

• action.ps1

🔇 Additional comments (2)

src/Variables.psm1 (2)

8-8: Verify that locking ErrorActionPreference is intentional.

Line 8 prevents ErrorActionPreference from being overridden via environment variables. This is a significant decision since ErrorActionPreference controls how the script handles errors globally. Confirm this restriction aligns with your design goals.

If users need to override error handling behavior (e.g., for debugging), they won't be able to do so via environment variables with this implementation.

---

32-33: LGTM!

Invoking the initialization function at module load time ensures preference variables are configured before any other module code executes. The approach is appropriate for this use case.

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1f8e54e and 717dfd3.

📒 Files selected for processing (3)

• README.md (1 hunks)
• action.ps1 (0 hunks)
• src/Variables.psm1 (1 hunks)

💤 Files with no reviewable changes (1)

• action.ps1

🔇 Additional comments (3)

src/Variables.psm1 (3)

7-13: Past critical issue resolved.

The typo "Vaule" → "Value" from the previous review has been correctly fixed. The hashtable structure now properly stores default preference values that will be retrieved on line 17.

---

26-26: Past refactor suggestion implemented.

The code now uses Write-Host instead of Write-Warning as suggested in the previous review, with a clear justifying comment on line 25 explaining the rationale.

---

1-33: Implementation looks solid.

The Initialize-PreferenceVariable function correctly:

• Defines sensible defaults for PowerShell preference variables
• Respects environment variable overrides (except for ErrorActionPreference, which is intentionally protected)
• Sets variables in the Global scope as required for preference variables
• Is appropriately scoped as internal-only (not exported)

The implementation addresses the PR objective to reduce verbose output by defaulting VerbosePreference to SilentlyContinue.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

src/Variables.psm1 (2)

21-23: Consider making the IgnoreEnv check more explicit.

The condition -not $Preferences.IgnoreEnv works correctly but relies on $null being falsy when IgnoreEnv is not specified. For better readability and maintainability, consider being more explicit:

-        if ((-not $Preferences.IgnoreEnv) -and ($EnvValue)) {
+        if (($Preferences.IgnoreEnv -ne $true) -and ($EnvValue)) {
             $Value = $EnvValue
         }

This makes it clearer that the intent is to check whether IgnoreEnv is explicitly set to $true.

---

1-33: Verify: Is the function intentionally internal-only?

The function Initialize-PreferenceVariable is not included in the Export-ModuleMember call (lines 71-74), making it internal to the module. Since it's invoked immediately on line 33 during module import, this is likely intentional. However, this means users cannot manually re-initialize preferences later if needed.

If the function should remain internal-only, this is fine. If there's a use case for allowing manual re-initialization, consider exporting it.

Optional: Consider adding ProgressPreference to the list.

The code sets five common preference variables but omits ProgressPreference, which controls progress bar display. In CI/CD environments, setting it to 'SilentlyContinue' can reduce unnecessary output.

If desired, add it to the hashtable:

     $DefaultPreferences = [ordered]@{
         ErrorActionPreference = @{ Value = 'Continue'; IgnoreEnv = $true } # Prevent changing ErrorActionPreference from env
         DebugPreference       = @{ Value = 'SilentlyContinue' }
         InformationPreference = @{ Value = 'SilentlyContinue' }
+        ProgressPreference    = @{ Value = 'SilentlyContinue' }
         VerbosePreference     = @{ Value = 'SilentlyContinue' }
         WarningPreference     = @{ Value = 'Continue' }
     }

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 717dfd3 and ad54d5c.

📒 Files selected for processing (3)

• README.md (1 hunks)
• action.ps1 (0 hunks)
• src/Variables.psm1 (1 hunks)

💤 Files with no reviewable changes (1)

• action.ps1

🚧 Files skipped from review as they are similar to previous changes (1)

• README.md

🔇 Additional comments (2)

src/Variables.psm1 (2)

1-5: LGTM!

The function follows PowerShell naming conventions and includes appropriate documentation for its purpose.

---

25-28: LGTM!

The logging approach with Write-Host is appropriate for GitHub Actions, and using -Scope Global correctly ensures preference variables are set globally even when called from within the module.

[abgox]

• Maybe we still need to consider the readability of the logs.

• I think there might need to be some separators between the check logs of each application, such as a blank line?