@oclif/plugin-which 2.2.6 → 2.2.8

package/README.md

@@ -20,7 +20,7 @@ $ npm install -g @oclif/plugin-which
 $ oclif-example COMMAND
 running command...
 $ oclif-example (--version)
-@oclif/plugin-which/2.2.6 linux-x64 node-v18.12.1
+@oclif/plugin-which/2.2.8 linux-x64 node-v18.13.0
 $ oclif-example --help [COMMAND]
 USAGE
   $ oclif-example COMMAND
@@ -41,7 +41,12 @@ USAGE
 
 DESCRIPTION
   Show which plugin a command is in.
+
+EXAMPLES
+  See which plugin the `help` command is in:
+
+    $ oclif-example which help
 ```
 
-_See code: [src/commands/which.ts](https://github.com/oclif/plugin-which/blob/v2.2.6/src/commands/which.ts)_
+_See code: [src/commands/which.ts](https://github.com/oclif/plugin-which/blob/v2.2.8/src/commands/which.ts)_
 <!-- commandsstop -->

package/lib/commands/which.d.ts

@@ -2,5 +2,9 @@ import { Command } from '@oclif/core';
 export default class Which extends Command {
     static description: string;
     static strict: boolean;
+    static examples: {
+        description: string;
+        command: string;
+    }[];
     run(): Promise<void>;
 }

package/lib/commands/which.js

@@ -10,6 +10,9 @@ class Which extends core_1.Command {
             // So we must use the topicSeparator to split it into an array
             command = argv[0].split(this.config.topicSeparator);
         }
+        else {
+            throw new Error('"which" expects a command name.  Try something like "which your:command:here" ');
+        }
         const cmd = this.config.findCommand(command.join(':'), { must: true });
         core_1.CliUx.ux.styledHeader(command.join(this.config.topicSeparator));
         core_1.CliUx.ux.styledObject({
@@ -20,3 +23,9 @@ class Which extends core_1.Command {
 exports.default = Which;
 Which.description = 'Show which plugin a command is in.';
 Which.strict = false;
+Which.examples = [
+    {
+        description: 'See which plugin the `help` command is in:',
+        command: '<%= config.bin %> <%= command.id %> help',
+    },
+];

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"2.2.6","commands":{"which":{"id":"which","description":"Show which plugin a command is in.","strict":false,"pluginName":"@oclif/plugin-which","pluginAlias":"@oclif/plugin-which","pluginType":"core","aliases":[],"flags":{},"args":[]}}}
+{"version":"2.2.8","commands":{"which":{"id":"which","description":"Show which plugin a command is in.","strict":false,"pluginName":"@oclif/plugin-which","pluginAlias":"@oclif/plugin-which","pluginType":"core","aliases":[],"examples":[{"description":"See which plugin the `help` command is in:","command":"<%= config.bin %> <%= command.id %> help"}],"flags":{},"args":[]}}}

package/package.json

@@ -1,19 +1,19 @@
 {
   "name": "@oclif/plugin-which",
   "description": "find which plugin a command is in",
-  "version": "2.2.6",
+  "version": "2.2.8",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/plugin-which/issues",
   "dependencies": {
-    "@oclif/core": "^1.23.1",
+    "@oclif/core": "^1.25.0",
     "tslib": "^2.4.1"
   },
   "devDependencies": {
-    "@oclif/plugin-help": "^5.1.20",
-    "@oclif/test": "^2.2.16",
+    "@oclif/plugin-help": "^5.2.0",
+    "@oclif/test": "^2.3.1",
     "@types/chai": "^4.3.4",
     "@types/mocha": "^9",
-    "@types/node": "^14.18.35",
+    "@types/node": "^14.18.36",
     "chai": "^4.3.7",
     "eslint": "^7.32.0",
     "eslint-config-oclif": "^4.0.0",