feat: customize `supportedArchitectures` using CLI by KSXGitHub · Pull Request #9745 · pnpm/pnpm

KSXGitHub · 2025-07-11T06:44:04Z

Resolves #7510

KSXGitHub · 2025-07-11T06:45:51Z

config/config/src/index.ts

+  const supportedArchitecturesKeys = ['os', 'cpu', 'libc'] as const satisfies Array<keyof SupportedArchitectures>
+  for (const key of supportedArchitecturesKeys) {
+    const values = pnpmConfig[key]
+    if (values != null) {
+      pnpmConfig.supportedArchitectures ??= {}
+      pnpmConfig.supportedArchitectures[key] = [
+        ...pnpmConfig.supportedArchitectures[key] ?? [],
+        ...typeof values === 'string' ? [values] : values,
+      ]
+    }
+  }


@zkochan This block of code would merge CLI's supportedArchitectures with rootManifest.pnpm.supportedArchitectures. But I'm not sure if this is a desired behavior. If you want one to completely override the other, let me know.

Probably the CLI values should override the ones in the pnpmConfig.

.changeset/slick-steaks-admire.md

exec/plugin-commands-script-runners/src/dlx.ts

danielbayley · 2025-07-11T11:00:31Z

#7510 (comment)

If we are supporting the devEngines standard (which includes os and cpu—see #9742 and #9707), is it a good idea to duplicate even more config here? @KSXGitHub

zkochan · 2025-07-11T15:35:49Z

@danielbayley this PR is not adding any new settings.

KSXGitHub · 2025-07-11T20:30:04Z

.changeset/pink-cars-guess.md

+---
+"@pnpm/plugin-commands-installation": patch
+"pnpm": patch
+---
+
+Fix a bug in which `pnpm add` downloads packages whose `libc` differ from `pnpm.supportedArchitectures.libc`.


I didn't want to make this change in a separate PR because it would cause conflicts.

fetchFullMetadata from master did not include opts.supportedArchitectures?.libc in its calculation.

KSXGitHub · 2025-07-11T20:30:47Z

pkg-manager/plugin-commands-installation/src/getFetchFullMetadata.ts

+  opts.supportedArchitectures?.libc ??
+  opts.rootProjectManifest?.pnpm?.supportedArchitectures?.libc


Both lines are necessary. Removing any of them would cause test to fail.

pnpm/test/dlx.ts

zkochan · 2025-07-15T14:17:42Z

@danielbayley I don't think that the devEngines field can replace the supportedArchitectures field. The devEngines field just tells what os and cpu are supported by the project. But the supportedArchitecture tells pnpm which artifacts to download when installing optional dependencies. The purpose of these fields differs.

zkochan · 2025-07-15T14:21:50Z

config/config/src/index.ts

    }
  }
+
+  overrideSupportedArchitecturesWithCLI(pnpmConfig)


why are we adding these fields to config if they can only be passed as CLI args? Take the settings from cliOptions passed to getConfig.

danielbayley · 2025-07-15T14:36:54Z

@danielbayley I don't think that the devEngines field can replace the supportedArchitectures field. The devEngines field just tells what os and cpu are supported by the project. But the supportedArchitecture tells pnpm which artifacts to download when installing optional dependencies. The purpose of these fields differs.

Ok cool. I just like to reduce the amount of config as much as possible if we can… In that case a better name might have been preferredArchitecture or something, no?

zkochan · 2025-07-15T14:50:42Z

I think supportedArchitecture is fine. Yarn uses the same field name.

Copilot

Pull Request Overview

Adds command-line flags for customizing supportedArchitectures and propagates those flags through install, add, and dlx commands.

Introduce --cpu, --libc, and --os options to pnpm install, pnpm add, and pnpm dlx
Refactor createCacheKey and tests to include supportedArchitectures
Centralize fetchFullMetadata logic behind a helper and wire up CLI overrides in config

Reviewed Changes

Copilot reviewed 20 out of 21 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
store/plugin-commands-store/test/storePrune.ts	Updated `createCacheKey` call to new options signature
store/plugin-commands-store/src/cleanExpiredDlxCache.test.ts	Updated `createCacheKey` usage to new options structure
pnpm/test/install/supportedArchitectures.ts	Added tests for CLI- and manifest-driven `supportedArchitectures`
pnpm/test/dlx.ts	Updated `createCacheKey` calls and added supportedArchitectures tests
pnpm-workspace.yaml	Bumped `@pnpm/registry-mock` version
pkg-manager/plugin-commands-installation/test/install.ts	Renamed test suite and added `--libc` CLI behavior tests
pkg-manager/plugin-commands-installation/test/add.ts	Added `supportedArchitectures.libc` tests for `pnpm add`
pkg-manager/plugin-commands-installation/src/install.ts	Moved full-metadata logic into `getFetchFullMetadata` helper
pkg-manager/plugin-commands-installation/src/getFetchFullMetadata.ts	New helper for toggling full-metadata fetch based on libc
pkg-manager/plugin-commands-installation/src/add.ts	Integrated full-metadata helper into `add` handler
exec/plugin-commands-script-runners/test/dlx.e2e.ts	Updated `createCacheKey` usage to include supportedArchitectures
exec/plugin-commands-script-runners/test/dlx.createCacheKey.test.ts	Enhanced `createCacheKey` tests and added ordering checks
exec/plugin-commands-script-runners/src/dlx.ts	Extended dlx caching and handler logic to respect architectures
exec/plugin-commands-script-runners/package.json	Added `@pnpm/util.lex-comparator` dependency
config/config/test/overrideSupportedArchitecturesWithCLI.test.ts	Added tests for CLI overrides of `supportedArchitectures`
config/config/src/types.ts	Registered `cpu`, `libc`, and `os` in configuration types
config/config/src/overrideSupportedArchitecturesWithCLI.ts	Implemented override logic for CLI-supportedArchitectures
config/config/src/index.ts	Hooked CLI override into main `getConfig` flow
.changeset/slick-steaks-admire.md	New feature changeset
.changeset/pink-cars-guess.md	Bugfix changeset

Files not reviewed (1)

pnpm-lock.yaml: Language not supported

Comments suppressed due to low confidence (4)

config/config/src/overrideSupportedArchitecturesWithCLI.ts:13

The JSDoc for cliOptions is unclear–please clarify its purpose, e.g.: @param cliOptions - CLI flags for overriding supportedArchitectures.

 * @param cliOptions - The object that contains object

exec/plugin-commands-script-runners/test/dlx.createCacheKey.test.ts:42

This test covers os and cpu ordering but omits libc. Adding a scenario to verify that libc arrays are sorted and deduped would ensure full coverage of the new logic.

test('is agnostic to supportedArchitectures values order', () => {

pnpm/test/dlx.ts:311

[nitpick] The term NotInstalled differs from Skipped used elsewhere for skipped packages; consider unifying the name for consistency across tests.

  type NotInstalled = string[]

pkg-manager/plugin-commands-installation/src/getFetchFullMetadata.ts:10

[nitpick] Consider renaming getFetchFullMetadata to shouldFetchFullMetadata to better convey that it returns a boolean flag rather than fetching data directly.

export const getFetchFullMetadata = (opts: GetFetchFullMetadataOptions): true | undefined => (

Copilot · 2025-07-15T22:53:55Z

pkg-manager/plugin-commands-installation/src/getFetchFullMetadata.ts

+  opts.supportedArchitectures?.libc ??
+  opts.rootProjectManifest?.pnpm?.supportedArchitectures?.libc


Checking existence of libc alone can be truthy for empty arrays. You may want to guard on non-empty arrays (e.g. opts.supportedArchitectures?.libc?.length > 0) to avoid unnecessary full metadata fetches.

Suggested change

opts.supportedArchitectures?.libc ??

opts.rootProjectManifest?.pnpm?.supportedArchitectures?.libc

(opts.supportedArchitectures?.libc?.length > 0 ? opts.supportedArchitectures.libc : undefined) ??

(opts.rootProjectManifest?.pnpm?.supportedArchitectures?.libc?.length > 0 ? opts.rootProjectManifest.pnpm.supportedArchitectures.libc : undefined)

feat: customize supportedArchitectures using CLI

50f73b2

Resolves #7510

KSXGitHub commented Jul 11, 2025

View reviewed changes

.changeset/slick-steaks-admire.md Show resolved Hide resolved

KSXGitHub added 2 commits July 11, 2025 14:00

refactor: move everything to opts

37e5249

test: fix type

07d4bf7

zkochan reviewed Jul 11, 2025

View reviewed changes

exec/plugin-commands-script-runners/src/dlx.ts Show resolved Hide resolved

KSXGitHub added 2 commits July 11, 2025 16:36

test: fix

660f994

refactor: use @pnpm/util.lex-comparator

be7be9b

fix: fetchFullMetadata

8c3e177

KSXGitHub added 3 commits July 12, 2025 01:12

test: dlx (wip)

bf9f3f5

test: dlx

ea3afc6

fix(cli/add): libc filters

d5ddf1f

KSXGitHub commented Jul 11, 2025

View reviewed changes

pnpm/test/dlx.ts Outdated Show resolved Hide resolved

KSXGitHub commented Jul 11, 2025

View reviewed changes

pnpm/test/dlx.ts Show resolved Hide resolved

KSXGitHub added 12 commits July 12, 2025 06:00

test: fix windows

cd4db4e

feat: override instead of merge

e36c8c0

refactor: alphabetical

cbbaad6

docs: describe behavior

e8feecb

refactor: move overriding code to its own function

628e32b

fix: eslint

0090626

refactor: rename some types

43b1628

test: add unit test

717f462

style: add an empty line

919d16e

refactor: add a type annotation

22ab1eb

test: add and install

f4a3c88

fix: eslint

fc086d7

KSXGitHub marked this pull request as ready for review July 15, 2025 12:34

KSXGitHub requested a review from zkochan July 15, 2025 12:35

zkochan reviewed Jul 15, 2025

View reviewed changes

refactor: remove the fields from type Config

7ddd9b2

KSXGitHub requested a review from zkochan July 15, 2025 15:54

zkochan requested a review from Copilot July 15, 2025 22:52

Copilot AI reviewed Jul 15, 2025

View reviewed changes

zkochan approved these changes Jul 15, 2025

View reviewed changes

zkochan merged commit 6f7ac0f into main Jul 15, 2025
19 of 21 checks passed

zkochan deleted the cli-supported-architectures-7510 branch July 15, 2025 22:56

		opts.supportedArchitectures?.libc ??
		opts.rootProjectManifest?.pnpm?.supportedArchitectures?.libc

Uh oh!

Conversation

KSXGitHub commented Jul 11, 2025

Uh oh!

KSXGitHub Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

zkochan Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

KSXGitHub Jul 14, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

danielbayley commented Jul 11, 2025

Uh oh!

zkochan commented Jul 11, 2025

Uh oh!

KSXGitHub Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

KSXGitHub Jul 11, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

zkochan commented Jul 15, 2025

Uh oh!

zkochan Jul 15, 2025

Choose a reason for hiding this comment

Uh oh!

KSXGitHub Jul 15, 2025

Choose a reason for hiding this comment

Uh oh!

danielbayley commented Jul 15, 2025

Uh oh!

zkochan commented Jul 15, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 15, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants