Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

feat(cli): native Windows console editing (raw-mode stub today)

Aperta
  • Qualcosa non va?
#1,037 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 10 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
zig
Ambito
cli

Direzione di ricerca

Start with src/channels/cli.zig and src/channels/cli_line_editor.zig, then read the existing CliRawMode implementation and the POSIX backend to understand the shared surface. Implement the Windows console backend while keeping the WASI stub unchanged; add a Windows-only test for mode restoration and console width. Done means the CLI/history suites and 12 line-editor tests pass on Windows, alongside the specified Windows smoke test and formatting check.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement

Source

The third non-blocking follow-up named in the approval on #970:

Native Windows console editing remains an explicitly documented follow-up.

#1028 deliberately scopes this out ("Out of scope: native Windows console editing") and does not track it, so this issue exists to give it a home. #970 has since merged as f239fa1c, so the code this targets is on main and this can be implemented directly against it.

Problem

supportsRawMode() returns false on Windows and WASI, and CliRawMode compiles to a stub whose enable/suspendProcess/quitProcess all return error.NotSupported, whose waitForEscapeContinuation hardcodes false, and whose terminalColumns hardcodes DEFAULT_TERMINAL_COLUMNS (80).

The result is that the interactive line editor introduced by #970 — arrow-key movement, history recall, debounce coalescing, incremental escape parsing — is effectively POSIX-only. On Windows the CLI cannot enter raw mode, so it falls back to plain line reading: no cursor editing, no multiline history recall, a fixed 80-column assumption, and no suspend/resume path.

The stub is a deliberate and correct fail-fast boundary (AGENTS.md §3.4 keeps unsupported paths explicit rather than silently wrong). This issue is about giving Windows real console support, not about changing the stub's behaviour in the meantime.

Proposed

  • Implement a Windows console backend behind the same CliRawMode surface, so the editor is portable without conditional logic at the call sites:
    • enable / disable via SetConsoleMode (ENABLE_ECHO_INPUT, ENABLE_VIRTUAL_TERMINAL_INPUT, ENABLE_PROCESSED_INPUT), restoring the original modes on exit.
    • terminalColumns via GetConsoleScreenBufferInfo, replacing the hardcoded 80.
    • waitForEscapeContinuation using WaitForSingleObject with the existing ESCAPE_SEQUENCE_TIMEOUT_MS budget, keeping escape parsing behavior identical across platforms.
    • suspendProcess / quitProcess mapped to the Windows equivalents (SetConsoleCtrlHandler / GenerateConsoleCtrlEvent).
  • Keep the WASI stub as-is unless WASI gains a console API; it is a different problem from Windows.
  • Preserve the existing contract that suspend/resume behavior is symmetric — termios restore on POSIX, mode restore on Windows.

Test plan

  • Windows-only, CI-gated: a console test that enters and exits raw mode, asserts ENABLE_ECHO_INPUT is cleared inside and restored after, and asserts GetConsoleScreenBufferInfo reports the real width rather than 80.
  • Cross-platform parity: the 12 standalone cli_line_editor.zig tests and the CLI/history suites must pass unchanged on Windows, which is the strongest signal that the backend is behaviorally equivalent.
  • zig build test --summary all (0 failures, 0 leaks) on both Linux and Windows runners; zig fmt --check src/.
  • Manual interactive pass on Windows for arrow keys, history recall, resize, and Ctrl-C/Ctrl-Z, mirroring the POSIX smoke test.

Scope / risk

  • High risk (src/channels/cli.zig, src/channels/cli_line_editor.zig) — interactive input path, and the only place in the CLI that is platform-conditional.
  • Interactive rendering and signal behavior cannot be established by unit tests alone; the OS-level smoke test is part of the deliverable, not optional. The approval on #970 explicitly noted that signal/resize behavior was "inspected in code, not claimed as an OS-level smoke test" — this work should close that gap for Windows rather than repeat it.
  • A POSIX-side PTY smoke test of the merged editor has since been run (see #1028) and passed on every path except the known resize-sampling issue; a matching Windows harness should be the acceptance bar here.
  • Code change, so tracked separately from #970 (now merged).
Lingua principale
Zig
Stelle
8.1k
Fork
945
Merge medio
7g 6h
PR unite (30g)
7

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di nullclaw/nullclaw

Tutte le issue di nullclaw/nullclaw

Issue simili

Altre issue su CLI

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.