@pnpm/plugin-commands-doctor 1.0.0

package/LICENSE

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

package/lib/doctor.d.ts

@@ -0,0 +1,7 @@
+import { Config } from '@pnpm/config';
+export declare const rcOptionsTypes: typeof cliOptionsTypes;
+export declare function cliOptionsTypes(): {};
+export declare const shorthands: {};
+export declare const commandNames: string[];
+export declare function help(): string;
+export declare function handler(opts: Pick<Config, 'failedToLoadBuiltInConfig'>): Promise<void>;

package/lib/doctor.js

@@ -0,0 +1,36 @@
+"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 render_help_1 = __importDefault(require("render-help"));
+const cli_utils_1 = require("@pnpm/cli-utils");
+const logger_1 = require("@pnpm/logger");
+exports.rcOptionsTypes = cliOptionsTypes;
+function cliOptionsTypes() {
+    return {};
+}
+exports.cliOptionsTypes = cliOptionsTypes;
+exports.shorthands = {};
+exports.commandNames = ['doctor'];
+function help() {
+    return (0, render_help_1.default)({
+        description: 'Checks for known common issues.',
+        url: (0, cli_utils_1.docsUrl)('doctor'),
+        usages: ['pnpm doctor [options]'],
+    });
+}
+exports.help = help;
+async function handler(opts) {
+    const { failedToLoadBuiltInConfig } = opts;
+    if (failedToLoadBuiltInConfig) {
+        // If true, means loading npm builtin config failed. Then there may have a prefix error, related: https://github.com/pnpm/pnpm/issues/5404
+        logger_1.logger.warn({
+            message: 'Load npm builtin configs failed. If the prefix builtin config does not work, you can use "pnpm config ls" to show builtin configs. And then use "pnpm config --global set <key> <value>" to migrate configs from builtin to global.',
+            prefix: process.cwd(),
+        });
+    }
+}
+exports.handler = handler;
+//# sourceMappingURL=doctor.js.map

package/lib/doctor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"doctor.js","sourceRoot":"","sources":["../src/doctor.ts"],"names":[],"mappings":";;;;;;AAAA,8DAAoC;AACpC,+CAAyC;AACzC,yCAAqC;AAGxB,QAAA,cAAc,GAAG,eAAe,CAAA;AAE7C,SAAgB,eAAe;IAC7B,OAAO,EAAE,CAAA;AACX,CAAC;AAFD,0CAEC;AAEY,QAAA,UAAU,GAAG,EAAE,CAAA;AAEf,QAAA,YAAY,GAAG,CAAC,QAAQ,CAAC,CAAA;AAEtC,SAAgB,IAAI;IAClB,OAAO,IAAA,qBAAU,EAAC;QAChB,WAAW,EAAE,iCAAiC;QAC9C,GAAG,EAAE,IAAA,mBAAO,EAAC,QAAQ,CAAC;QACtB,MAAM,EAAE,CAAC,uBAAuB,CAAC;KAClC,CAAC,CAAA;AACJ,CAAC;AAND,oBAMC;AAEM,KAAK,UAAU,OAAO,CAC3B,IAA+C;IAE/C,MAAM,EAAE,yBAAyB,EAAE,GAAG,IAAI,CAAA;IAC1C,IAAI,yBAAyB,EAAE;QAC7B,0IAA0I;QAC1I,eAAM,CAAC,IAAI,CAAC;YACV,OAAO,EAAE,qOAAqO;YAC9O,MAAM,EAAE,OAAO,CAAC,GAAG,EAAE;SACtB,CAAC,CAAA;KACH;AACH,CAAC;AAXD,0BAWC"}

package/lib/index.d.ts

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

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.doctor = void 0;
+const doctor = __importStar(require("./doctor"));
+exports.doctor = doctor;
+//# 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,iDAAkC;AAEzB,wBAAM"}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@pnpm/plugin-commands-doctor",
+  "version": "1.0.0",
+  "description": "Commands for checks of known common issues ",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib",
+    "!*.map"
+  ],
+  "engines": {
+    "node": ">=14.6"
+  },
+  "repository": "https://github.com/pnpm/pnpm/blob/main/packages/plugin-commands-doctor",
+  "keywords": [
+    "pnpm7",
+    "pnpm",
+    "doctor"
+  ],
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/pnpm/pnpm/issues"
+  },
+  "homepage": "https://github.com/pnpm/pnpm/blob/main/packages/plugin-commands-doctor#readme",
+  "dependencies": {
+    "@pnpm/cli-utils": "1.0.2",
+    "@pnpm/config": "16.0.2",
+    "render-help": "^1.0.2"
+  },
+  "peerDependencies": {
+    "@pnpm/logger": "^5.0.0"
+  },
+  "devDependencies": {
+    "@pnpm/plugin-commands-doctor": "1.0.0"
+  },
+  "funding": "https://opencollective.com/pnpm",
+  "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"
+  }
+}