chore: remove yargs override in root package.json once all sub-packages are updated

Abierto
#9,130 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
45/100
Tipo de issue
Refactorización
Claridad
Bastante claro
Estado de actividad
Tranquilo
Stack tecnológico
nodejs, typescript

Línea de trabajo

Comienza con el package.json raíz e inspecciona las declaraciones de paquetes del repositorio en busca de dependencias de versiones antiguas de yargs. Actualiza los subpaquetes o herramientas afectados y, después, elimina la entrada de yargs de pnpm.overrides. Confirma que la instalación y las ejecuciones de pruebas de CI en Node.js 24+ se completen sin los fallos de compatibilidad descritos en el issue.

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

Descripción

Background

In Node.js >= 24, certain older versions of yargs (used transitively across packages in the monorepo) cause runtime failures related to ES module scope and require resolution. To temporarily prevent ESM-scope/require-compat crashes in Node 24+ environments during CI test runs and installations, we introduced a hook in .pnpmfile.cjs (via #8460) that dynamically mutates any direct or indirect dependency on yargs to version 18.0.0 when the Node.js version is >= 24.

Why this was needed
  • Some of our older package dependencies/tools pulled in outdated versions of yargs (such as yargs@16 or yargs@17).
  • Node.js >= 24 implements stricter constraints and changed behaviors regarding ESM resolution and require(esm) integration, triggering loader/scope compatibility failures with these older yargs releases.
  • Setting a global pnpm-file override was a safe, non-intrusive stopgap to stabilize the CI pipeline on newer Node.js versions without requiring a simultaneous, repo-wide upgrade of all individual packages.
Impact of the PNPM Workspace PR (https://github.com/googleapis/google-cloud-node/pull/8973)

In our upcoming transition to a PNPM workspace (currently in progress in PR #8973):

  • The programmatic .pnpmfile.cjs is deleted entirely.
  • Instead of using a custom JS script to mutate dependencies during installation, the monorepo leverages PNPM's native, declarative overrides feature in the root package.json ("pnpm": { "overrides": { "yargs": "^17.7.2" } }).
  • This means that once the PNPM workspace PR is merged, the code reviewer's commented line in .pnpmfile.cjs will be automatically cleaned up.
  • However, the global override mechanism itself will still exist in the root package.json "pnpm.overrides" field.
When & How to Fix

To completely remove the global override from the root package.json:

  1. Identify all packages/tools in the repository that still depend on versions of yargs older than 17.7.2 / 18.0.0.
  2. Upgrade yargs to a consistent, modern version (e.g. ^18.0.0 or newer) across all sub-projects and tools.
  3. Remove the "yargs" entry from "pnpm.overrides" in the root package.json.
Lenguaje dominante
TypeScript
Estrellas
3.2k
Forks
732
Merge medio
2 d 11 h
PR fusionados (30 d)
99

Preparar el entorno

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 googleapis/google-cloud-node

Todos los issues de googleapis/google-cloud-node

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.