@oclif/plugin-update 4.3.5 → 4.4.0

package/README.md

@@ -26,7 +26,7 @@ update the oclif-example CLI
 
 ```
 USAGE
-  $ oclif-example update [CHANNEL] [-a] [--force] [-i | -v <value>]
+  $ oclif-example update [CHANNEL] [--force |  | [-a | -v <value> | -i]]
 
 FLAGS
   -a, --available        See available versions.
@@ -55,7 +55,7 @@ EXAMPLES
     $ oclif-example update --available
 ```
 
-_See code: [src/commands/update.ts](https://github.com/oclif/plugin-update/blob/v4.3.5/src/commands/update.ts)_
+_See code: [src/commands/update.ts](https://github.com/oclif/plugin-update/blob/v4.4.0/src/commands/update.ts)_
 <!-- commandsstop -->
 
 # Contributing

package/dist/commands/update.d.ts

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

package/dist/commands/update.js

@@ -1,5 +1,6 @@
 import select from '@inquirer/select';
 import { Args, Command, Flags, ux } from '@oclif/core';
+import { got } from 'got';
 import { basename } from 'node:path';
 import { sort } from 'semver';
 import TtyTable from 'tty-table';
@@ -32,9 +33,11 @@ export default class UpdateCommand extends Command {
         available: Flags.boolean({
             char: 'a',
             description: 'See available versions.',
+            exclusive: ['version', 'interactive'],
         }),
         force: Flags.boolean({
             description: 'Force a re-download of the requested version.',
+            exclusive: ['interactive', 'available'],
         }),
         interactive: Flags.boolean({
             char: 'i',
@@ -44,22 +47,29 @@ export default class UpdateCommand extends Command {
         version: Flags.string({
             char: 'v',
             description: 'Install a specific version.',
-            exclusive: ['interactive'],
+            exclusive: ['interactive', 'force'],
         }),
     };
     async run() {
         const { args, flags } = await this.parse(UpdateCommand);
         const updater = new Updater(this.config);
         if (flags.available) {
-            const [index, localVersions] = await Promise.all([updater.fetchVersionIndex(), updater.findLocalVersions()]);
-            // eslint-disable-next-line new-cap
-            const t = TtyTable([
+            const { distTags, index, localVersions } = await lookupVersions(updater, this.config);
+            const headers = [
                 { align: 'left', value: 'Location' },
                 { align: 'left', value: 'Version' },
-            ], sort(Object.keys(index))
+            ];
+            if (distTags) {
+                headers.push({ align: 'left', value: 'Channel' });
+            }
+            // eslint-disable-next-line new-cap
+            const t = TtyTable(headers, sort(Object.keys(index))
                 .reverse()
                 .map((version) => {
                 const location = localVersions.find((l) => basename(l).startsWith(version)) || index[version];
+                if (distTags) {
+                    return [location, version, distTags[version] ?? ''];
+                }
                 return [location, version];
             }), { compact: true });
             ux.stdout(t.render());
@@ -72,14 +82,43 @@ export default class UpdateCommand extends Command {
             autoUpdate: flags.autoupdate,
             channel: args.channel,
             force: flags.force,
-            version: flags.interactive ? await promptForVersion(updater) : flags.version,
+            version: flags.interactive ? await promptForVersion(updater, this.config) : flags.version,
         });
     }
 }
-const promptForVersion = async (updater) => select({
-    choices: sort(Object.keys(await updater.fetchVersionIndex()))
-        .reverse()
-        .map((v) => ({ value: v })),
-    loop: false,
-    message: 'Select a version to update to',
-});
+const lookupVersions = async (updater, config) => {
+    ux.action.start('Looking up versions');
+    const [index, localVersions, distTags] = await Promise.all([
+        updater.fetchVersionIndex(),
+        updater.findLocalVersions(),
+        fetchDistTags(config),
+    ]);
+    ux.action.stop(`Found ${Object.keys(index).length} versions`);
+    return {
+        distTags,
+        index,
+        localVersions,
+    };
+};
+const fetchDistTags = async (config) => {
+    const distTags = config.pjson.oclif.update?.disableNpmLookup
+        ? {}
+        : await got
+            .get(`${config.npmRegistry ?? 'https://registry.npmjs.org'}/${config.pjson.name}`)
+            .json()
+            .then((r) => r['dist-tags']);
+    // Invert the distTags object so we can look up the channel by version
+    return Object.fromEntries(Object.entries(distTags ?? {}).map(([k, v]) => [v, k]));
+};
+const displayName = (value, distTags) => `${value} ${distTags[value] ? `(${distTags[value]})` : ''}`;
+const promptForVersion = async (updater, config) => {
+    const { distTags, index } = await lookupVersions(updater, config);
+    return select({
+        choices: sort(Object.keys(index))
+            .reverse()
+            .map((v) => ({ name: displayName(v, distTags), value: v })),
+        loop: false,
+        message: 'Select a version to update to',
+        pageSize: 10,
+    });
+};

package/dist/update.js

@@ -23,7 +23,6 @@ export class Updater {
         this.clientBin = join(this.clientRoot, 'bin', config.windows ? `${config.bin}.cmd` : config.bin);
     }
     async fetchVersionIndex() {
-        ux.action.status = 'fetching version index';
         const newIndexUrl = this.config.s3Url(s3VersionIndexKey(this.config));
         try {
             const { body } = await got.get(newIndexUrl);
@@ -64,6 +63,7 @@ export class Updater {
                 await this.updateToExistingVersion(current, localVersion);
             }
             else {
+                ux.action.status = 'fetching version index';
                 const index = await this.fetchVersionIndex();
                 const url = index[version];
                 if (!url) {

package/oclif.manifest.json

@@ -36,12 +36,20 @@
         "available": {
           "char": "a",
           "description": "See available versions.",
+          "exclusive": [
+            "version",
+            "interactive"
+          ],
           "name": "available",
           "allowNo": false,
           "type": "boolean"
         },
         "force": {
           "description": "Force a re-download of the requested version.",
+          "exclusive": [
+            "interactive",
+            "available"
+          ],
           "name": "force",
           "allowNo": false,
           "type": "boolean"
@@ -60,7 +68,8 @@
           "char": "v",
           "description": "Install a specific version.",
           "exclusive": [
-            "interactive"
+            "interactive",
+            "force"
           ],
           "name": "version",
           "hasDynamicHelp": false,
@@ -88,5 +97,5 @@
       ]
     }
   },
-  "version": "4.3.5"
+  "version": "4.4.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oclif/plugin-update",
-  "version": "4.3.5",
+  "version": "4.4.0",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/plugin-update/issues",
   "dependencies": {