@oclif/plugin-search 0.0.1

package/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+### 0.0.1 (2022-08-04)
+
+
+### Features
+
+* add search command ([99d50e0](https://github.com/oclif/plugin-search/commit/99d50e0f1335b0166ebe4f90629ddd2583d629b4))
+
+
+### Bug Fixes
+
+* improve user experience ([4430085](https://github.com/oclif/plugin-search/commit/4430085df77d335cc7cef134cc626c2a61c0a556))
+* types ([ddc87c5](https://github.com/oclif/plugin-search/commit/ddc87c58842d73c7d20627101857da43f94c0364))

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Salesforce
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,49 @@
+@oclif/plugin-search
+=================
+
+A `search` command for your oclif CLI
+
+[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
+[![Version](https://img.shields.io/npm/v/oclif-plugin-search.svg)](https://npmjs.org/package/oclif-plugin-search)
+[![CircleCI](https://circleci.com/gh/oclif/plugin-search/tree/main.svg?style=shield)](https://circleci.com/gh/oclif/plugin-search/tree/main)
+[![Downloads/week](https://img.shields.io/npm/dw/oclif-plugin-search.svg)](https://npmjs.org/package/oclif-plugin-search)
+[![License](https://img.shields.io/npm/l/oclif-plugin-search.svg)](https://github.com/oclif/plugin-search/blob/main/package.json)
+
+<!-- toc -->
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+# Usage
+<!-- usage -->
+```sh-session
+$ npm install -g @oclif/plugin-search
+$ @oclif/plugin-search COMMAND
+running command...
+$ @oclif/plugin-search (--version)
+@oclif/plugin-search/0.0.1 linux-x64 node-v14.20.0
+$ @oclif/plugin-search --help [COMMAND]
+USAGE
+  $ @oclif/plugin-search COMMAND
+...
+```
+<!-- usagestop -->
+# Commands
+<!-- commands -->
+* [`@oclif/plugin-search search`](#oclifplugin-search-search)
+
+## `@oclif/plugin-search search`
+
+Search for a command.
+
+```
+USAGE
+  $ @oclif/plugin-search search
+
+DESCRIPTION
+  Search for a command.
+
+  Once you select a command, hit enter and it will show the help for that command.
+```
+
+_See code: [dist/commands/search.ts](https://github.com/oclif/plugin-search/blob/v0.0.1/dist/commands/search.ts)_
+<!-- commandsstop -->

package/bin/dev

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+
+const oclif = require('@oclif/core')
+
+const path = require('path')
+const project = path.join(__dirname, '..', 'tsconfig.json')
+
+// In dev mode -> use ts-node and dev plugins
+process.env.NODE_ENV = 'development'
+
+require('ts-node').register({project})
+
+// In dev mode, always show stack traces
+oclif.settings.debug = true;
+
+// Start the CLI
+oclif.run().then(oclif.flush).catch(oclif.Errors.handle)

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\dev" %*

package/bin/run

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+const oclif = require('@oclif/core')
+
+oclif.run().then(require('@oclif/core/flush')).catch(require('@oclif/core/handle'))

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/dist/commands/search.d.ts

@@ -0,0 +1,6 @@
+import { Command } from '@oclif/core';
+export default class Search extends Command {
+    static summary: string;
+    static description: string;
+    run(): Promise<unknown>;
+}

package/dist/commands/search.js

@@ -0,0 +1,52 @@
+"use strict";
+/*
+ * Copyright (c) 2022, salesforce.com, inc.
+ * All rights reserved.
+ * 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const inquirer_1 = require("inquirer");
+const core_1 = require("@oclif/core");
+const autocomplete_1 = require("../util/autocomplete");
+class Search extends core_1.Command {
+    async run() {
+        const commands = this.config.commands;
+        for (const command of commands) {
+            command.readableId = (0, core_1.toConfiguredId)(command.id, this.config);
+        }
+        (0, inquirer_1.registerPrompt)('autocomplete-search', autocomplete_1.AutocompleteSearch);
+        const { command } = await (0, inquirer_1.prompt)([
+            {
+                type: 'autocomplete-search',
+                name: 'command',
+                message: 'Search for a command',
+                emptyText: 'Nothing found!',
+                pageSize: 10,
+                validate: (val) => {
+                    return val ? true : 'Type something!';
+                },
+                searchOpts: {
+                    keys: ['readableId'],
+                    shouldSort: true,
+                    threshold: 0.25,
+                    ignoreLocation: true,
+                },
+                displayKey: 'readableId',
+                options: commands,
+                footer: (currentChoices, index) => {
+                    const cmd = commands.find(c => c.readableId === currentChoices.getChoice(index).value);
+                    if (cmd && cmd.summary)
+                        return cmd.summary;
+                },
+            },
+        ]);
+        if (command === 'help') {
+            return this.config.runCommand((0, core_1.toStandardizedId)(command, this.config), []);
+        }
+        return this.config.runCommand('help', [(0, core_1.toStandardizedId)(command, this.config)]);
+    }
+}
+exports.default = Search;
+Search.summary = 'Search for a command.';
+Search.description = 'Once you select a command, hit enter and it will show the help for that command.';

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { run } from '@oclif/core';

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.run = void 0;
+var core_1 = require("@oclif/core");
+Object.defineProperty(exports, "run", { enumerable: true, get: function () { return core_1.run; } });

package/dist/util/autocomplete.d.ts

@@ -0,0 +1,61 @@
+/// <reference types="node" />
+/**
+ * TODO: this functionality should eventually be moved to a separate library so that other plugins can use it.
+ *
+ * NOTE: this code was adapted from https://github.com/mokkabonna/inquirer-autocomplete-prompt
+ */
+import { Interface as ReadLineInterface } from 'node:readline';
+import Base = require('inquirer/lib/prompts/base');
+import InquirerChoices = require('inquirer/lib/objects/choices');
+import * as Inquirer from 'inquirer';
+import Fuse from 'fuse.js';
+declare type SearchOptions = Fuse.IFuseOptions<Record<string, unknown>>;
+declare type QuestionOpts = {
+    searchText: string;
+    footer: (currentChoices: Choices, index: number, output: string) => string;
+    searchOpts: SearchOptions;
+    emptyText: string;
+    displayKey: string;
+};
+export declare class Choices extends InquirerChoices {
+    constructor(choices: string[], options?: {
+        separator?: string;
+    });
+}
+export declare class AutocompleteSearch extends Base {
+    rl: ReadLineInterface;
+    opt: Inquirer.prompts.PromptOptions<Inquirer.Question> & QuestionOpts & {
+        loop: boolean;
+        pageSize: number;
+        options: Array<Record<string, unknown>>;
+    };
+    private currentChoices;
+    private firstRender;
+    private selected;
+    private initialValue;
+    private paginator;
+    private done;
+    private answer;
+    private shortAnswer;
+    private answerName;
+    private searching;
+    private nbChoices;
+    private searchedOnce;
+    private lastSearchTerm;
+    private fuse;
+    constructor(question: Inquirer.Question & Partial<QuestionOpts>, rl: ReadLineInterface, answers?: Record<string, any>);
+    _run(cb: (state: unknown) => void): Promise<AutocompleteSearch>;
+    render(error?: string): void;
+    onSubmit(line: string): void;
+    onSubmitAfterValidation(line: string): void;
+    search(searchTerm?: string): void;
+    ensureSelectedInRange(): void;
+    onKeypress(e: {
+        key: {
+            name: string;
+            ctrl: boolean;
+        };
+        value: string;
+    }): void;
+}
+export {};

package/dist/util/autocomplete.js

@@ -0,0 +1,250 @@
+"use strict";
+/*
+ * Copyright (c) 2022, salesforce.com, inc.
+ * All rights reserved.
+ * 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AutocompleteSearch = exports.Choices = void 0;
+const tslib_1 = require("tslib");
+const ansiEscapes = require("ansi-escapes");
+const Base = require("inquirer/lib/prompts/base");
+const InquirerChoices = require("inquirer/lib/objects/choices");
+const observe = require("inquirer/lib/utils/events");
+const utils = require("inquirer/lib/utils/readline");
+const Paginator = require("inquirer/lib/utils/paginator");
+const operators_1 = require("rxjs/operators");
+const Inquirer = (0, tslib_1.__importStar)(require("inquirer"));
+const chalk_1 = (0, tslib_1.__importDefault)(require("chalk"));
+const fuse_js_1 = (0, tslib_1.__importDefault)(require("fuse.js"));
+class Choices extends InquirerChoices {
+    constructor(choices, options = {}) {
+        // @ts-expect-error
+        super(choices, options);
+    }
+}
+exports.Choices = Choices;
+class AutocompleteSearch extends Base {
+    constructor(question, rl, answers = {}) {
+        super(question, rl, answers);
+        this.rl = rl;
+        this.selected = 0;
+        if (!this.opt.searchOpts) {
+            this.throwParamError('searchOpts');
+        }
+        this.fuse = new fuse_js_1.default(this.opt.options, this.opt.searchOpts);
+        this.currentChoices = new Choices([], {});
+        this.firstRender = true;
+        this.initialValue = this.opt.default;
+        const shouldLoop = this.opt.loop === undefined ? true : this.opt.loop;
+        this.paginator = new Paginator(this.screen, { isInfinite: shouldLoop });
+    }
+    async _run(cb) {
+        this.done = cb;
+        const events = observe(this.rl);
+        // eslint-disable-next-line unicorn/consistent-function-scoping
+        const dontHaveAnswer = () => this.answer === undefined;
+        events.line.pipe((0, operators_1.takeWhile)(dontHaveAnswer)).forEach(this.onSubmit.bind(this));
+        // @ts-ignore
+        events.keypress.pipe((0, operators_1.takeWhile)(dontHaveAnswer)).forEach(this.onKeypress.bind(this));
+        // Call once at init
+        this.search();
+        return Promise.resolve(this);
+    }
+    render(error) {
+        // Render question
+        let content = this.getQuestion();
+        let bottomContent = '';
+        if (this.firstRender) {
+            content += chalk_1.default.dim('(Use arrow keys or type to search , tab to autocomplete)');
+        }
+        // Render choices or answer depending on the state
+        if (this.status === 'answered') {
+            content += chalk_1.default.cyan(this.shortAnswer || this.answerName || this.answer);
+        }
+        else if (this.searching) {
+            content += this.rl.line;
+            bottomContent += '  ' + chalk_1.default.dim(this.opt.searchText || 'Searching...');
+        }
+        else if (this.nbChoices) {
+            const choicesStr = renderList(this.currentChoices, this.selected);
+            content += this.rl.line;
+            const indexPosition = this.selected;
+            let realIndexPosition = 0;
+            this.currentChoices.choices.every((choice, index) => {
+                if (index > indexPosition) {
+                    return false;
+                }
+                if (choice.type === 'separator') {
+                    return false;
+                }
+                const name = choice.name;
+                realIndexPosition += name ? name.split('\n').length : 0;
+                return true;
+            });
+            bottomContent += this.paginator.paginate(choicesStr, realIndexPosition, this.opt.pageSize);
+            if (this.opt.footer) {
+                const footer = this.opt.footer(this.currentChoices, this.selected, bottomContent);
+                if (footer)
+                    bottomContent += `\n${new Inquirer.Separator().line}\n${footer}`;
+            }
+        }
+        else {
+            content += this.rl.line;
+            bottomContent += `  ${chalk_1.default.yellow(this.opt.emptyText || 'No results...')}`;
+        }
+        if (error) {
+            bottomContent += `\n${chalk_1.default.red('>> ')}${error}`;
+        }
+        this.firstRender = false;
+        this.screen.render(content, bottomContent);
+    }
+    onSubmit(line) {
+        let lineOrRl = line || this.rl.line;
+        if (!lineOrRl) {
+            lineOrRl = (this.opt.default === null ? '' : this.opt.default);
+        }
+        if (typeof this.opt.validate === 'function') {
+            const checkValidationResult = (validationResult) => {
+                if (validationResult !== true) {
+                    this.render(validationResult || 'Enter something, tab to autocomplete!');
+                }
+                else {
+                    this.onSubmitAfterValidation(lineOrRl);
+                }
+            };
+            const choice = this.currentChoices.getChoice(this.selected);
+            const validationResult = this.opt.validate(choice, this.answers);
+            if (typeof validationResult === 'object' && typeof validationResult.then === 'function') {
+                void validationResult.then(checkValidationResult);
+            }
+            else {
+                checkValidationResult(validationResult);
+            }
+        }
+        else {
+            this.onSubmitAfterValidation(lineOrRl);
+        }
+    }
+    onSubmitAfterValidation(line) {
+        let choice = {};
+        if (this.nbChoices <= this.selected) {
+            this.rl.write(line);
+            this.search(line);
+            return;
+        }
+        if (this.nbChoices) {
+            choice = this.currentChoices.getChoice(this.selected);
+            this.answer = choice.value;
+            this.answerName = choice.name;
+            this.shortAnswer = choice.short;
+        }
+        else {
+            this.rl.write(line);
+            this.search(line);
+            return;
+        }
+        // @ts-expect-error
+        // eslint-disable-next-line unicorn/no-array-callback-reference, unicorn/no-array-method-this-argument
+        const value = this.opt.filter(choice.value, this.answers);
+        choice.value = value;
+        this.answer = value;
+        this.status = 'answered';
+        // Rerender prompt
+        this.render();
+        this.screen.done();
+        this.done(choice.value);
+    }
+    search(searchTerm) {
+        this.selected = 0;
+        // Only render searching state after first time
+        if (this.searchedOnce) {
+            this.searching = true;
+            this.currentChoices = new Choices([], {});
+            this.render(); // Now render current searching state
+        }
+        else {
+            this.searchedOnce = true;
+        }
+        this.lastSearchTerm = searchTerm;
+        const choices = searchTerm ?
+            this.fuse.search(searchTerm).map(el => el.item[this.opt.displayKey]) :
+            this.opt.options.map(el => el[this.opt.displayKey]).sort();
+        this.currentChoices = new Choices(choices, {});
+        // @ts-expect-error
+        const realChoices = this.currentChoices.filter(choice => choice.type !== 'separator' && !choice.disabled);
+        this.nbChoices = realChoices.length;
+        const selectedIndex = realChoices.findIndex(
+        // @ts-expect-error
+        choice => choice === this.initialValue || choice.value === this.initialValue);
+        if (selectedIndex >= 0) {
+            this.selected = selectedIndex;
+        }
+        this.searching = false;
+        this.render();
+    }
+    ensureSelectedInRange() {
+        const selectedIndex = Math.min(this.selected, this.nbChoices); // Not above currentChoices length - 1
+        this.selected = Math.max(selectedIndex, 0); // Not below 0
+    }
+    onKeypress(e) {
+        let len;
+        const keyName = (e.key && e.key.name) || undefined;
+        if (keyName === 'tab') {
+            if (this.currentChoices.getChoice(this.selected)) {
+                this.rl.write(ansiEscapes.cursorLeft);
+                const autoCompleted = this.currentChoices.getChoice(this.selected).value;
+                this.rl.write(ansiEscapes.cursorForward(autoCompleted.length));
+                // @ts-expect-error because readonly property
+                this.rl.line = autoCompleted;
+                this.render();
+            }
+        }
+        else if (keyName === 'down' || (keyName === 'n' && e.key.ctrl)) {
+            len = this.nbChoices;
+            this.selected = this.selected < len - 1 ? this.selected + 1 : 0;
+            this.ensureSelectedInRange();
+            this.render();
+            utils.up(this.rl, 2);
+        }
+        else if (keyName === 'up' || (keyName === 'p' && e.key.ctrl)) {
+            len = this.nbChoices;
+            this.selected = this.selected > 0 ? this.selected - 1 : len - 1;
+            this.ensureSelectedInRange();
+            this.render();
+        }
+        else {
+            this.render(); // Render input automatically
+            // Only search if input have actually changed, not because of other keypresses
+            if (this.lastSearchTerm !== this.rl.line) {
+                this.search(this.rl.line); // Trigger new search
+            }
+        }
+    }
+}
+exports.AutocompleteSearch = AutocompleteSearch;
+function renderList(choices, pointer) {
+    let output = '';
+    let separatorOffset = 0;
+    choices.forEach((choice, i) => {
+        if (choice.type === 'separator') {
+            separatorOffset += 1;
+            output += `  ${choice}\n`;
+            return;
+        }
+        if (choice.disabled) {
+            separatorOffset += 1;
+            output += `  - ${choice.name} ( ${typeof choice.disabled === 'string' ? choice.disabled : 'Disabled'})\n`;
+            return;
+        }
+        const isSelected = i - separatorOffset === pointer;
+        // eslint-disable-next-line no-useless-concat
+        let line = (isSelected ? '❯' + ' ' : '  ') + choice.name;
+        if (isSelected) {
+            line = chalk_1.default.cyan(line);
+        }
+        output += `${line}\n`;
+    });
+    return output.replace(/\n$/, '');
+}

package/oclif.manifest.json

@@ -0,0 +1 @@
+{"version":"0.0.1","commands":{"search":{"id":"search","summary":"Search for a command.","description":"Once you select a command, hit enter and it will show the help for that command.","strict":true,"pluginName":"@oclif/plugin-search","pluginAlias":"@oclif/plugin-search","pluginType":"core","aliases":[],"flags":{},"args":[]}}}

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@oclif/plugin-search",
+  "version": "0.0.1",
+  "description": "A command for searching commands",
+  "author": "Salesforce",
+  "homepage": "https://github.com/oclif/plugin-search",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "repository": "oclif/plugin-search",
+  "files": [
+    "/bin",
+    "/dist",
+    "/npm-shrinkwrap.json",
+    "/oclif.manifest.json"
+  ],
+  "dependencies": {
+    "@oclif/core": "^1.12.1",
+    "chalk": "^4",
+    "fuse.js": "^6.6.2",
+    "inquirer": "^8.2.4",
+    "rxjs": "^7.5.6"
+  },
+  "devDependencies": {
+    "@oclif/plugin-help": "^5",
+    "@oclif/plugin-plugins": "^2.0.1",
+    "@oclif/test": "^2",
+    "@types/chai": "^4",
+    "@types/inquirer": "^8.2.1",
+    "@types/mocha": "^9.0.0",
+    "@types/node": "^16.9.4",
+    "chai": "^4",
+    "eslint": "^7.32.0",
+    "eslint-config-oclif": "^4",
+    "eslint-config-oclif-typescript": "^1.0.2",
+    "globby": "^11",
+    "mocha": "^9",
+    "oclif": "^3",
+    "shx": "^0.3.3",
+    "ts-node": "^10.2.1",
+    "tslib": "^2.3.1",
+    "typescript": "^4.4.3"
+  },
+  "oclif": {
+    "commands": "./dist/commands",
+    "devPlugins": [
+      "@oclif/plugin-help",
+      "@oclif/plugin-plugins"
+    ],
+    "topicSeparator": " "
+  },
+  "scripts": {
+    "build": "shx rm -rf dist && tsc -b",
+    "lint": "eslint . --ext .ts --config .eslintrc",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "posttest": "yarn lint",
+    "prepack": "yarn build && oclif manifest && oclif readme",
+    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
+    "version": "oclif readme && git add README.md"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "bugs": "https://github.com/oclif/plugin-search/issues",
+  "keywords": [
+    "oclif"
+  ],
+  "types": "dist/index.d.ts"
+}