Replace the unmaintained prompts library, behind a @docusaurus/prompts abstraction

Abierto
#13,079 1 comentario 0 reacciones 0 asignados Ver en GitHub

@sameer727 ya está trabajando en esto.

Desde el 21/11/2026.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
node.js, typescript

Línea de trabajo

Start by reading the listed prompt call sites: create-docusaurus, commands/swizzle/prompts.ts, and getHostPort, then inspect the draft migration in pull request #13017 for a reference. The issue proposes a typed @docusaurus/prompts package and shared handling for unanswered prompts, but leaves decisions open about public versus internal scope and end-to-end CI coverage; agree on those before implementation.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

domain: dependencies proposal

Motivation

Our CLIs use prompts for their interactive questions. It's unmaintained: its last release is v2.4.2 from October 2021, with 148 open issues.

We already hit its bugs:

Where we use it

Package Prompts Types
create-docusaurus 8 (site name, template, language, git URL, git strategy, custom git command, local path, package manager) select, text with async validate
@docusaurus/core swizzle (commands/swizzle/prompts.ts) 5 (theme, component, danger, action, language) select, autocomplete with a custom suggest; cancelling exits with code 0
@docusaurus/core getHostPort 1 (use another port?) confirm, only when process.stdout.isTTY

Each call site uses the prompts API directly: answers read from an object with type casts, and its own onCancel. Swizzle probably has the same closed-stdin problem as create-docusaurus had.

Proposal: a @docusaurus/prompts abstraction

Create a small @docusaurus/prompts package that our CLIs use instead of a prompt library, keeping the library as an implementation detail:

const language = await askSelect({
  message: 'Which language do you want to use?',
  choices: [
    {name: 'JavaScript', value: 'javascript'},
    {name: 'TypeScript', value: 'typescript'},
  ],
  // Named in the error when there is no answer (Ctrl+C, closed stdin)
  answerHint: 'the --javascript or --typescript option',
});
  • A few typed functions for what we use: askSelect, askInput, askConfirm, askSearch (autocomplete). They return the answer directly, so no casts.
  • One consistent behavior when there is no answer (Ctrl+C, closed stdin, no TTY): exit with code 1 and an error that names the CLI argument or option to use instead.
  • One place for library workarounds, like the beforeExit listener of https://github.com/meta/docusaurus/pull/13011.
  • Test helpers to answer the prompts, so tests don't depend on the library.
  • Swapping the library later only touches this package.

We can do it in two steps: introduce the abstraction on top of prompts (no behavior change for the answered case), then pick another library if we want to.

Library options

Numbers as of November 2026:

prompts (current) Inquirer (@inquirer/select + @inquirer/input) @clack/prompts enquirer
GitHub stars 9.3k 21.6k 8.1k 8.0k
npm downloads/week 90.9M 61.2M (@inquirer/prompts) 43.3M 48.0M
Latest release Oct 2021 Nov 2026 Nov 2026 Jul 2023
Releases in the last 12 months 0 25 13 0
Open issues 148 18 95 207
Installed packages 3 12 6 4
Max dependency depth 2 5 5 3
Closed stdin exits with code 0 rejects with ExitPromptError exits with code 0 exits with code 0
Autocomplete (swizzle) autocomplete @inquirer/search autocomplete autocomplete
Module format CJS ESM ESM CJS

Other possible solutions:

  • Keep prompts behind the abstraction, with our workarounds. It's tiny and stable, and the abstraction removes most of the risk of keeping it.
  • Node's built-in node:readline/promises: no dependency, but no select or autocomplete UI. The template and language choices would need a typed answer.
  • Our own minimal implementation of the 4 prompt types on top of node:readline: no dependency, but more code to maintain (keypresses, rendering, Windows terminals).
Inquirer, an option to consider

It's actively maintained, typed, and split into small packages. It is the only library above that rejects when stdin is closed. https://github.com/meta/docusaurus/pull/13017 is a draft migration of create-docusaurus, as a reference.

Tradeoffs:

  • Dependencies: 12 installed packages, 5 levels deep, from about 11 npm maintainer accounts, instead of 3 packages from 2 accounts. We should use the individual @inquirer/* packages, never the @inquirer/prompts bundle (25 packages, including iconv-lite for the editor prompt).
  • Closed stdin: Inquirer doesn't detect the end of stdin itself. It rejects from a signal-exit hook while the process exits, so it can't fall back to a default value at that point.
  • Ctrl+C: closed stdin and Ctrl+C throw the same ExitPromptError, so a prompt can't keep a default value on Ctrl+C only.
  • Testing: @inquirer/testing renders prompts in a headless terminal and works well, but it declares 16 optional peer dependencies, including vitest. In our monorepo, pnpm resolved them to a second copy of vite and vitest. Our own test helpers would avoid it.
  • Look: the prompts render slightly differently.

@clack/prompts has the nicest UI but the same closed-stdin problem, and in our test it didn't read piped answers. enquirer has the same problem and is no more maintained than prompts.

Open questions

  • A public package (like @docusaurus/logger), so third-party plugins can use it in their CLI extensions, or an internal module first?
  • Should we test the closed-stdin behavior end to end in CI, for example by running the CLIs with < /dev/null in tests-e2e.yml?

(AI-assisted)

Lenguaje dominante
TypeScript
Estrellas
66.6k
Forks
10.1k
Métricas de merge de PR
Sin PR fusionados en 30 d

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de facebook/docusaurus

Todos los issues de facebook/docusaurus

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.