@pnpm/pkg-manifest.commands 1100.1.0

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-2016 Rico Sta. Cruz and other contributors
+Copyright (c) 2016-2026 Zoltan Kochan and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export * as pkg from './pkg.js';
+export * as setScript from './setScript.js';

package/lib/index.js

@@ -0,0 +1,3 @@
+export * as pkg from './pkg.js';
+export * as setScript from './setScript.js';
+//# sourceMappingURL=index.js.map

package/lib/pkg.d.ts

@@ -0,0 +1,18 @@
+export declare const rcOptionsTypes: typeof cliOptionsTypes;
+export declare function cliOptionsTypes(): Record<string, unknown>;
+export declare const commandNames: string[];
+interface PkgCommandOptions {
+    dir: string;
+    json?: boolean;
+    recursive?: boolean;
+    workspaceDir?: string;
+    selectedProjectsGraph?: Record<string, {
+        package: {
+            rootDir: string;
+            manifest: Record<string, unknown>;
+        };
+    }>;
+}
+export declare function handler(opts: PkgCommandOptions, params: string[]): Promise<string | void>;
+export declare function help(): string;
+export {};

package/lib/pkg.js

@@ -0,0 +1,205 @@
+import path from 'node:path';
+import { docsUrl, readProjectManifest, readProjectManifestOnly } from '@pnpm/cli.utils';
+import { types as allTypes } from '@pnpm/config.reader';
+import { PnpmError } from '@pnpm/error';
+import { deleteObjectValueByPropertyPathString, getObjectValueByPropertyPathString, setObjectValueByPropertyPathString, } from '@pnpm/object.property-path';
+import { renderHelp } from 'render-help';
+export const rcOptionsTypes = cliOptionsTypes;
+export function cliOptionsTypes() {
+    const types = allTypes;
+    return {
+        dir: types['dir'],
+        json: Boolean,
+        recursive: Boolean,
+    };
+}
+export const commandNames = ['pkg'];
+export async function handler(opts, params) {
+    if (params.length === 0) {
+        throw new PnpmError('PKG_MISSING_SUBCOMMAND', 'Missing subcommand', {
+            hint: help(),
+        });
+    }
+    if (params[0] === '--help' || params[0] === '-h') {
+        return help();
+    }
+    const [subcmd, ...args] = params;
+    if (opts.recursive) {
+        return handleRecursiveCommand(opts, subcmd, args);
+    }
+    return runSubcommand(opts, subcmd, args);
+}
+async function runSubcommand(opts, subcmd, args) {
+    switch (subcmd) {
+        case 'get':
+            return pkgGet(opts, args);
+        case 'set':
+            return pkgSet(opts, args);
+        case 'delete':
+            return pkgDelete(opts, args);
+        case 'fix':
+            return pkgFix(opts);
+        default:
+            throw new PnpmError('PKG_UNKNOWN_SUBCOMMAND', `Unknown subcommand "${subcmd}"`, {
+                hint: help(),
+            });
+    }
+}
+async function handleRecursiveCommand(opts, subcmd, args) {
+    const workspaceDir = opts.workspaceDir;
+    if (!workspaceDir) {
+        throw new PnpmError('PKG_RECURSIVE_NO_ROOT', 'Cannot run recursively outside of a workspace');
+    }
+    const selectedProjects = opts.selectedProjectsGraph == null
+        ? []
+        : Object.values(opts.selectedProjectsGraph);
+    if (selectedProjects.length === 0) {
+        throw new PnpmError('PKG_RECURSIVE_NO_PACKAGES', 'No workspace packages were selected');
+    }
+    if (subcmd === 'get') {
+        const entries = await Promise.all(selectedProjects.map(async ({ package: pkg }) => {
+            const manifest = await readProjectManifestOnly(pkg.rootDir);
+            const pkgName = String(manifest.name ?? path.relative(workspaceDir, pkg.rootDir));
+            return [pkgName, selectFromManifest(manifest, args)];
+        }));
+        return JSON.stringify(Object.fromEntries(entries), undefined, 2);
+    }
+    await Promise.all(selectedProjects.map(({ package: pkg }) => runSubcommand({ ...opts, dir: pkg.rootDir }, subcmd, args)));
+}
+async function pkgGet(opts, args) {
+    const manifest = await readProjectManifestOnly(opts.dir);
+    if (args.length === 1) {
+        const value = getObjectValueByPropertyPathString(manifest, args[0]);
+        if (value === undefined)
+            return '';
+        if (opts.json)
+            return JSON.stringify(value, undefined, 2);
+        return typeof value === 'string' ? value : JSON.stringify(value, undefined, 2);
+    }
+    return JSON.stringify(selectFromManifest(manifest, args), undefined, 2);
+}
+function selectFromManifest(manifest, args) {
+    if (args.length === 0)
+        return manifest;
+    const result = {};
+    for (const key of args) {
+        result[key] = getObjectValueByPropertyPathString(manifest, key);
+    }
+    return result;
+}
+async function pkgSet(opts, args) {
+    if (args.length === 0) {
+        throw new PnpmError('PKG_SET_MISSING_ARGS', 'Missing key=value pairs', {
+            hint: help(),
+        });
+    }
+    const { manifest, writeProjectManifest } = await readProjectManifest(opts.dir);
+    for (const arg of args) {
+        const eqIndex = arg.indexOf('=');
+        if (eqIndex === -1) {
+            throw new PnpmError('PKG_SET_INVALID_ARG', `Invalid argument "${arg}". Expected key=value format`, {
+                hint: 'Example: pnpm pkg set name=my-package',
+            });
+        }
+        const key = arg.slice(0, eqIndex);
+        let value = arg.slice(eqIndex + 1);
+        if (opts.json) {
+            try {
+                value = JSON.parse(value);
+            }
+            catch {
+                throw new PnpmError('PKG_SET_JSON_PARSE', `Failed to parse value as JSON: "${value}"`);
+            }
+        }
+        setObjectValueByPropertyPathString(manifest, key, value);
+    }
+    await writeProjectManifest(manifest);
+}
+async function pkgDelete(opts, args) {
+    if (args.length === 0) {
+        throw new PnpmError('PKG_DELETE_MISSING_ARGS', 'Missing keys to delete', {
+            hint: help(),
+        });
+    }
+    const { manifest, writeProjectManifest } = await readProjectManifest(opts.dir);
+    for (const key of args) {
+        deleteObjectValueByPropertyPathString(manifest, key);
+    }
+    await writeProjectManifest(manifest);
+}
+async function pkgFix(opts) {
+    const { manifest, writeProjectManifest } = await readProjectManifest(opts.dir);
+    const m = manifest;
+    if ('name' in m && typeof m.name !== 'string') {
+        delete m.name;
+    }
+    if ('version' in m && typeof m.version !== 'string') {
+        delete m.version;
+    }
+    for (const field of ['dependencies', 'devDependencies', 'optionalDependencies', 'peerDependencies', 'scripts']) {
+        if (field in m && !isPlainObject(m[field])) {
+            delete m[field];
+        }
+    }
+    if ('bin' in m && typeof m.bin !== 'string' && !isPlainObject(m.bin)) {
+        delete m.bin;
+    }
+    await writeProjectManifest(manifest);
+}
+function isPlainObject(value) {
+    return typeof value === 'object' && value !== null && !Array.isArray(value);
+}
+export function help() {
+    return renderHelp({
+        description: 'Manages your package.json',
+        descriptionLists: [
+            {
+                title: 'Commands',
+                list: [
+                    {
+                        description: 'Retrieves a value from package.json',
+                        name: 'get [<key> [<key> ...]]',
+                    },
+                    {
+                        description: 'Sets a value in package.json',
+                        name: 'set <key>=<value> [<key>=<value> ...]',
+                    },
+                    {
+                        description: 'Deletes a key from package.json',
+                        name: 'delete <key> [<key> ...]',
+                    },
+                    {
+                        description: 'Auto corrects common errors in package.json',
+                        name: 'fix',
+                    },
+                ],
+            },
+            {
+                title: 'Options',
+                list: [
+                    {
+                        description: 'When setting, parse the value as JSON. When getting a single key, return its JSON-encoded form instead of the raw value',
+                        name: '--json',
+                    },
+                    {
+                        description: 'Run on every workspace project or every project selected by a filter',
+                        name: '--recursive',
+                        shortAlias: '-r',
+                    },
+                ],
+            },
+        ],
+        url: docsUrl('pkg'),
+        usages: [
+            'pnpm pkg get [<key> [<key> ...]]',
+            'pnpm pkg set <key>=<value> [<key>=<value> ...]',
+            'pnpm pkg delete <key> [<key> ...]',
+            'pnpm pkg fix',
+            'pnpm pkg set <key>=<value> --json',
+            'pnpm -r pkg get name',
+            'pnpm --filter <selector> pkg get name',
+            'pnpm -r pkg set version=1.0.0',
+        ],
+    });
+}
+//# sourceMappingURL=pkg.js.map

package/lib/setScript.d.ts

@@ -0,0 +1,7 @@
+export declare const rcOptionsTypes: typeof cliOptionsTypes;
+export declare function cliOptionsTypes(): Record<string, unknown>;
+export declare const commandNames: string[];
+export declare function handler(opts: {
+    dir: string;
+}, params: string[]): Promise<void>;
+export declare function help(): string;

package/lib/setScript.js

@@ -0,0 +1,31 @@
+import { docsUrl, readProjectManifest } from '@pnpm/cli.utils';
+import { types as allTypes } from '@pnpm/config.reader';
+import { PnpmError } from '@pnpm/error';
+import { setObjectValueByPropertyPath } from '@pnpm/object.property-path';
+import { renderHelp } from 'render-help';
+export const rcOptionsTypes = cliOptionsTypes;
+export function cliOptionsTypes() {
+    const types = allTypes;
+    return { dir: types['dir'] };
+}
+export const commandNames = ['set-script', 'ss'];
+export async function handler(opts, params) {
+    if (params.length < 2) {
+        throw new PnpmError('SET_SCRIPT_MISSING_ARGS', 'Missing script name or command', {
+            hint: help(),
+        });
+    }
+    const [name, ...commandParts] = params;
+    const command = commandParts.join(' ');
+    const { manifest, writeProjectManifest } = await readProjectManifest(opts.dir);
+    setObjectValueByPropertyPath(manifest, ['scripts', name], command);
+    await writeProjectManifest(manifest);
+}
+export function help() {
+    return renderHelp({
+        description: 'Set a script in package.json',
+        usages: ['pnpm set-script <name> <command>'],
+        url: docsUrl('set-script'),
+    });
+}
+//# sourceMappingURL=setScript.js.map

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@pnpm/pkg-manifest.commands",
+  "version": "1100.1.0",
+  "description": "Commands for managing package.json",
+  "keywords": [
+    "pnpm",
+    "pnpm11",
+    "pkg"
+  ],
+  "license": "MIT",
+  "funding": "https://opencollective.com/pnpm",
+  "repository": "https://github.com/pnpm/pnpm/tree/main/pkg-manifest/commands",
+  "homepage": "https://github.com/pnpm/pnpm/tree/main/pkg-manifest/commands#readme",
+  "bugs": {
+    "url": "https://github.com/pnpm/pnpm/issues"
+  },
+  "type": "module",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "exports": {
+    ".": "./lib/index.js"
+  },
+  "files": [
+    "lib",
+    "!*.map"
+  ],
+  "dependencies": {
+    "render-help": "^2.0.0",
+    "@pnpm/error": "1100.0.0",
+    "@pnpm/cli.utils": "1101.0.7",
+    "@pnpm/config.reader": "1101.4.0",
+    "@pnpm/object.property-path": "1100.1.0",
+    "@pnpm/types": "1101.1.1"
+  },
+  "devDependencies": {
+    "@jest/globals": "30.3.0",
+    "@pnpm/pkg-manifest.commands": "1100.1.0",
+    "@pnpm/prepare": "1100.0.10"
+  },
+  "engines": {
+    "node": ">=22.13"
+  },
+  "jest": {
+    "preset": "@pnpm/jest-config"
+  },
+  "scripts": {
+    "compile": "tsgo --build && pn lint --fix",
+    "lint": "eslint \"src/**/*.ts\" \"test/**/*.ts\"",
+    "test": "pn compile && pn .test",
+    ".test": "cross-env NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules --disable-warning=ExperimentalWarning --disable-warning=DEP0169\" jest"
+  }
+}