@oclif/plugin-update 3.2.4 → 4.1.0

package/oclif.manifest.json

@@ -1,78 +1,91 @@
 {
-  "version": "3.2.4",
   "commands": {
     "update": {
-      "id": "update",
-      "description": "update the <%= config.bin %> CLI",
-      "strict": true,
-      "pluginName": "@oclif/plugin-update",
-      "pluginAlias": "@oclif/plugin-update",
-      "pluginType": "core",
       "aliases": [],
+      "args": {
+        "channel": {
+          "name": "channel"
+        }
+      },
+      "description": "update the <%= config.bin %> CLI",
       "examples": [
         {
-          "description": "Update to the stable channel:",
-          "command": "<%= config.bin %> <%= command.id %> stable"
+          "command": "<%= config.bin %> <%= command.id %> stable",
+          "description": "Update to the stable channel:"
         },
         {
-          "description": "Update to a specific version:",
-          "command": "<%= config.bin %> <%= command.id %> --version 1.0.0"
+          "command": "<%= config.bin %> <%= command.id %> --version 1.0.0",
+          "description": "Update to a specific version:"
         },
         {
-          "description": "Interactively select version:",
-          "command": "<%= config.bin %> <%= command.id %> --interactive"
+          "command": "<%= config.bin %> <%= command.id %> --interactive",
+          "description": "Interactively select version:"
         },
         {
-          "description": "See available versions:",
-          "command": "<%= config.bin %> <%= command.id %> --available"
+          "command": "<%= config.bin %> <%= command.id %> --available",
+          "description": "See available versions:"
         }
       ],
       "flags": {
         "autoupdate": {
-          "name": "autoupdate",
-          "type": "boolean",
           "hidden": true,
-          "allowNo": false
+          "name": "autoupdate",
+          "allowNo": false,
+          "type": "boolean"
         },
         "available": {
-          "name": "available",
-          "type": "boolean",
           "char": "a",
-          "description": "Install a specific version.",
-          "allowNo": false
+          "description": "See available versions.",
+          "name": "available",
+          "allowNo": false,
+          "type": "boolean"
         },
-        "version": {
-          "name": "version",
-          "type": "option",
-          "char": "v",
-          "description": "Install a specific version.",
-          "multiple": false,
-          "exclusive": [
-            "interactive"
-          ]
+        "force": {
+          "description": "Force a re-download of the requested version.",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
         },
         "interactive": {
-          "name": "interactive",
-          "type": "boolean",
           "char": "i",
           "description": "Interactively select version to install. This is ignored if a channel is provided.",
-          "allowNo": false,
           "exclusive": [
             "version"
-          ]
+          ],
+          "name": "interactive",
+          "allowNo": false,
+          "type": "boolean"
         },
-        "force": {
-          "name": "force",
-          "type": "boolean",
-          "description": "Force a re-download of the requested version.",
-          "allowNo": false
+        "version": {
+          "char": "v",
+          "description": "Install a specific version.",
+          "exclusive": [
+            "interactive"
+          ],
+          "name": "version",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         }
       },
-      "args": {
-        "channel": {
-          "name": "channel"
-        }
-      }
+      "hasDynamicHelp": false,
+      "id": "update",
+      "pluginAlias": "@oclif/plugin-update",
+      "pluginName": "@oclif/plugin-update",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "update.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "update"
+      ]
     }
-  }
+  },
+  "version": "4.1.0"
 }

package/package.json

@@ -1,57 +1,65 @@
 {
   "name": "@oclif/plugin-update",
-  "version": "3.2.4",
+  "version": "4.1.0",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/plugin-update/issues",
   "dependencies": {
-    "@oclif/core": "^2.11.8",
-    "chalk": "^4",
+    "@oclif/core": "^3.0.4",
+    "chalk": "^5",
     "cross-spawn": "^7.0.3",
     "debug": "^4.3.1",
     "filesize": "^6.1.0",
-    "fs-extra": "^9.0.1",
     "http-call": "^5.3.0",
-    "inquirer": "^8.2.6",
+    "inquirer": "^9.2.11",
     "lodash.throttle": "^4.1.1",
     "log-chopper": "^1.0.2",
     "semver": "^7.5.4",
     "tar-fs": "^2.1.1"
   },
   "devDependencies": {
-    "@oclif/plugin-help": "^5.2.19",
-    "@oclif/test": "^2.5.5",
-    "@types/chai": "^4.3.6",
+    "@commitlint/config-conventional": "^17.7.0",
+    "@oclif/plugin-help": "^5.2.17",
+    "@oclif/prettier-config": "^0.2.1",
+    "@oclif/test": "^3",
+    "@types/chai": "^4.3.5",
     "@types/cross-spawn": "^6.0.3",
+    "@types/debug": "^4.1.8",
     "@types/execa": "^0.9.0",
-    "@types/fs-extra": "^8.0.1",
     "@types/glob": "^7.1.3",
-    "@types/inquirer": "^8.2.0",
+    "@types/inquirer": "^9.0.3",
     "@types/lodash.throttle": "^4.1.6",
-    "@types/mocha": "^9",
-    "@types/node": "^14.18.62",
-    "@types/semver": "^7.5.2",
+    "@types/mocha": "^10",
+    "@types/node": "^18",
+    "@types/semver": "^7.5.3",
     "@types/supports-color": "^7.2.0",
-    "@types/write-json-file": "^3.2.1",
-    "chai": "^4.3.8",
-    "eslint": "^7.32.0",
-    "eslint-config-oclif": "^4",
-    "eslint-config-oclif-typescript": "^1.0.3",
-    "globby": "^11.0.2",
-    "mocha": "^9",
-    "nock": "^13.3.3",
-    "oclif": "^3.17.1",
+    "@types/tar-fs": "^2.0.2",
+    "chai": "^4.3.7",
+    "commitlint": "^17.7.2",
+    "eslint": "^8.49.0",
+    "eslint-config-oclif": "^5.0.0",
+    "eslint-config-oclif-typescript": "^3.0.1",
+    "eslint-config-prettier": "^9.0.0",
+    "got": "^13.0.0",
+    "husky": "^8.0.3",
+    "lint-staged": "^14.0.1",
+    "mocha": "^10.2.0",
+    "nock": "^13.3.2",
+    "oclif": "^4",
+    "prettier": "^3.0.3",
     "qqjs": "^0.3.11",
-    "sinon": "^12.0.1",
-    "ts-node": "^9.1.1",
-    "tslib": "^2.6.2",
-    "typescript": "4.4.3"
+    "quibble": "^0.8.0",
+    "sinon": "^16.1.0",
+    "strip-ansi": "^7.1.0",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.1.6"
   },
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=18.0.0"
   },
   "files": [
     "oclif.manifest.json",
-    "/lib"
+    "/dist",
+    "/oclif.lock"
   ],
   "homepage": "https://github.com/oclif/plugin-update",
   "keywords": [
@@ -60,25 +68,29 @@
   "license": "MIT",
   "oclif": {
     "autoupdate": "github",
-    "commands": "./lib/commands",
+    "commands": "./dist/commands",
     "bin": "oclif-example",
     "hooks": {
-      "init": "./lib/hooks/init"
+      "init": "./dist/hooks/init.js"
     },
     "devPlugins": [
       "@oclif/plugin-help"
-    ]
+    ],
+    "flexibleTaxonomy": true
   },
   "repository": "oclif/plugin-update",
   "scripts": {
-    "lint": "eslint . --ext .ts --config .eslintrc",
+    "build": "rm -rf lib && tsc",
+    "lint": "eslint . --ext .ts",
+    "postpack": "rm -f oclif.manifest.json",
+    "posttest": "yarn lint",
+    "prepack": "yarn build && oclif lock && oclif manifest . && oclif lock",
+    "prepare": "husky install",
     "pretest": "yarn build --noEmit && tsc -p test --noEmit",
+    "test:integration:sf": "mocha --forbid-only \"test/integration/sf.integration.ts\" --timeout 900000",
     "test": "mocha --forbid-only \"test/**/*.test.ts\"",
-    "posttest": "yarn lint",
-    "prepack": "yarn build && oclif manifest .",
-    "postpack": "rm -f oclif.manifest.json",
-    "version": "oclif readme && git add README.md",
-    "build": "rm -rf lib && tsc"
+    "version": "oclif readme && git add README.md"
   },
-  "main": "lib/index.js"
+  "exports": "./dist/index.js",
+  "type": "module"
 }

package/lib/commands/update.d.ts

@@ -1,20 +0,0 @@
-import { Command } from '@oclif/core';
-export default class UpdateCommand extends Command {
-    static description: string;
-    static args: {
-        channel: import("@oclif/core/lib/interfaces/parser").Arg<string | undefined, Record<string, unknown>>;
-    };
-    static examples: {
-        description: string;
-        command: string;
-    }[];
-    static flags: {
-        autoupdate: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        available: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        version: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
-        interactive: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-        force: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
-    };
-    run(): Promise<void>;
-    private promptForVersion;
-}

package/lib/commands/update.js

@@ -1,87 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const core_1 = require("@oclif/core");
-const inquirer_1 = require("inquirer");
-const path = (0, tslib_1.__importStar)(require("path"));
-const semver_1 = require("semver");
-const update_1 = require("../update");
-class UpdateCommand extends core_1.Command {
-    async run() {
-        const { args, flags } = await this.parse(UpdateCommand);
-        const updater = new update_1.Updater(this.config);
-        if (flags.available) {
-            const index = await updater.fetchVersionIndex();
-            const allVersions = (0, semver_1.sort)(Object.keys(index)).reverse();
-            const localVersions = await updater.findLocalVersions();
-            const table = allVersions.map(version => {
-                const location = localVersions.find(l => path.basename(l).startsWith(version)) || index[version];
-                return { version, location };
-            });
-            core_1.ux.table(table, { version: {}, location: {} });
-            return;
-        }
-        if (args.channel && flags.version) {
-            this.error('You cannot specify both a version and a channel.');
-        }
-        return updater.runUpdate({
-            channel: args.channel,
-            autoUpdate: flags.autoupdate,
-            force: flags.force,
-            version: flags.interactive ? await this.promptForVersion(updater) : flags.version,
-        });
-    }
-    async promptForVersion(updater) {
-        const choices = (0, semver_1.sort)(Object.keys(await updater.fetchVersionIndex())).reverse();
-        const { version } = await (0, inquirer_1.prompt)({
-            name: 'version',
-            message: 'Select a version to update to',
-            type: 'list',
-            choices: [...choices, new inquirer_1.Separator()],
-        });
-        return version;
-    }
-}
-exports.default = UpdateCommand;
-UpdateCommand.description = 'update the <%= config.bin %> CLI';
-UpdateCommand.args = {
-    channel: core_1.Args.string({ optional: true }),
-};
-UpdateCommand.examples = [
-    {
-        description: 'Update to the stable channel:',
-        command: '<%= config.bin %> <%= command.id %> stable',
-    },
-    {
-        description: 'Update to a specific version:',
-        command: '<%= config.bin %> <%= command.id %> --version 1.0.0',
-    },
-    {
-        description: 'Interactively select version:',
-        command: '<%= config.bin %> <%= command.id %> --interactive',
-    },
-    {
-        description: 'See available versions:',
-        command: '<%= config.bin %> <%= command.id %> --available',
-    },
-];
-UpdateCommand.flags = {
-    autoupdate: core_1.Flags.boolean({ hidden: true }),
-    available: core_1.Flags.boolean({
-        char: 'a',
-        description: 'Install a specific version.',
-    }),
-    version: core_1.Flags.string({
-        char: 'v',
-        description: 'Install a specific version.',
-        exclusive: ['interactive'],
-    }),
-    interactive: core_1.Flags.boolean({
-        char: 'i',
-        description: 'Interactively select version to install. This is ignored if a channel is provided.',
-        exclusive: ['version'],
-    }),
-    force: core_1.Flags.boolean({
-        description: 'Force a re-download of the requested version.',
-    }),
-};

package/lib/hooks/init.js

@@ -1,67 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.init = void 0;
-const tslib_1 = require("tslib");
-const core_1 = require("@oclif/core");
-const cross_spawn_1 = (0, tslib_1.__importDefault)(require("cross-spawn"));
-const fs = (0, tslib_1.__importStar)(require("fs-extra"));
-const path = (0, tslib_1.__importStar)(require("path"));
-const util_1 = require("../util");
-// eslint-disable-next-line unicorn/prefer-module
-const debug = require('debug')('cli:updater');
-function timestamp(msg) {
-    return `[${new Date().toISOString()}] ${msg}`;
-}
-async function mtime(f) {
-    const { mtime } = await fs.stat(f);
-    return mtime;
-}
-const init = async function (opts) {
-    if (opts.id === 'update')
-        return;
-    if (opts.config.scopedEnvVarTrue('DISABLE_AUTOUPDATE'))
-        return;
-    const binPath = this.config.binPath || this.config.bin;
-    const lastrunfile = path.join(this.config.cacheDir, 'lastrun');
-    const autoupdatefile = path.join(this.config.cacheDir, 'autoupdate');
-    const autoupdatelogfile = path.join(this.config.cacheDir, 'autoupdate.log');
-    const clientRoot = this.config.scopedEnvVar('OCLIF_CLIENT_HOME') || path.join(this.config.dataDir, 'client');
-    const autoupdateEnv = Object.assign(Object.assign({}, process.env), { [this.config.scopedEnvVarKey('TIMESTAMPS')]: '1', [this.config.scopedEnvVarKey('SKIP_ANALYTICS')]: '1' });
-    async function autoupdateNeeded() {
-        try {
-            const m = await mtime(autoupdatefile);
-            let days = 1;
-            if (opts.config.channel === 'stable')
-                days = 14;
-            m.setHours(m.getHours() + (days * 24));
-            return m < new Date();
-        }
-        catch (error) {
-            if (error.code !== 'ENOENT')
-                core_1.ux.error(error.stack);
-            if (global.testing)
-                return false;
-            debug('autoupdate ENOENT');
-            return true;
-        }
-    }
-    await (0, util_1.touch)(lastrunfile);
-    const clientDir = path.join(clientRoot, this.config.version);
-    if (await fs.pathExists(clientDir))
-        await (0, util_1.touch)(clientDir);
-    if (!await autoupdateNeeded())
-        return;
-    debug('autoupdate running');
-    await fs.outputFile(autoupdatefile, '');
-    debug(`spawning autoupdate on ${binPath}`);
-    const fd = await fs.open(autoupdatelogfile, 'a');
-    fs.write(fd, timestamp(`starting \`${binPath} update --autoupdate\` from ${process.argv.slice(1, 3).join(' ')}\n`));
-    (0, cross_spawn_1.default)(binPath, ['update', '--autoupdate'], {
-        detached: !this.config.windows,
-        stdio: ['ignore', fd, fd],
-        env: autoupdateEnv,
-    })
-        .on('error', (e) => process.emitWarning(e))
-        .unref();
-};
-exports.init = init;

package/lib/tar.d.ts

@@ -1,2 +0,0 @@
-/// <reference types="node" />
-export declare function extract(stream: NodeJS.ReadableStream, basename: string, output: string, sha?: string): Promise<void>;

package/lib/update.d.ts

@@ -1,44 +0,0 @@
-import { Config } from '@oclif/core';
-export declare namespace Updater {
-    type Options = {
-        autoUpdate: boolean;
-        channel?: string | undefined;
-        version?: string | undefined;
-        force?: boolean;
-    };
-    type VersionIndex = Record<string, string>;
-}
-export declare class Updater {
-    private config;
-    private readonly clientRoot;
-    private readonly clientBin;
-    constructor(config: Config);
-    runUpdate(options: Updater.Options): Promise<void>;
-    findLocalVersions(): Promise<string[]>;
-    fetchVersionIndex(): Promise<Updater.VersionIndex>;
-    private ensureClientDir;
-    private composeS3SubDir;
-    private s3ChannelManifestKey;
-    private s3VersionManifestKey;
-    private s3VersionIndexKey;
-    private fetchChannelManifest;
-    private fetchVersionManifest;
-    private fetchManifest;
-    private downloadAndExtract;
-    private update;
-    private updateToExistingVersion;
-    private notUpdatable;
-    private alreadyOnVersion;
-    private determineChannel;
-    private determinePlatform;
-    private determineCurrentVersion;
-    private findLocalVersion;
-    private setChannel;
-    private logChop;
-    private mtime;
-    private debounce;
-    private tidy;
-    private touch;
-    private refreshConfig;
-    private createBin;
-}