@oclif/plugin-update 3.0.13 → 3.1.1

package/lib/commands/update.d.ts

@@ -2,9 +2,8 @@ import { Command } from '@oclif/core';
 export default class UpdateCommand extends Command {
     static description: string;
     static args: {
-        name: string;
-        optional: boolean;
-    }[];
+        channel: import("@oclif/core/lib/interfaces/parser").Arg<string | undefined, Record<string, unknown>>;
+    };
     static examples: {
         description: string;
         command: string;
@@ -12,7 +11,7 @@ export default class UpdateCommand extends Command {
     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>;
+        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>;
     };

package/lib/commands/update.js

@@ -18,11 +18,11 @@ class UpdateCommand extends core_1.Command {
                 const location = localVersions.find(l => path.basename(l).startsWith(version)) || index[version];
                 return { version, location };
             });
-            core_1.CliUx.ux.table(table, { version: {}, location: {} });
+            core_1.ux.table(table, { version: {}, location: {} });
             return;
         }
         if (args.channel && flags.version) {
-            this.error('You cannot specifiy both a version and a channel.');
+            this.error('You cannot specify both a version and a channel.');
         }
         return updater.runUpdate({
             channel: args.channel,
@@ -44,7 +44,9 @@ class UpdateCommand extends core_1.Command {
 }
 exports.default = UpdateCommand;
 UpdateCommand.description = 'update the <%= config.bin %> CLI';
-UpdateCommand.args = [{ name: 'channel', optional: true }];
+UpdateCommand.args = {
+    channel: core_1.Args.string({ optional: true }),
+};
 UpdateCommand.examples = [
     {
         description: 'Update to the stable channel:',

package/lib/hooks/init.js

@@ -38,7 +38,7 @@ const init = async function (opts) {
         }
         catch (error) {
             if (error.code !== 'ENOENT')
-                core_1.CliUx.ux.error(error.stack);
+                core_1.ux.error(error.stack);
             if (global.testing)
                 return false;
             debug('autoupdate ENOENT');

package/lib/update.js

@@ -26,9 +26,9 @@ class Updater {
         const { autoUpdate, version, force = false } = options;
         if (autoUpdate)
             await this.debounce();
-        core_1.CliUx.ux.action.start(`${this.config.name}: Updating CLI`);
+        core_1.ux.action.start(`${this.config.name}: Updating CLI`);
         if (this.notUpdatable()) {
-            core_1.CliUx.ux.action.stop('not updatable');
+            core_1.ux.action.stop('not updatable');
             return;
         }
         const channel = options.channel || await this.determineChannel();
@@ -36,7 +36,7 @@ class Updater {
         if (version) {
             const localVersion = force ? null : await this.findLocalVersion(version);
             if (this.alreadyOnVersion(current, localVersion || null)) {
-                core_1.CliUx.ux.action.stop(this.config.scopedEnvVar('HIDE_UPDATED_MESSAGE') ? 'done' : `already on version ${current}`);
+                core_1.ux.action.stop(this.config.scopedEnvVar('HIDE_UPDATED_MESSAGE') ? 'done' : `already on version ${current}`);
                 return;
             }
             await this.config.runHook('preupdate', { channel, version });
@@ -54,26 +54,26 @@ class Updater {
                 await this.update(manifest, current, updated, force, channel);
             }
             await this.config.runHook('update', { channel, version });
-            core_1.CliUx.ux.action.stop();
-            core_1.CliUx.ux.log();
-            core_1.CliUx.ux.log(`Updating to a specific version will not update the channel. If autoupdate is enabled, the CLI will eventually be updated back to ${channel}.`);
+            core_1.ux.action.stop();
+            core_1.ux.log();
+            core_1.ux.log(`Updating to a specific version will not update the channel. If autoupdate is enabled, the CLI will eventually be updated back to ${channel}.`);
         }
         else {
             const manifest = await this.fetchChannelManifest(channel);
             const updated = manifest.sha ? `${manifest.version}-${manifest.sha}` : manifest.version;
             if (!force && this.alreadyOnVersion(current, updated)) {
-                core_1.CliUx.ux.action.stop(this.config.scopedEnvVar('HIDE_UPDATED_MESSAGE') ? 'done' : `already on version ${current}`);
+                core_1.ux.action.stop(this.config.scopedEnvVar('HIDE_UPDATED_MESSAGE') ? 'done' : `already on version ${current}`);
             }
             else {
                 await this.config.runHook('preupdate', { channel, version: updated });
                 await this.update(manifest, current, updated, force, channel);
             }
             await this.config.runHook('update', { channel, version: updated });
-            core_1.CliUx.ux.action.stop();
+            core_1.ux.action.stop();
         }
         await this.touch();
         await this.tidy();
-        core_1.CliUx.ux.debug('done');
+        core_1.ux.debug('done');
     }
     async findLocalVersions() {
         await this.ensureClientDir();
@@ -83,7 +83,7 @@ class Updater {
             .map(f => path.join(this.clientRoot, f));
     }
     async fetchVersionIndex() {
-        core_1.CliUx.ux.action.status = 'fetching version index';
+        core_1.ux.action.status = 'fetching version index';
         const newIndexUrl = this.config.s3Url(this.s3VersionIndexKey());
         try {
             const { body } = await http_call_1.default.get(newIndexUrl);
@@ -152,7 +152,7 @@ class Updater {
         return this.fetchManifest(s3Key);
     }
     async fetchManifest(s3Key) {
-        core_1.CliUx.ux.action.status = 'fetching manifest';
+        core_1.ux.action.status = 'fetching manifest';
         const url = this.config.s3Url(s3Key);
         const { body } = await http_call_1.default.get(url);
         if (typeof body === 'string') {
@@ -180,11 +180,11 @@ class Updater {
             arch: this.config.arch,
         });
         const extraction = (0, tar_1.extract)(stream, baseDir, output, sha256gz);
-        if (core_1.CliUx.ux.action.type === 'spinner') {
+        if (core_1.ux.action.type === 'spinner') {
             const total = Number.parseInt(stream.headers['content-length'], 10);
             let current = 0;
             const updateStatus = (0, lodash_throttle_1.default)((newStatus) => {
-                core_1.CliUx.ux.action.status = newStatus;
+                core_1.ux.action.status = newStatus;
             }, 250, { leading: true, trailing: false });
             stream.on('data', data => {
                 current += data.length;
@@ -196,7 +196,7 @@ class Updater {
     }
     // eslint-disable-next-line max-params
     async update(manifest, current, updated, force, channel) {
-        core_1.CliUx.ux.action.start(`${this.config.name}: Updating CLI from ${color_1.default.green(current)} to ${color_1.default.green(updated)}${channel === 'stable' ? '' : ' (' + color_1.default.yellow(channel) + ')'}`);
+        core_1.ux.action.start(`${this.config.name}: Updating CLI from ${color_1.default.green(current)} to ${color_1.default.green(updated)}${channel === 'stable' ? '' : ' (' + color_1.default.yellow(channel) + ')'}`);
         await this.ensureClientDir();
         const output = path.join(this.clientRoot, updated);
         if (force || !await fs.pathExists(output))
@@ -206,7 +206,7 @@ class Updater {
         await this.createBin(updated);
     }
     async updateToExistingVersion(current, updated) {
-        core_1.CliUx.ux.action.start(`${this.config.name}: Updating CLI from ${color_1.default.green(current)} to ${color_1.default.green(updated)}`);
+        core_1.ux.action.start(`${this.config.name}: Updating CLI from ${color_1.default.green(current)} to ${color_1.default.green(updated)}`);
         await this.ensureClientDir();
         await this.refreshConfig(updated);
         await this.createBin(updated);
@@ -215,7 +215,7 @@ class Updater {
         if (!this.config.binPath) {
             const instructions = this.config.scopedEnvVar('UPDATE_INSTRUCTIONS');
             if (instructions)
-                core_1.CliUx.ux.warn(instructions);
+                core_1.ux.warn(instructions);
             return true;
         }
         return false;
@@ -238,7 +238,7 @@ class Updater {
             return matches ? matches[1] : this.config.version;
         }
         catch (error) {
-            core_1.CliUx.ux.debug(error);
+            core_1.ux.debug(error);
         }
         return this.config.version;
     }
@@ -254,12 +254,12 @@ class Updater {
     }
     async logChop() {
         try {
-            core_1.CliUx.ux.debug('log chop');
+            core_1.ux.debug('log chop');
             const logChopper = require('log-chopper').default;
             await logChopper.chop(this.config.errlog);
         }
         catch (error) {
-            core_1.CliUx.ux.debug(error.message);
+            core_1.ux.debug(error.message);
         }
     }
     async mtime(f) {
@@ -275,20 +275,20 @@ class Updater {
         if (m > new Date()) {
             const msg = `waiting until ${m.toISOString()} to update`;
             if (output) {
-                core_1.CliUx.ux.debug(msg);
+                core_1.ux.debug(msg);
             }
             else {
-                core_1.CliUx.ux.log(msg);
+                core_1.ux.log(msg);
                 output = true;
             }
             await (0, util_1.wait)(60 * 1000); // wait 1 minute
             return this.debounce();
         }
-        core_1.CliUx.ux.log('time to update');
+        core_1.ux.log('time to update');
     }
     // removes any unused CLIs
     async tidy() {
-        core_1.CliUx.ux.debug('tidy');
+        core_1.ux.debug('tidy');
         try {
             const root = this.clientRoot;
             if (!await fs.pathExists(root))
@@ -308,20 +308,20 @@ class Updater {
             await this.logChop();
         }
         catch (error) {
-            core_1.CliUx.ux.warn(error);
+            core_1.ux.warn(error);
         }
     }
     async touch() {
         // touch the client so it won't be tidied up right away
         try {
             const p = path.join(this.clientRoot, this.config.version);
-            core_1.CliUx.ux.debug('touching client at', p);
+            core_1.ux.debug('touching client at', p);
             if (!await fs.pathExists(p))
                 return;
             await fs.utimes(p, new Date(), new Date());
         }
         catch (error) {
-            core_1.CliUx.ux.warn(error);
+            core_1.ux.warn(error);
         }
     }
     async refreshConfig(version) {

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"3.0.13","commands":{"update":{"id":"update","description":"update the <%= config.bin %> CLI","strict":true,"pluginName":"@oclif/plugin-update","pluginAlias":"@oclif/plugin-update","pluginType":"core","aliases":[],"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"}],"flags":{"autoupdate":{"name":"autoupdate","type":"boolean","hidden":true,"allowNo":false},"available":{"name":"available","type":"boolean","char":"a","description":"Install a specific version.","allowNo":false},"version":{"name":"version","type":"option","char":"v","description":"Install a specific version.","multiple":false,"exclusive":["interactive"]},"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"]},"force":{"name":"force","type":"boolean","description":"Force a re-download of the requested version.","allowNo":false}},"args":[{"name":"channel"}]}}}
+{"version":"3.1.1","commands":{"update":{"id":"update","description":"update the <%= config.bin %> CLI","strict":true,"pluginName":"@oclif/plugin-update","pluginAlias":"@oclif/plugin-update","pluginType":"core","aliases":[],"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"}],"flags":{"autoupdate":{"name":"autoupdate","type":"boolean","hidden":true,"allowNo":false},"available":{"name":"available","type":"boolean","char":"a","description":"Install a specific version.","allowNo":false},"version":{"name":"version","type":"option","char":"v","description":"Install a specific version.","multiple":false,"exclusive":["interactive"]},"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"]},"force":{"name":"force","type":"boolean","description":"Force a re-download of the requested version.","allowNo":false}},"args":{"channel":{"name":"channel"}}}}}

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@oclif/plugin-update",
-  "version": "3.0.13",
+  "version": "3.1.1",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/plugin-update/issues",
   "dependencies": {
     "@oclif/color": "^1.0.3",
-    "@oclif/core": "^1.25.0",
+    "@oclif/core": "^2.0.7",
     "cross-spawn": "^7.0.3",
     "debug": "^4.3.1",
     "filesize": "^6.1.0",
@@ -19,7 +19,7 @@
   },
   "devDependencies": {
     "@oclif/plugin-help": "^5.2.0",
-    "@oclif/test": "^2.3.1",
+    "@oclif/test": "^2.3.3",
     "@types/chai": "^4.3.4",
     "@types/cross-spawn": "^6.0.2",
     "@types/execa": "^0.9.0",
@@ -39,7 +39,7 @@
     "globby": "^11.0.2",
     "mocha": "^9",
     "nock": "^13.3.0",
-    "oclif": "^2.4.2",
+    "oclif": "^3.5.0",
     "qqjs": "^0.3.11",
     "sinon": "^12.0.1",
     "ts-node": "^9.1.1",