@pnpm/cli.utils 1001.2.8

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/README.md

@@ -0,0 +1,15 @@
+# @pnpm/cli-utils
+
+> Utils for pnpm commands
+
+[![npm version](https://img.shields.io/npm/v/@pnpm/cli-utils.svg)](https://www.npmjs.com/package/@pnpm/cli-utils)
+
+## Installation
+
+```sh
+pnpm add @pnpm/cli-utils
+```
+
+## License
+
+MIT

package/lib/index.d.ts

@@ -0,0 +1,6 @@
+export * from './packageIsInstallable.js';
+export * from './readDepNameCompletions.js';
+export * from './readProjectManifest.js';
+export * from './recursiveSummary.js';
+export * from './style.js';
+export declare function docsUrl(cmd: string): string;

package/lib/index.js

@@ -0,0 +1,11 @@
+import { packageManager } from '@pnpm/cli.meta';
+export * from './packageIsInstallable.js';
+export * from './readDepNameCompletions.js';
+export * from './readProjectManifest.js';
+export * from './recursiveSummary.js';
+export * from './style.js';
+export function docsUrl(cmd) {
+    const [pnpmMajorVersion] = packageManager.version.split('.');
+    return `https://pnpm.io/${pnpmMajorVersion}.x/cli/${cmd}`;
+}
+//# sourceMappingURL=index.js.map

package/lib/packageIsInstallable.d.ts

@@ -0,0 +1,15 @@
+import { type WantedEngine } from '@pnpm/config.package-is-installable';
+import type { SupportedArchitectures } from '@pnpm/types';
+export declare function packageIsInstallable(pkgPath: string, pkg: {
+    packageManager?: string;
+    engines?: WantedEngine;
+    cpu?: string[];
+    os?: string[];
+    libc?: string[];
+}, opts: {
+    packageManagerStrict?: boolean;
+    packageManagerStrictVersion?: boolean;
+    engineStrict?: boolean;
+    nodeVersion?: string;
+    supportedArchitectures?: SupportedArchitectures;
+}): void;

package/lib/packageIsInstallable.js

@@ -0,0 +1,27 @@
+import { packageManager } from '@pnpm/cli.meta';
+import { checkPackage, UnsupportedEngineError } from '@pnpm/config.package-is-installable';
+import { logger } from '@pnpm/logger';
+export function packageIsInstallable(pkgPath, pkg, opts) {
+    const currentPnpmVersion = packageManager.name === 'pnpm'
+        ? packageManager.version
+        : undefined;
+    const err = checkPackage(pkgPath, pkg, {
+        nodeVersion: opts.nodeVersion,
+        pnpmVersion: currentPnpmVersion,
+        supportedArchitectures: opts.supportedArchitectures ?? {
+            os: ['current'],
+            cpu: ['current'],
+            libc: ['current'],
+        },
+    });
+    if (err === null)
+        return;
+    if ((err instanceof UnsupportedEngineError && err.wanted.pnpm) ??
+        opts.engineStrict)
+        throw err;
+    logger.warn({
+        message: `Unsupported ${err instanceof UnsupportedEngineError ? 'engine' : 'platform'}: wanted: ${JSON.stringify(err.wanted)} (current: ${JSON.stringify(err.current)})`,
+        prefix: pkgPath,
+    });
+}
+//# sourceMappingURL=packageIsInstallable.js.map

package/lib/readDepNameCompletions.d.ts

@@ -0,0 +1,3 @@
+export declare function readDepNameCompletions(dir?: string): Promise<Array<{
+    name: string;
+}>>;

package/lib/readDepNameCompletions.js

@@ -0,0 +1,7 @@
+import { getAllDependenciesFromManifest } from '@pnpm/pkg-manifest.utils';
+import { readProjectManifest } from '@pnpm/workspace.project-manifest-reader';
+export async function readDepNameCompletions(dir) {
+    const { manifest } = await readProjectManifest(dir ?? process.cwd());
+    return Object.keys(getAllDependenciesFromManifest(manifest)).map((name) => ({ name }));
+}
+//# sourceMappingURL=readDepNameCompletions.js.map

package/lib/readProjectManifest.d.ts

@@ -0,0 +1,22 @@
+import type { ProjectManifest, SupportedArchitectures } from '@pnpm/types';
+export interface ReadProjectManifestOpts {
+    engineStrict?: boolean;
+    packageManagerStrict?: boolean;
+    packageManagerStrictVersion?: boolean;
+    nodeVersion?: string;
+    supportedArchitectures?: SupportedArchitectures;
+}
+interface BaseReadProjectManifestResult {
+    fileName: string;
+    writeProjectManifest: (manifest: ProjectManifest, force?: boolean) => Promise<void>;
+}
+export interface ReadProjectManifestResult extends BaseReadProjectManifestResult {
+    manifest: ProjectManifest;
+}
+export declare function readProjectManifest(projectDir: string, opts?: ReadProjectManifestOpts): Promise<ReadProjectManifestResult>;
+export declare function readProjectManifestOnly(projectDir: string, opts?: ReadProjectManifestOpts): Promise<ProjectManifest>;
+export interface TryReadProjectManifestResult extends BaseReadProjectManifestResult {
+    manifest: ProjectManifest | null;
+}
+export declare function tryReadProjectManifest(projectDir: string, opts: ReadProjectManifestOpts): Promise<TryReadProjectManifestResult>;
+export {};

package/lib/readProjectManifest.js

@@ -0,0 +1,20 @@
+import * as utils from '@pnpm/workspace.project-manifest-reader';
+import { packageIsInstallable } from './packageIsInstallable.js';
+export async function readProjectManifest(projectDir, opts = {}) {
+    const { fileName, manifest, writeProjectManifest } = await utils.readProjectManifest(projectDir);
+    packageIsInstallable(projectDir, manifest, opts); // eslint-disable-line @typescript-eslint/no-explicit-any
+    return { fileName, manifest, writeProjectManifest };
+}
+export async function readProjectManifestOnly(projectDir, opts = {}) {
+    const manifest = await utils.readProjectManifestOnly(projectDir);
+    packageIsInstallable(projectDir, manifest, opts); // eslint-disable-line @typescript-eslint/no-explicit-any
+    return manifest;
+}
+export async function tryReadProjectManifest(projectDir, opts) {
+    const { fileName, manifest, writeProjectManifest } = await utils.tryReadProjectManifest(projectDir);
+    if (manifest == null)
+        return { fileName, manifest, writeProjectManifest };
+    packageIsInstallable(projectDir, manifest, opts); // eslint-disable-line @typescript-eslint/no-explicit-any
+    return { fileName, manifest, writeProjectManifest };
+}
+//# sourceMappingURL=readProjectManifest.js.map

package/lib/recursiveSummary.d.ts

@@ -0,0 +1,13 @@
+interface ActionFailure {
+    status: 'failure';
+    duration?: number;
+    prefix: string;
+    message: string;
+    error: Error;
+}
+export type RecursiveSummary = Record<string, {
+    status: 'passed' | 'queued' | 'running' | 'skipped';
+    duration?: number;
+} | ActionFailure>;
+export declare function throwOnCommandFail(command: string, recursiveSummary: RecursiveSummary): void;
+export {};

package/lib/recursiveSummary.js

@@ -0,0 +1,17 @@
+import { PnpmError } from '@pnpm/error';
+class RecursiveFailError extends PnpmError {
+    failures;
+    passes;
+    constructor(command, recursiveSummary, failures) {
+        super('RECURSIVE_FAIL', `"${command}" failed in ${failures.length} packages`);
+        this.failures = failures;
+        this.passes = Object.values(recursiveSummary).filter(({ status }) => status === 'passed').length;
+    }
+}
+export function throwOnCommandFail(command, recursiveSummary) {
+    const failures = Object.values(recursiveSummary).filter(({ status }) => status === 'failure');
+    if (failures.length > 0) {
+        throw new RecursiveFailError(command, recursiveSummary, failures);
+    }
+}
+//# sourceMappingURL=recursiveSummary.js.map

package/lib/style.d.ts

@@ -0,0 +1,20 @@
+export declare const TABLE_OPTIONS: {
+    border: {
+        topBody: string;
+        topJoin: string;
+        topLeft: string;
+        topRight: string;
+        bottomBody: string;
+        bottomJoin: string;
+        bottomLeft: string;
+        bottomRight: string;
+        bodyJoin: string;
+        bodyLeft: string;
+        bodyRight: string;
+        joinBody: string;
+        joinJoin: string;
+        joinLeft: string;
+        joinRight: string;
+    };
+    columns: {};
+};

package/lib/style.js

@@ -0,0 +1,25 @@
+import chalk from 'chalk';
+export const TABLE_OPTIONS = {
+    border: {
+        topBody: '─',
+        topJoin: '┬',
+        topLeft: '┌',
+        topRight: '┐',
+        bottomBody: '─',
+        bottomJoin: '┴',
+        bottomLeft: '└',
+        bottomRight: '┘',
+        bodyJoin: '│',
+        bodyLeft: '│',
+        bodyRight: '│',
+        joinBody: '─',
+        joinJoin: '┼',
+        joinLeft: '├',
+        joinRight: '┤',
+    },
+    columns: {},
+};
+for (const [key, value] of Object.entries(TABLE_OPTIONS.border)) {
+    TABLE_OPTIONS.border[key] = chalk.grey(value);
+}
+//# sourceMappingURL=style.js.map

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@pnpm/cli.utils",
+  "version": "1001.2.8",
+  "description": "Utils for pnpm commands",
+  "keywords": [
+    "pnpm",
+    "pnpm11"
+  ],
+  "license": "MIT",
+  "funding": "https://opencollective.com/pnpm",
+  "repository": "https://github.com/pnpm/pnpm/tree/main/cli/utils",
+  "homepage": "https://github.com/pnpm/pnpm/tree/main/cli/utils#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": {
+    "chalk": "^5.6.0",
+    "load-json-file": "^7.0.1",
+    "@pnpm/cli.meta": "1000.0.11",
+    "@pnpm/config.package-is-installable": "1000.0.15",
+    "@pnpm/error": "1000.0.5",
+    "@pnpm/pkg-manifest.utils": "1001.0.6",
+    "@pnpm/workspace.project-manifest-reader": "1001.1.4",
+    "@pnpm/types": "1000.9.0"
+  },
+  "peerDependencies": {
+    "@pnpm/logger": ">=1001.0.0 <1002.0.0"
+  },
+  "devDependencies": {
+    "@pnpm/cli.utils": "1001.2.8",
+    "@pnpm/logger": "1001.0.1"
+  },
+  "engines": {
+    "node": ">=22.13"
+  },
+  "jest": {
+    "preset": "@pnpm/jest-config"
+  },
+  "scripts": {
+    "lint": "eslint \"src/**/*.ts\"",
+    "compile": "tsgo --build && pnpm run lint --fix",
+    "test": "pnpm run compile"
+  }
+}