@pnpm/plugin-commands-setup 0.0.0-20230605-20230605142810

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-2016 Rico Sta. Cruz and other contributors
+Copyright (c) 2016-2023 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/plugin-commands-setup
+
+> pnpm commands for setting up pnpm
+
+[![npm version](https://img.shields.io/npm/v/@pnpm/plugin-commands-setup.svg)](https://www.npmjs.com/package/@pnpm/plugin-commands-setup)
+
+## Installation
+
+```sh
+pnpm add @pnpm/plugin-commands-setup
+```
+
+## License
+
+MIT

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+import * as setup from './setup';
+export { setup };

package/lib/index.js

@@ -0,0 +1,29 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setup = void 0;
+const setup = __importStar(require("./setup"));
+exports.setup = setup;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+CAAgC;AAEvB,sBAAK"}

package/lib/setup.d.ts

@@ -0,0 +1,11 @@
+export declare const rcOptionsTypes: () => {};
+export declare const cliOptionsTypes: () => {
+    force: BooleanConstructor;
+};
+export declare const shorthands: {};
+export declare const commandNames: string[];
+export declare function help(): string;
+export declare function handler(opts: {
+    force?: boolean;
+    pnpmHomeDir: string;
+}): Promise<string>;

package/lib/setup.js

@@ -0,0 +1,117 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handler = exports.help = exports.commandNames = exports.shorthands = exports.cliOptionsTypes = exports.rcOptionsTypes = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const cli_utils_1 = require("@pnpm/cli-utils");
+const logger_1 = require("@pnpm/logger");
+const os_env_path_extender_1 = require("@pnpm/os.env.path-extender");
+const render_help_1 = __importDefault(require("render-help"));
+const rcOptionsTypes = () => ({});
+exports.rcOptionsTypes = rcOptionsTypes;
+const cliOptionsTypes = () => ({
+    force: Boolean,
+});
+exports.cliOptionsTypes = cliOptionsTypes;
+exports.shorthands = {};
+exports.commandNames = ['setup'];
+function help() {
+    return (0, render_help_1.default)({
+        description: 'Sets up pnpm',
+        descriptionLists: [
+            {
+                title: 'Options',
+                list: [
+                    {
+                        description: 'Override the PNPM_HOME env variable in case it already exists',
+                        name: '--force',
+                        shortAlias: '-f',
+                    },
+                ],
+            },
+        ],
+        url: (0, cli_utils_1.docsUrl)('setup'),
+        usages: ['pnpm setup'],
+    });
+}
+exports.help = help;
+function getExecPath() {
+    // @ts-expect-error
+    if (process['pkg'] != null) {
+        // If the pnpm CLI was bundled by vercel/pkg then we cannot use the js path for npm_execpath
+        // because in that case the js is in a virtual filesystem inside the executor.
+        // Instead, we use the path to the exe file.
+        return process.execPath;
+    }
+    return (require.main != null) ? require.main.filename : process.cwd();
+}
+function copyCli(currentLocation, targetDir) {
+    const newExecPath = path_1.default.join(targetDir, path_1.default.basename(currentLocation));
+    if (path_1.default.relative(newExecPath, currentLocation) === '')
+        return;
+    logger_1.logger.info({
+        message: `Copying pnpm CLI from ${currentLocation} to ${newExecPath}`,
+        prefix: process.cwd(),
+    });
+    fs_1.default.mkdirSync(targetDir, { recursive: true });
+    fs_1.default.copyFileSync(currentLocation, newExecPath);
+}
+async function handler(opts) {
+    const execPath = getExecPath();
+    if (execPath.match(/\.[cm]?js$/) == null) {
+        copyCli(execPath, opts.pnpmHomeDir);
+    }
+    try {
+        const report = await (0, os_env_path_extender_1.addDirToEnvPath)(opts.pnpmHomeDir, {
+            configSectionName: 'pnpm',
+            proxyVarName: 'PNPM_HOME',
+            overwrite: opts.force,
+            position: 'start',
+        });
+        return renderSetupOutput(report);
+    }
+    catch (err) { // eslint-disable-line
+        switch (err.code) {
+            case 'ERR_PNPM_BAD_ENV_FOUND':
+                err.hint = 'If you want to override the existing env variable, use the --force option';
+                break;
+            case 'ERR_PNPM_BAD_SHELL_SECTION':
+                err.hint = 'If you want to override the existing configuration section, use the --force option';
+                break;
+        }
+        throw err;
+    }
+}
+exports.handler = handler;
+function renderSetupOutput(report) {
+    if (report.oldSettings === report.newSettings) {
+        return 'No changes to the environment were made. Everything is already up to date.';
+    }
+    const output = [];
+    if (report.configFile) {
+        output.push(reportConfigChange(report.configFile));
+    }
+    output.push(`Next configuration changes were made:
+${report.newSettings}`);
+    if (report.configFile == null) {
+        output.push('Setup complete. Open a new terminal to start using pnpm.');
+    }
+    else if (report.configFile.changeType !== 'skipped') {
+        output.push(`To start using pnpm, run:
+source ${report.configFile.path}
+`);
+    }
+    return output.join('\n\n');
+}
+function reportConfigChange(configReport) {
+    switch (configReport.changeType) {
+        case 'created': return `Created ${configReport.path}`;
+        case 'appended': return `Appended new lines to ${configReport.path}`;
+        case 'modified': return `Replaced configuration in ${configReport.path}`;
+        case 'skipped': return `Configuration already up to date in ${configReport.path}`;
+    }
+}
+//# sourceMappingURL=setup.js.map

package/lib/setup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"setup.js","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAmB;AACnB,gDAAuB;AACvB,+CAAyC;AACzC,yCAAqC;AACrC,qEAImC;AACnC,8DAAoC;AAE7B,MAAM,cAAc,GAAG,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,CAAA;AAA3B,QAAA,cAAc,kBAAa;AAEjC,MAAM,eAAe,GAAG,GAAG,EAAE,CAAC,CAAC;IACpC,KAAK,EAAE,OAAO;CACf,CAAC,CAAA;AAFW,QAAA,eAAe,mBAE1B;AAEW,QAAA,UAAU,GAAG,EAAE,CAAA;AAEf,QAAA,YAAY,GAAG,CAAC,OAAO,CAAC,CAAA;AAErC,SAAgB,IAAI;IAClB,OAAO,IAAA,qBAAU,EAAC;QAChB,WAAW,EAAE,cAAc;QAC3B,gBAAgB,EAAE;YAChB;gBACE,KAAK,EAAE,SAAS;gBAEhB,IAAI,EAAE;oBACJ;wBACE,WAAW,EAAE,+DAA+D;wBAC5E,IAAI,EAAE,SAAS;wBACf,UAAU,EAAE,IAAI;qBACjB;iBACF;aACF;SACF;QACD,GAAG,EAAE,IAAA,mBAAO,EAAC,OAAO,CAAC;QACrB,MAAM,EAAE,CAAC,YAAY,CAAC;KACvB,CAAC,CAAA;AACJ,CAAC;AAnBD,oBAmBC;AAED,SAAS,WAAW;IAClB,mBAAmB;IACnB,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,IAAI,EAAE;QAC1B,4FAA4F;QAC5F,8EAA8E;QAC9E,4CAA4C;QAC5C,OAAO,OAAO,CAAC,QAAQ,CAAA;KACxB;IACD,OAAO,CAAC,OAAO,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAA;AACvE,CAAC;AAED,SAAS,OAAO,CAAE,eAAuB,EAAE,SAAiB;IAC1D,MAAM,WAAW,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,cAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAA;IACxE,IAAI,cAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,eAAe,CAAC,KAAK,EAAE;QAAE,OAAM;IAC9D,eAAM,CAAC,IAAI,CAAC;QACV,OAAO,EAAE,yBAAyB,eAAe,OAAO,WAAW,EAAE;QACrE,MAAM,EAAE,OAAO,CAAC,GAAG,EAAE;KACtB,CAAC,CAAA;IACF,YAAE,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;IAC5C,YAAE,CAAC,YAAY,CAAC,eAAe,EAAE,WAAW,CAAC,CAAA;AAC/C,CAAC;AAEM,KAAK,UAAU,OAAO,CAC3B,IAGC;IAED,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAA;IAC9B,IAAI,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,IAAI,EAAE;QACxC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,CAAA;KACpC;IACD,IAAI;QACF,MAAM,MAAM,GAAG,MAAM,IAAA,sCAAe,EAAC,IAAI,CAAC,WAAW,EAAE;YACrD,iBAAiB,EAAE,MAAM;YACzB,YAAY,EAAE,WAAW;YACzB,SAAS,EAAE,IAAI,CAAC,KAAK;YACrB,QAAQ,EAAE,OAAO;SAClB,CAAC,CAAA;QACF,OAAO,iBAAiB,CAAC,MAAM,CAAC,CAAA;KACjC;IAAC,OAAO,GAAQ,EAAE,EAAE,sBAAsB;QACzC,QAAQ,GAAG,CAAC,IAAI,EAAE;YAClB,KAAK,wBAAwB;gBAC3B,GAAG,CAAC,IAAI,GAAG,2EAA2E,CAAA;gBACtF,MAAK;YACP,KAAK,4BAA4B;gBAC/B,GAAG,CAAC,IAAI,GAAG,oFAAoF,CAAA;gBAC/F,MAAK;SACN;QACD,MAAM,GAAG,CAAA;KACV;AACH,CAAC;AA7BD,0BA6BC;AAED,SAAS,iBAAiB,CAAE,MAA0B;IACpD,IAAI,MAAM,CAAC,WAAW,KAAK,MAAM,CAAC,WAAW,EAAE;QAC7C,OAAO,4EAA4E,CAAA;KACpF;IACD,MAAM,MAAM,GAAG,EAAE,CAAA;IACjB,IAAI,MAAM,CAAC,UAAU,EAAE;QACrB,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAA;KACnD;IACD,MAAM,CAAC,IAAI,CAAC;EACZ,MAAM,CAAC,WAAW,EAAE,CAAC,CAAA;IACrB,IAAI,MAAM,CAAC,UAAU,IAAI,IAAI,EAAE;QAC7B,MAAM,CAAC,IAAI,CAAC,0DAA0D,CAAC,CAAA;KACxE;SAAM,IAAI,MAAM,CAAC,UAAU,CAAC,UAAU,KAAK,SAAS,EAAE;QACrD,MAAM,CAAC,IAAI,CAAC;SACP,MAAM,CAAC,UAAU,CAAC,IAAI;CAC9B,CAAC,CAAA;KACC;IACD,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;AAC5B,CAAC;AAED,SAAS,kBAAkB,CAAE,YAA0B;IACrD,QAAQ,YAAY,CAAC,UAAU,EAAE;QACjC,KAAK,SAAS,CAAC,CAAC,OAAO,WAAW,YAAY,CAAC,IAAI,EAAE,CAAA;QACrD,KAAK,UAAU,CAAC,CAAC,OAAO,yBAAyB,YAAY,CAAC,IAAI,EAAE,CAAA;QACpE,KAAK,UAAU,CAAC,CAAC,OAAO,6BAA6B,YAAY,CAAC,IAAI,EAAE,CAAA;QACxE,KAAK,SAAS,CAAC,CAAC,OAAO,uCAAuC,YAAY,CAAC,IAAI,EAAE,CAAA;KAChF;AACH,CAAC"}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@pnpm/plugin-commands-setup",
+  "version": "0.0.0-20230605-20230605142810",
+  "description": "pnpm commands for setting up pnpm",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib",
+    "!*.map"
+  ],
+  "engines": {
+    "node": ">=16.14"
+  },
+  "repository": "https://github.com/pnpm/pnpm/blob/main/packages/plugin-commands-setup",
+  "keywords": [
+    "pnpm8",
+    "pnpm",
+    "setup"
+  ],
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/pnpm/pnpm/issues"
+  },
+  "homepage": "https://github.com/pnpm/pnpm/blob/main/packages/plugin-commands-setup#readme",
+  "dependencies": {
+    "@pnpm/os.env.path-extender": "^0.2.10",
+    "render-help": "^1.0.3",
+    "@pnpm/cli-utils": "0.0.0-20230605-20230605142810"
+  },
+  "funding": "https://opencollective.com/pnpm",
+  "peerDependencies": {
+    "@pnpm/logger": "^5.0.0"
+  },
+  "devDependencies": {
+    "@pnpm/error": "0.0.0-20230605-20230605142810",
+    "@pnpm/prepare": "0.0.0-20230605-20230605142810",
+    "@pnpm/plugin-commands-setup": "0.0.0-20230605-20230605142810"
+  },
+  "exports": {
+    ".": "./lib/index.js"
+  },
+  "scripts": {
+    "lint": "eslint \"src/**/*.ts\" \"test/**/*.ts\"",
+    "_test": "jest",
+    "test": "pnpm run compile && pnpm run _test",
+    "compile": "tsc --build && pnpm run lint --fix"
+  }
+}