feat(cli/config): get/set objects and property paths by KSXGitHub · Pull Request #9811 · pnpm/pnpm

KSXGitHub · 2025-07-29T19:08:57Z

Resolves #9797

KSXGitHub · 2025-07-29T19:10:22Z

config/plugin-commands-config/src/configGet.ts

-  return { output: Array.isArray(config) ? config.join(',') : String(config), exitCode: 0 }
+  let output: string
+  if (Array.isArray(config)) {
+    output = config.join(',')


This was on me: #7917. I don't remember why I decided to return a comma-separated list instead of a JSON string, but changing it now would be a breaking change.

KSXGitHub · 2025-07-29T19:16:39Z

I do feel that pnpm config get and pnpm config set are still incomplete. Especially now that pnpm has expand its config structure to more nested objects.

pnpm config get can get an object, but not the property of that object. Perhaps we could make pnpm config get packageExtensions react dependencies to access config.packageExtensions.react.dependencies? Or perhaps we should make pnpm config get ignores pnpm-workspace.yaml entirely?

zkochan · 2025-07-29T20:34:53Z

Yes, probably we should support that. But I think the field names should be separated by dots:

pnpm config get packageExtensions.react.dependencies

KSXGitHub · 2025-07-29T20:38:17Z

Yes, probably we should support that. But I think the field names should be separated by dots

jq does that. And looks good too. The problem is how are we suppose to escape dots in property name? Do we make another property path parser similar to jq? Is there an existing library for that?

KSXGitHub · 2025-07-29T20:39:20Z

And escaping is necessary because dependency names can contain all kinds of symbols: @, /, ., etc.

zkochan · 2025-07-29T21:33:29Z

See how Yarn also supports this: https://yarnpkg.com/cli/config/set

We can check what library Yarn uses. It should be something small.

KSXGitHub · 2025-08-08T20:02:48Z

Discovered flaws

Note

The following flaws can't be fixed without breaking changes.

pnpm config get _authToken would emit an error from npm, but pnpm config list shows it regardless.
~~pnpm config set <npm-setting> would write to ~/.npmrc despite local pnpm-workspace.yaml exists.~~
the global rc file (~/.config/pnpm/rc) can set workspace specific settings (such as packages).
pnpm config get <array> prints comma-separated list instead of INI.
pnpm config list would have kebab-case for top-level keys but camelCase for non-top-level keys.

This reverts commit 66add58.

zkochan

LGTM

object/property-path/package.json

JounQin · 2025-08-25T03:32:47Z

config/plugin-commands-config/src/configSet.ts

+export class ConfigSetDeepKeyError extends PnpmError {
+  constructor () {
+    // it shouldn't be supported until there is a mechanism to validate the config value
+    super('CONFIG_SET_DEEP_KEY', 'Setting deep property path is not supported')


This error breaks pnpm config set supportedArchitectures.cpu "${CPU_ARCH}", what's the replacement then?

https://github.com/oxc-project/oxc-resolver/actions/runs/17197957513/job/48783406788#step:3:67

It does not break. It only reveals a flawed assumption.

pnpm config set supportedArchitectures.cpu doesn't actually do what you think it does:

As you can see, it didn't actually create an object named supportedArchitectures with the content { "cpu": "x64" }. Instead, it added a field named supported-architectures-cpu to the global rc file.

what's the replacement then?

Write a small JS script that modifies package.json. This applies to older pnpm too (because it has never worked with older pnpm, it's just that they don't print error).

@KSXGitHub But config get works after config set previously.

Anyway, we want to modify the global pnpm config without changing the source files, it seems impossible now?

Personally, I think merging this PR without implementing setting correctly is incomplete and should be considered as BREAKING CHNAGE.

But config get works after config set previously.

pnpm config get supportedArchitectures.cpu is literally the same as pnpm config get supported-architectures-cpu (there's no object path, just a property name that makes no sense). You were already misusing it before, removing it has zero effect.

Anyway, we want to modify the global pnpm config without changing the source files, it seems impossible now?

pnpm has never read supportedArchitectures from rc files, be it local or global. The fact pnpm get makes it seems like your use-case has effect was just an illusion caused by ill-thought-out config implementation. But the loading code has always only loads fields that appear in types (which doesn't include supportedArchitectures):

pnpm/config/config/src/index.ts

Lines 238 to 240 in 6aaf938

const pnpmConfig: ConfigWithDeprecatedSettings = Object.fromEntries(

rcOptions.map((configKey) => [camelcase(configKey, { locale: 'en-US' }), npmConfig.get(configKey)])

) as ConfigWithDeprecatedSettings

In other words, it was always impossible, it's just that older pnpm versions silently ignored the error.

BREAKING CHNAGE

I certainly didn't think anybody would be mistakenly believing that pnpm supports property paths, but then I have insight from the code itself. Regardless though, I don't think it's a breaking change because it doesn't actually break legitimate use-cases, it only reveals a nonsense use-case that doesn't do anything.

You may believe that temporary downgrade pnpm would fix the problem, but it actually doesn't, because as I already explained: pnpm get/set supportedArchitectures.cpu doesn't do anything except reading/setting supported-architectures-cpu which has zero effect. It is the same as not doing anything at all. The only way to fix the problem is to replace the wrong pnpm config set with a script that modifies either package.json or pnpm-workspace.yaml.

BTW, I also made a suggestion to your PR.

feat: config get prints json for object

d99b8a9

Resolves #9797

KSXGitHub commented Jul 29, 2025

View reviewed changes

fix: eslint

d54b847

KSXGitHub force-pushed the pnpm-config-get-object-object-9797 branch 4 times, most recently from 3b1a9ef to e28f84f Compare August 3, 2025 20:04

This comment was marked as resolved.

Sign in to view

KSXGitHub force-pushed the pnpm-config-get-object-object-9797 branch 2 times, most recently from 8161463 to 0dc5e8d Compare August 4, 2025 15:45

feat: parse property path

aeef6df

KSXGitHub force-pushed the pnpm-config-get-object-object-9797 branch from 0dc5e8d to aeef6df Compare August 5, 2025 21:31

KSXGitHub added 12 commits August 6, 2025 16:08

refactor: extract output into a function

8411043

feat: get config by property path

65bca8c

docs: add future tasks

ba0d4c3

feat: print ini

a74c42b

refactor: remove unreachable code

1cef31b

fix: prevent error on null

81d3ea5

test: fix

d4042c1

fix: eslint

bc3f63c

test: config get <property-path>

7d32331

chore(git): merge from main

308ec01

feat: check for kebab-case

caca05a

refactor: create parseConfigPropertyPath

ab0cd81

feat: throw parsing error

5f0ecc3

KSXGitHub added 2 commits August 9, 2025 03:54

feat: set config by property path (wip)

66add58

fix: eslint

70a324f

KSXGitHub changed the title ~~feat: config get prints json for object~~ feat(cli/config): get/set objects and property paths Aug 11, 2025

KSXGitHub added 11 commits August 13, 2025 03:00

chore(git): temporary revert

827b3ce

This reverts commit 66add58.

feat(cli/config/set): forbid property path

1329867

chore(git): merge from main

0d06df1

fix: ConfigSetKeyEmptyKeyError.code

afadfe1

test: configSet

4816919

feat(cli/config/set): --json

066778b

chore(git): merge from main

546fe15

feat: property path fallback to npm

b7bca36

feat: --json fallback to npm

22077ca

docs(changeset): correct

f75d8a5

docs(changeset): other features

f7b6739

KSXGitHub marked this pull request as ready for review August 13, 2025 21:20

KSXGitHub requested a review from zkochan as a code owner August 13, 2025 21:20

zkochan reviewed Aug 13, 2025

View reviewed changes

object/property-path/package.json Outdated Show resolved Hide resolved

chore: fix version

ac51e91

KSXGitHub requested a review from zkochan August 14, 2025 00:02

zkochan approved these changes Aug 14, 2025

View reviewed changes

zkochan merged commit b84c71d into main Aug 14, 2025
19 of 21 checks passed

zkochan deleted the pnpm-config-get-object-object-9797 branch August 14, 2025 08:28

JounQin mentioned this pull request Aug 25, 2025

ERR_PNPM_CONFIG_SET_DEEP_KEY Setting deep property path is not supported oxc-project/oxc-resolver#668

Closed

JounQin reviewed Aug 25, 2025

View reviewed changes

JounQin mentioned this pull request Aug 26, 2025

ci: downgrade pnpm temporarily oxc-project/oxc-resolver#672

Closed

zkochan mentioned this pull request Sep 23, 2025

pnpm config set for array and object values #10015

Open

1 task

	const pnpmConfig: ConfigWithDeprecatedSettings = Object.fromEntries(
	rcOptions.map((configKey) => [camelcase(configKey, { locale: 'en-US' }), npmConfig.get(configKey)])
	) as ConfigWithDeprecatedSettings

Uh oh!

Conversation

KSXGitHub commented Jul 29, 2025

Uh oh!

KSXGitHub Jul 29, 2025

Choose a reason for hiding this comment

Uh oh!

KSXGitHub commented Jul 29, 2025

Uh oh!

zkochan commented Jul 29, 2025

Uh oh!

KSXGitHub commented Jul 29, 2025

Uh oh!

KSXGitHub commented Jul 29, 2025

Uh oh!

zkochan commented Jul 29, 2025

Uh oh!

This comment was marked as resolved.

This comment was marked as resolved.

KSXGitHub commented Aug 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Discovered flaws

Uh oh!

zkochan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

JounQin Aug 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

KSXGitHub Aug 25, 2025

Choose a reason for hiding this comment

Uh oh!

JounQin Aug 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

KSXGitHub Aug 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

KSXGitHub Aug 26, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

KSXGitHub commented Aug 8, 2025 •

edited

Loading

JounQin Aug 25, 2025 •

edited

Loading

JounQin Aug 26, 2025 •

edited

Loading

KSXGitHub Aug 26, 2025 •

edited

Loading