AnsiConsole

A PowerShell module which supports ANSI console operations. This module provides functions for colorizing and positioning on the console using ANSI escape sequences. The functions create formatted output using ANSI escape sequences.

The easiest way to use the module is to pipe strings through Set-AnsiConsole, passing the results back to the host terminal for display. For example:

   "This is red" | Set-AnsiConsole -Foreground BrightRed -Bold
   "This is using an RGB value and italics" | Set-AnsiConsole -ForegroundRGB FF3355 -Italic

Additional functions are provided for specific functionality, including bold, dim, italic, underline, and foreground/background color settings. The color settings can be configured using the 16 defined ANSI colors, the 256 palette colors, or RGB values provided in hexadecimal format (with or without the leading #).

By default, the included functions will automatically apply an ANSI reset to the end of each string. This can be disabled by using Set-AnsiAutoReset to configure the default behavior:

Set-AnsiAutoReset $false

Release Process

The build workflow publishes a module to the PowerShell Gallery.

The process relies on a few steps:

1. Create a branch in the form releases/v#.#.# (manual)
2. openReleasePR is triggered by the create of the specially named branch. The workflow updates the module version and creates a PR to merge the changes
3. Once the PR is merged, the branch is deleted and pull_request.closed triggers closeReleasePR to create a release. Creating a release within a workflow using GITHUB_TOKEN and the GitHub CLI will not generate the related events, so a token is created using a GitHub App with appropriate permissions. The CLI then uses that token. Since it's a different token, the release events will be raised and responded to by the workflows.
4. The release.published event triggers publish.yml. This signs the PowerShell script and runs PSScriptAnalyzer on the code. The signing process is only supported on Windows, so a windows-latest runner is used. If the static analysis is successful, the unit tests for the scripts are run on Windows, Ubuntu, and MacOS runners to ensure the module works on all platforms. On Windows, both the Desktop and Core versions are validated. If the test succeeds, the results are queued for release to the PowerShell Gallery.

%%{init: {"theme": "default" }}%%
flowchart LR
    subgraph main ["Process Flow"]
      direction LR
      A(Create release branch) --> |:create:| openPR
      openPR --> |:pull_request.close:| closePR
      closePR --> |:release.published:| publish
    end

    subgraph openPR ["openReleasePR.yml"]
      direction TB
      a1(Update module) --> |:push:| a2(Push)
      a2 --> a3(Create PR)
    end
    subgraph closePR ["closeReleasePR.yml"]
      direction TB
      b1(Create token) --> b2(Create release)
    end
    subgraph publish [publish.yml]
      direction TB
      c1(Sign code) --> c2(PSScriptAnalyzer Lint)
      c2 --> runTests
      runTests --> c3(Publish to Gallery)
    end
    subgraph runTests [Run Tests]
      windows
      linux
      macOS
    end

    classDef subprocess fill:#aaddff,stroke:#333,stroke-width:1px,font-weight:bold,line-height:1rem;
    classDef innerProcess font-weight:bold,line-height:1rem;
    classDef parent fill:#fff,stroke-width:0,font-weight:bold,text-decoration:underline,font-size:2rem;
    class openPR,closePR,publish subprocess
    class runTests innerProcess;
    class main parent

Loading