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

Ouverte
#9,130 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
45/100
Type d'issue
Refactorisation
Clarté
Plutôt claire
Activité
Calme
Stack technique
nodejs, typescript

Piste de recherche

Commencez par le package.json racine et inspectez les déclarations de paquets du dépôt afin d’identifier les dépendances sur d’anciennes versions de yargs. Mettez à jour les sous-paquets ou outils concernés, puis supprimez l’entrée yargs de pnpm.overrides. Vérifiez que l’installation et les exécutions des tests CI sur Node.js 24+ se terminent sans les échecs de compatibilité décrits dans l’issue.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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.
Langage dominant
TypeScript
Étoiles
3.2k
Forks
732
Merge moyen
2 j 11 h
PR mergées (30 j)
99

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de googleapis/google-cloud-node

Toutes les issues de googleapis/google-cloud-node

Issues similaires

Plus d'issues TypeScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.