@oclif/plugin-which 3.0.15 → 3.1.0

package/README.md

@@ -22,7 +22,7 @@ $ npm install -g @oclif/plugin-which
 $ oclif-example COMMAND
 running command...
 $ oclif-example (--version)
-@oclif/plugin-which/3.0.15 linux-x64 node-v20.10.0
+@oclif/plugin-which/3.1.0 linux-x64 node-v20.11.0
 $ oclif-example --help [COMMAND]
 USAGE
   $ oclif-example COMMAND
@@ -41,7 +41,10 @@ Show which plugin a command is in.
 
 ```
 USAGE
-  $ oclif-example which
+  $ oclif-example which [--json]
+
+GLOBAL FLAGS
+  --json  Format output as json.
 
 DESCRIPTION
   Show which plugin a command is in.
@@ -52,5 +55,5 @@ EXAMPLES
     $ oclif-example which help
 ```
 
-_See code: [src/commands/which.ts](https://github.com/oclif/plugin-which/blob/v3.0.15/src/commands/which.ts)_
+_See code: [src/commands/which.ts](https://github.com/oclif/plugin-which/blob/v3.1.0/src/commands/which.ts)_
 <!-- commandsstop -->

package/lib/commands/which.d.ts

@@ -1,10 +1,16 @@
 import { Command } from '@oclif/core';
+type WhichResult = {
+    aliasOf?: string;
+    plugin: string;
+};
 export default class Which extends Command {
     static description: string;
+    static enableJsonFlag: boolean;
     static examples: {
         command: string;
         description: string;
     }[];
     static strict: boolean;
-    run(): Promise<void>;
+    run(): Promise<WhichResult>;
 }
+export {};

package/lib/commands/which.js

@@ -1,6 +1,7 @@
-import { Command, ux } from '@oclif/core';
+import { Command, Errors, toConfiguredId, ux } from '@oclif/core';
 export default class Which extends Command {
     static description = 'Show which plugin a command is in.';
+    static enableJsonFlag = true;
     static examples = [
         {
             command: '<%= config.bin %> <%= command.id %> help',
@@ -11,18 +12,26 @@ export default class Which extends Command {
     async run() {
         const { argv } = await this.parse(Which);
         if (argv.length === 0) {
-            throw new Error('"which" expects a command name.  Try something like "which your:command:here" ');
+            throw new Errors.CLIError('"which" expects a command name', {
+                suggestions: [`Provide a command id like this, "${this.config.bin} which your:command:here"`],
+            });
         }
-        let command = argv;
-        if (argv.length === 1 && typeof argv[0] === 'string') {
-            // If this if statement is true then the command to find was passed in as a single string, e.g. `mycli which "my command"`
-            // So we must use the topicSeparator to split it into an array
-            command = argv[0].split(this.config.topicSeparator);
+        // if argv is length 1 and is a string, split it by the topicSeparator (e.g. "my:command" => ["my", "command"], "my command" => ["my", "command"])
+        // otherwise, use argv as is (e.g. ["my", "command"] => ["my", "command"])
+        const commandParts = argv.length === 1 && typeof argv[0] === 'string' ? argv[0].split(this.config.topicSeparator) : argv;
+        const cmd = this.config.findCommand(commandParts.join(':'), { must: true });
+        const isAlias = cmd.aliases.includes(commandParts.join(':'));
+        const result = { plugin: cmd.pluginName ?? 'unknown' };
+        if (isAlias) {
+            const possible = this.config.commands.find((c) => c.aliases.includes(cmd.id) && c.id !== cmd.id);
+            if (possible) {
+                result.aliasOf = toConfiguredId(possible?.id, this.config);
+            }
         }
-        const cmd = this.config.findCommand(command.join(':'), { must: true });
-        ux.styledHeader(command.join(this.config.topicSeparator));
-        ux.styledObject({
-            plugin: cmd.pluginName,
-        }, ['plugin']);
+        if (!this.jsonEnabled()) {
+            ux.styledHeader(commandParts.join(this.config.topicSeparator));
+            ux.styledObject(result);
+        }
+        return result;
     }
 }