docs(console): document 21 undocumented exported functions; fix StripANSI reference in AGENTS.md by Copilot · Pull Request #26330 · github/gh-aw

Copilot · 2026-04-14T23:40:10Z

pkg/console/README.md covered ~58% of the package's public API — 21 exported functions across render.go, terminal.go, verbose.go, layout_wasm.go, input*.go, select_wasm.go, form_wasm.go, and console_wasm.go had no documentation. Additionally, AGENTS.md referenced stringutil.StripANSIEscapeCodes() which does not exist; the correct name is stringutil.StripANSI().

`AGENTS.md`

stringutil.StripANSIEscapeCodes() → stringutil.StripANSI()

`pkg/console/README.md`

Message Formatting table — added FormatListHeader, FormatLocationMessage, FormatCountMessage (WASM-only, noted as such)
Section Rendering — added RenderTree
Interactive Prompts — added ShowInteractiveList, PromptInput, PromptSecretInput, PromptInputWithValidation, PromptSelect, PromptMultiSelect, RunForm; WASM-only and non-TTY availability noted per function
Layout Functions (new section) — LayoutTitleBox, LayoutInfoSection, LayoutEmphasisBox, LayoutJoinVertical; all WASM-only
Terminal Control (new section) — ClearScreen, ClearLine, ShowWelcomeBanner
Verbose Logging (new section) — LogVerbose
Utility Functions — added FormatNumber, ToRelativePath, FormatErrorWithSuggestions

…rence in AGENTS.md Agent-Logs-Url: https://github.com/github/gh-aw/sessions/227f441a-3020-4a42-ab3b-68614001b640 Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot

Pull request overview

Documents previously undocumented exported functions in pkg/console and corrects an invalid stringutil function reference in AGENTS.md.

Changes:

Expanded pkg/console/README.md to cover additional exported formatting, rendering, interactive prompt, layout, terminal control, verbose logging, and utility functions.
Fixed AGENTS.md to reference stringutil.StripANSI() (existing) instead of stringutil.StripANSIEscapeCodes() (nonexistent).

Show a summary per file

File	Description
pkg/console/README.md	Adds API documentation for multiple exported console functions, including new sections for layout/terminal/verbose utilities.
AGENTS.md	Corrects the documented ANSI-stripping helper name to match the actual `stringutil` API.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comments suppressed due to low confidence (2)

pkg/console/README.md:583

PromptInputWithValidation is documented as an interactive WASM-only prompt, but the WASM implementation always returns an error (pkg/console/input_wasm.go) and there is no non-WASM implementation. Please update the documentation to match the current behavior/availability so callers don’t expect this to work.

### `PromptInputWithValidation(title, description, placeholder string, validate func(string) error) (string, error)`

Like `PromptInput` but accepts a validation function that is called on the entered value before the form is submitted.

```go
value, err := console.PromptInputWithValidation(
    "Workflow name", "Must be kebab-case", "my-workflow",
    func(s string) error {
        if s == "" {
            return errors.New("name cannot be empty")
        }
        return nil
    },
)

Note: PromptInputWithValidation is only available in WASM builds.

**pkg/console/README.md:631**
* `RunForm` is documented as a working WASM-only form runner, but the only implementation (`pkg/console/form_wasm.go`) always returns an error (`interactive forms not available in Wasm`). Please update this section to reflect that it’s currently unsupported/unimplemented, or adjust the docs to the actual supported path.

`RunForm(fields []FormField) error`

Runs a multi-field interactive form defined by a slice of FormField values. Populates the Value pointer of each field and returns an error if the form is cancelled or fails.

var name, token string
err := console.RunForm([]console.FormField{
    {Type: "input",    Title: "Name",  Value: &name},
    {Type: "password", Title: "Token", Value: &token},
})

Note: RunForm is only available in WASM builds. Use huh forms directly in non-WASM builds.

</details>


- **Files reviewed:** 2/2 changed files
- **Comments generated:** 5

Copilot · 2026-04-15T00:05:51Z

+### `ShowInteractiveList(title string, items []ListItem) (string, error)`
+
+Displays an interactive single-selection list using arrow key navigation. Returns the value of the selected `ListItem`. Returns an error if the list is empty or the prompt is cancelled. Falls back to a numbered text list in non-TTY environments.
+


ShowInteractiveList has a WASM stub that always returns an error (pkg/console/list_wasm.go), but this doc block describes interactive behavior and a non-TTY fallback without mentioning the WASM behavior. Please document that WASM builds return an error / the function is unavailable there, to avoid misleading consumers.

Copilot · 2026-04-15T00:05:51Z

+### `PromptInput(title, description, placeholder string) (string, error)`
+
+Displays a single-line text input prompt. Returns the entered string or an error.
+
+```go
+value, err := console.PromptInput("Repository name", "Enter the full owner/repo", "owner/repo")
+```
+
+> **Note**: `PromptInput` is only available in WASM builds. Use `huh` forms directly in non-WASM builds.
+


This section says PromptInput is “only available in WASM builds”, but the WASM implementation (pkg/console/input_wasm.go) always returns an error (interactive input not available in Wasm) and there is no non-WASM implementation. The README should reflect the actual behavior (currently unimplemented / always errors) and clarify availability across build targets.

This issue also appears on line 566 of the same file.

Copilot · 2026-04-15T00:05:52Z

+### `PromptSelect(title, description string, options []SelectOption) (string, error)`
+
+Displays a single-select dropdown prompt. Returns the `Value` of the chosen `SelectOption` or an error.
+
+```go
+opt, err := console.PromptSelect(
+    "Engine", "Choose an AI engine",
+    []console.SelectOption{
+        {Label: "Copilot", Value: "copilot"},
+        {Label: "Claude",  Value: "claude"},
+    },
+)
+```
+
+> **Note**: `PromptSelect` is only available in WASM builds.
+
+### `PromptMultiSelect(title, description string, options []SelectOption, limit int) ([]string, error)`
+
+Displays a multi-select prompt. Returns a slice of selected `Value` strings or an error. Pass `limit ≤ 0` for no selection limit.
+
+```go
+selected, err := console.PromptMultiSelect(
+    "Toolsets", "Choose toolsets to enable",
+    []console.SelectOption{
+        {Label: "Default", Value: "default"},
+        {Label: "Issues",  Value: "issues"},
+        {Label: "PRs",     Value: "pull_requests"},
+    },
+    0,
+)
+```
+
+> **Note**: `PromptMultiSelect` is only available in WASM builds.
+


PromptSelect/PromptMultiSelect are documented as functional interactive prompts, but in WASM builds they always return an error (pkg/console/select_wasm.go) and there are no non-WASM implementations. The README should clarify that these currently aren’t available (or document the supported alternative API).

This issue also appears on line 618 of the same file.

Copilot · 2026-04-15T00:05:52Z

+
+## Terminal Control Functions
+
+These functions emit ANSI control sequences to manage the terminal display. They are no-ops when stderr is not a TTY.


The section header says “These functions … are no-ops when stderr is not a TTY”, but ShowWelcomeBanner still prints the banner/description even when stderr isn’t a TTY (only ClearScreen is gated). Please narrow the statement to ClearScreen/ClearLine, or document the actual behavior of ShowWelcomeBanner in non-TTY environments.

Suggested change

These functions emit ANSI control sequences to manage the terminal display. They are no-ops when stderr is not a TTY.

These functions emit ANSI control sequences to manage the terminal display. `ClearScreen` and `ClearLine` are no-ops when stderr is not a TTY.

Copilot · 2026-04-15T00:05:52Z

+
+```go


RenderTree is only defined under //go:build js || wasm (see pkg/console/console_wasm.go), so it isn’t available in non-WASM builds. The README section should explicitly note this (or document the non-WASM equivalent, if any).

Suggested change

```go

**Note:** `RenderTree` is only available in `js/wasm` builds (it is defined behind a build tag), so it cannot be used from non-WASM targets.

```go

// Available only when building for GOOS=js / GOARCH=wasm.

Initial plan

bfcf227

Copilot AI assigned Copilot and pelikhan Apr 14, 2026

Copilot started work on behalf of pelikhan April 14, 2026 23:47 View session

Copilot AI linked an issue Apr 14, 2026 that may be closed by this pull request

Specification Audit — 2026-04-14 — console package API drift (21 undocumented exported functions) #26329

Closed

2 tasks

docs: document 21 undocumented console exports and fix StripANSI refe…

30f9951

…rence in AGENTS.md Agent-Logs-Url: https://github.com/github/gh-aw/sessions/227f441a-3020-4a42-ab3b-68614001b640 Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Fix console package API drift by documenting exported functions~~ docs(console): document 21 undocumented exported functions; fix StripANSI reference in AGENTS.md Apr 15, 2026

Copilot finished work on behalf of pelikhan April 15, 2026 00:01

Copilot AI requested a review from pelikhan April 15, 2026 00:01

pelikhan approved these changes Apr 15, 2026

View reviewed changes

pelikhan marked this pull request as ready for review April 15, 2026 00:02

Copilot AI review requested due to automatic review settings April 15, 2026 00:02

pelikhan merged commit b330c2a into main Apr 15, 2026
4 checks passed

pelikhan deleted the copilot/fix-console-package-api-drift branch April 15, 2026 00:02

Copilot started reviewing on behalf of pelikhan April 15, 2026 00:03 View session

Copilot AI reviewed Apr 15, 2026

View reviewed changes

This was referenced Apr 15, 2026

[aw] No-Op Runs #25214

Open

[docs] Update documentation for features merged April 15, 2026 #26399

Merged

[doc-healer] DDUw improvement: recognize non-[docs] PR closures in step 1c to avoid redundant re-scanning #26442

Closed

Copilot AI mentioned this pull request Apr 15, 2026

fix(DDUw): recognize non-[docs] PR closures in step 1c to avoid redundant re-scanning #26443

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(console): document 21 undocumented exported functions; fix StripANSI reference in AGENTS.md#26330

docs(console): document 21 undocumented exported functions; fix StripANSI reference in AGENTS.md#26330
pelikhan merged 2 commits intomainfrom
copilot/fix-console-package-api-drift

Copilot AI commented Apr 14, 2026 •

edited

Loading

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 15, 2026

Uh oh!

Copilot AI Apr 15, 2026

Uh oh!

Copilot AI Apr 15, 2026

Uh oh!

Copilot AI Apr 15, 2026

Uh oh!

Copilot AI Apr 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		### `ShowInteractiveList(title string, items []ListItem) (string, error)`

		Displays an interactive single-selection list using arrow key navigation. Returns the value of the selected `ListItem`. Returns an error if the list is empty or the prompt is cancelled. Falls back to a numbered text list in non-TTY environments.


		## Terminal Control Functions

		These functions emit ANSI control sequences to manage the terminal display. They are no-ops when stderr is not a TTY.

-```go
+**Note:** `RenderTree` is only available in `js/wasm` builds (it is defined behind a build tag), so it cannot be used from non-WASM targets.
+```go
+// Available only when building for GOOS=js / GOARCH=wasm.

Conversation

Copilot AI commented Apr 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

AGENTS.md

pkg/console/README.md

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Copilot's findings

RunForm(fields []FormField) error

Uh oh!

Copilot AI Apr 15, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 15, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 15, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 15, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 15, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Apr 14, 2026 •

edited

Loading

`AGENTS.md`

`pkg/console/README.md`

`RunForm(fields []FormField) error`