@oclif/plugin-search 1.1.4 → 1.1.5-dev.1

package/README.md

@@ -22,7 +22,7 @@ $ npm install -g @oclif/plugin-search
 $ @oclif/plugin-search COMMAND
 running command...
 $ @oclif/plugin-search (--version)
-@oclif/plugin-search/1.1.4 linux-x64 node-v20.14.0
+@oclif/plugin-search/1.1.5-dev.1 linux-x64 node-v20.14.0
 $ @oclif/plugin-search --help [COMMAND]
 USAGE
   $ @oclif/plugin-search COMMAND
@@ -49,7 +49,7 @@ DESCRIPTION
   Once you select a command, hit enter and it will show the help for that command.
 ```
 
-_See code: [src/commands/search.ts](https://github.com/oclif/plugin-search/blob/v1.1.4/src/commands/search.ts)_
+_See code: [src/commands/search.ts](https://github.com/oclif/plugin-search/blob/v1.1.5-dev.1/src/commands/search.ts)_
 <!-- commandsstop -->
 
 # Contributing

package/dist/commands/search.js

@@ -4,12 +4,15 @@
  * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
-import { Command, loadHelpClass, toConfiguredId, toStandardizedId } from '@oclif/core';
+import { Command, loadHelpClass, toConfiguredId, toStandardizedId, ux } from '@oclif/core';
+import ansiEscapes from 'ansi-escapes';
 import autocomplete from 'inquirer-autocomplete-standalone';
+import readline from 'node:readline';
 export default class Search extends Command {
     static description = 'Once you select a command, hit enter and it will show the help for that command.';
     static summary = 'Search for a command.';
     async run() {
+        this.log(`Use ${ux.colorize('bold', '↑')} and ${ux.colorize('bold', '↓')} keys or type to search. Press ${ux.colorize('bold', 'ESC')} to exit.\n`);
         const commandChoices = this.config.commands
             .filter((c) => !c.hidden && !c.aliases.includes(c.id))
             .sort((a, b) => a.id.localeCompare(b.id))
@@ -21,14 +24,37 @@ export default class Search extends Command {
                 value: name,
             };
         });
-        const command = await autocomplete({
+        const pageSize = Math.floor(process.stdout.rows < 20 ? process.stdout.rows / 2 : 10);
+        const commandPromise = autocomplete({
             emptyText: 'Nothing found!',
             message: 'Search for a command',
-            pageSize: 10,
+            pageSize,
             async source(input) {
                 return input ? commandChoices.filter((c) => c.name.includes(input)) : commandChoices;
             },
         });
+        function cancel() {
+            commandPromise.cancel();
+            // erase the list of commands
+            process.stdout.write(ansiEscapes.eraseLines(pageSize + 3));
+        }
+        readline.emitKeypressEvents(process.stdin);
+        process.stdin.setRawMode(true);
+        process.stdin.on('keypress', (_, key) => {
+            if (key.name === 'escape')
+                cancel();
+            if (key.name === 'c' && key.ctrl)
+                cancel();
+        });
+        const command = await commandPromise
+            .catch((error) => {
+            if (error.message === 'Prompt was canceled')
+                return;
+            throw error;
+        })
+            .then((result) => result);
+        if (!command)
+            return;
         const Help = await loadHelpClass(this.config);
         const help = new Help(this.config, this.config.pjson.oclif.helpOptions ?? this.config.pjson.helpOptions);
         return help.showHelp([toStandardizedId(command, this.config)]);

package/oclif.manifest.json

@@ -26,5 +26,5 @@
       ]
     }
   },
-  "version": "1.1.4"
+  "version": "1.1.5-dev.1"
 }

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@oclif/plugin-search",
-  "version": "1.1.4",
+  "version": "1.1.5-dev.1",
   "description": "A command for searching commands",
   "author": "Salesforce",
   "bugs": "https://github.com/oclif/plugin-search/issues",
   "dependencies": {
     "@oclif/core": "^4",
+    "ansi-escapes": "^7.0.0",
     "inquirer-autocomplete-standalone": "^0.8.1"
   },
   "devDependencies": {
@@ -26,8 +27,8 @@
     "husky": "^9",
     "lint-staged": "^15",
     "mocha": "^10.4.0",
-    "oclif": "^4.13.2",
-    "prettier": "^3.3.1",
+    "oclif": "^4.13.6",
+    "prettier": "^3.3.2",
     "shx": "^0.3.3",
     "ts-node": "^10.9.2",
     "typescript": "^5.4.5"