@pnpm/config.commands 1100.0.36 → 1100.1.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @pnpm/plugin-commands-config
 
+## 1100.1.0
+
+### Minor Changes
+
+- `pnpm config set` refuses to write a setting to a project's `pnpm-workspace.yaml` that pnpm does not read from there, rather than leaving a key in the file that does nothing. Those settings are `configDir`, `pnpmHomeDir`, `stateDir` and the others that name machine-level state. The command fails with `ERR_PNPM_CONFIG_SET_NOT_A_PROJECT_SETTING`, naming where the setting does belong when it belongs somewhere. `pnpm config delete` still clears one that a file already carries, in whichever spelling it uses [#13629](https://github.com/pnpm/pnpm/issues/13629).
+
+### Patch Changes
+
+- Updated dependencies:
+  - @pnpm/cli.utils@1101.0.23
+  - @pnpm/config.reader@1101.17.0
+  - @pnpm/error@1100.1.2
+  - @pnpm/object.property-path@1100.1.4
+  - @pnpm/workspace.workspace-manifest-writer@1100.1.0
+
+## 1100.0.37
+
+### Patch Changes
+
+- Updated dependencies:
+  - @pnpm/config.reader@1101.16.1
+
 ## 1100.0.36
 
 ### Patch Changes

package/lib/configSet.d.ts

@@ -15,6 +15,10 @@ export declare class ConfigSetUnsupportedWorkspaceKeyError extends PnpmError {
     readonly key: string;
     constructor(key: string);
 }
+export declare class ConfigSetNotAProjectSettingError extends PnpmError {
+    readonly key: string;
+    constructor(key: string);
+}
 export declare class ConfigSetUnsupportedYamlConfigKeyError extends PnpmError {
     readonly key: string;
     constructor(key: string);

package/lib/configSet.js

@@ -1,6 +1,6 @@
 import path from 'node:path';
 import util from 'node:util';
-import { isConfigFileKey, isIniConfigKey, types } from '@pnpm/config.reader';
+import { isConfigFileKey, isIniConfigKey, isProjectManifestSkippedKey, types, whereRefusedKeyBelongs } from '@pnpm/config.reader';
 import { GLOBAL_CONFIG_YAML_FILENAME, WORKSPACE_MANIFEST_FILENAME } from '@pnpm/constants';
 import { PnpmError } from '@pnpm/error';
 import { parsePropertyPath } from '@pnpm/object.property-path';
@@ -45,16 +45,28 @@ export async function configSet(opts, key, valueParam) {
     switch (configFileName) {
         case GLOBAL_CONFIG_YAML_FILENAME:
         case WORKSPACE_MANIFEST_FILENAME: {
-            if (configFileName === GLOBAL_CONFIG_YAML_FILENAME) {
+            // `pnpm config set <key> null` casts to a removal too.
+            const castValue = castField(value, kebabCase(key));
+            const isRemoval = castValue == null;
+            // Validation stops a write landing in a file that will not read it back.
+            // Nothing reads back a key being deleted, so a removal skips both checks.
+            if (configFileName === GLOBAL_CONFIG_YAML_FILENAME && !isRemoval) {
                 key = validateYamlConfigKey(key);
             }
-            key = validateWorkspaceKey(key);
-            await updateWorkspaceManifest(configDir, {
-                fileName: configFileName,
-                updatedFields: ({
-                    [key]: castField(value, kebabCase(key)),
-                }),
-            });
+            const writtenKey = isRemoval ? camelCase(key) : validateWorkspaceKey(key);
+            if (castValue != null && configFileName === WORKSPACE_MANIFEST_FILENAME && isProjectManifestSkippedKey(writtenKey)) {
+                throw new ConfigSetNotAProjectSettingError(writtenKey);
+            }
+            const updatedFields = {
+                [writtenKey]: castValue,
+            };
+            // A hand-edited file may carry a spelling pnpm did not write, and that
+            // is the one the reader's warning names, so a removal clears them all.
+            if (isRemoval) {
+                updatedFields[key] = null;
+                updatedFields[kebabCase(writtenKey)] = null;
+            }
+            await updateWorkspaceManifest(configDir, { fileName: configFileName, updatedFields });
             break;
         }
         case 'auth.ini':
@@ -169,6 +181,22 @@ export class ConfigSetUnsupportedWorkspaceKeyError extends PnpmError {
         this.key = key;
     }
 }
+/** The suggestion for {@link key}, which falls back when the key is allowed in a project manifest. */
+function hintForRefusedKey(key, fallback) {
+    const camelKey = camelCase(key);
+    if (!isProjectManifestSkippedKey(camelKey))
+        return fallback;
+    return whereRefusedKeyBelongs(camelKey);
+}
+export class ConfigSetNotAProjectSettingError extends PnpmError {
+    key;
+    constructor(key) {
+        super('CONFIG_SET_NOT_A_PROJECT_SETTING', `The key ${JSON.stringify(key)} cannot be set in a project's pnpm-workspace.yaml`, {
+            hint: whereRefusedKeyBelongs(key),
+        });
+        this.key = key;
+    }
+}
 /**
  * Only an rc option key would be allowed to be kebab-case, otherwise, it must be camelCase.
  *
@@ -177,6 +205,8 @@ export class ConfigSetUnsupportedWorkspaceKeyError extends PnpmError {
 function validateWorkspaceKey(key) {
     if (Object.hasOwn(types, key) || isConfigFileKey(key))
         return camelCase(key);
+    if (isProjectManifestSkippedKey(camelCase(key)))
+        return camelCase(key);
     if (!isCamelCase(key))
         throw new ConfigSetUnsupportedWorkspaceKeyError(key);
     return key;
@@ -205,7 +235,7 @@ export class ConfigSetUnsupportedYamlConfigKeyError extends PnpmError {
     key;
     constructor(key) {
         super('CONFIG_SET_UNSUPPORTED_YAML_CONFIG_KEY', `The key ${JSON.stringify(key)} isn't supported by the global config.yaml file`, {
-            hint: 'Try setting them instead to the local pnpm-workspace.yaml file',
+            hint: hintForRefusedKey(key, 'Try setting them instead to the local pnpm-workspace.yaml file'),
         });
         this.key = key;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnpm/config.commands",
-  "version": "1100.0.36",
+  "version": "1100.1.0",
   "description": "Commands for reading and writing settings to/from config files",
   "keywords": [
     "pnpm",
@@ -28,14 +28,14 @@
     "!*.map"
   ],
   "dependencies": {
-    "@pnpm/cli.utils": "1101.0.22",
-    "@pnpm/config.reader": "1101.16.0",
+    "@pnpm/cli.utils": "1101.0.23",
+    "@pnpm/config.reader": "1101.17.0",
     "@pnpm/constants": "1101.0.0",
-    "@pnpm/error": "1100.1.1",
+    "@pnpm/error": "1100.1.2",
     "@pnpm/object.key-sorting": "1100.0.2",
-    "@pnpm/object.property-path": "1100.1.3",
+    "@pnpm/object.property-path": "1100.1.4",
     "@pnpm/text.naming-cases": "1100.0.2",
-    "@pnpm/workspace.workspace-manifest-writer": "1100.0.21",
+    "@pnpm/workspace.workspace-manifest-writer": "1100.1.0",
     "camelcase": "^9.0.0",
     "ini": "6.0.0",
     "lodash.kebabcase": "^4.1.1",
@@ -49,9 +49,9 @@
   },
   "devDependencies": {
     "@jest/globals": "30.4.1",
-    "@pnpm/config.commands": "1100.0.36",
+    "@pnpm/config.commands": "1100.1.0",
     "@pnpm/logger": "1100.0.0",
-    "@pnpm/prepare": "1100.0.25",
+    "@pnpm/prepare": "1100.0.26",
     "@types/ini": "4.1.1",
     "@types/lodash.kebabcase": "4.1.9",
     "read-yaml-file": "^3.0.0"