{"id":20206771,"url":"https://github.com/enquirer/prompt-autocompletion","last_synced_at":"2025-04-10T12:33:12.434Z","repository":{"id":57331705,"uuid":"70843493","full_name":"enquirer/prompt-autocompletion","owner":"enquirer","description":"This repository has been archived, use the autocomplete prompt in Enquirer instead.","archived":false,"fork":false,"pushed_at":"2017-10-19T13:23:34.000Z","size":130,"stargazers_count":15,"open_issues_count":1,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-24T11:13:13.669Z","etag":null,"topics":["autocomplete","autocompletion","cli","console","enquirer","javascript","nodejs","plugin","prompt","terminal"],"latest_commit_sha":null,"homepage":"https://github.com/enquirer/enquirer","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/enquirer.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/contributing.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-10-13T20:03:41.000Z","updated_at":"2023-12-01T07:24:02.000Z","dependencies_parsed_at":"2022-09-05T10:10:49.202Z","dependency_job_id":null,"html_url":"https://github.com/enquirer/prompt-autocompletion","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/enquirer%2Fprompt-autocompletion","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/enquirer%2Fprompt-autocompletion/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/enquirer%2Fprompt-autocompletion/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/enquirer%2Fprompt-autocompletion/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/enquirer","download_url":"https://codeload.github.com/enquirer/prompt-autocompletion/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248204964,"owners_count":21064955,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["autocomplete","autocompletion","cli","console","enquirer","javascript","nodejs","plugin","prompt","terminal"],"created_at":"2024-11-14T05:25:59.670Z","updated_at":"2025-04-10T12:33:12.416Z","avatar_url":"https://github.com/enquirer.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# prompt-autocompletion [![NPM version](https://img.shields.io/npm/v/prompt-autocompletion.svg?style=flat)](https://www.npmjs.com/package/prompt-autocompletion) [![NPM downloads](https://img.shields.io/npm/dm/prompt-autocompletion.svg?style=flat)](https://npmjs.org/package/prompt-autocompletion)\n\n\u003e Prompt that autocompletes as you type. Can be used standalone or with a prompt system like [enquirer](https://github.com/enquirer/enquirer)\n\n![prompt-autocompletion example](https://raw.githubusercontent.com/enquirer/prompt-autocompletion/master/example.gif)\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save prompt-autocompletion\n```\n\n## Example usage\n\n```js\nvar states = ['Alabama', 'Alaska', 'American Samoa', ...];\nvar AutoComplete = require('prompt-autocompletion');\nvar autocomplete = new AutoComplete({\n  type: 'autocomplete',\n  name: 'from',\n  message: 'Select a state to travel from',\n  source: searchStates\n});\n\n// promise\nautocomplete.run()\n  .then(function(answer) {\n    console.log(answer);\n  });\n\n// or async\nautocomplete\n  .ask(function(answer) {\n    console.log(answer);\n  });\n\nfunction searchStates(answers, input) {\n  return new Promise(function(resolve) {\n    resolve(states.filter(filter(input)));\n  });\n}\n\nfunction filter(input) {\n  return function(state) {\n    return new RegExp(input, 'i').exec(state) !== null;\n  };\n}\n```\n\n## Enquirer usage\n\n```js\nvar states = ['Alabama', 'Alaska', 'American Samoa', ...];\nvar Enquirer = require('enquirer');\nvar enquirer = new Enquirer();\n\nenquirer.register('autocomplete', require('prompt-autocompletion'));\nvar questions = [\n  {\n    type: 'autocomplete',\n    name: 'from',\n    message: 'Select a state to travel from',\n    source: searchStates\n  },\n  {\n    type: 'autocomplete',\n    name: 'to',\n    message: 'Select a state to travel to',\n    source: searchStates\n  }\n];\n\nenquirer.ask(questions)\n  .then(function(answers) {\n    console.log(answers);\n  })\n  .catch(function(err) {\n    console.log(err);\n  });\n\nfunction searchStates(answers, input) {\n  return new Promise(function(resolve) {\n    resolve(states.filter(filter(input)));\n  });\n}\n\nfunction filter(input) {\n  return function(state) {\n    return new RegExp(input, 'i').exec(state) !== null;\n  };\n}\n```\n\n## Prompts\n\nOther prompt modules:\n\n* [prompt-checkbox](https://www.npmjs.com/package/prompt-checkbox): Multiple-choice/checkbox prompt. Can be used standalone or with a prompt system like [Enquirer](https://github.com/enquirer/enquirer). | [homepage](https://github.com/enquirer/prompt-checkbox \"Multiple-choice/checkbox prompt. Can be used standalone or with a prompt system like [Enquirer].\")\n* [prompt-confirm](https://www.npmjs.com/package/prompt-confirm): Confirm (yes/no) prompt. Can be used standalone or with a prompt system like [Enquirer](https://github.com/enquirer/enquirer). | [homepage](https://github.com/enquirer/prompt-confirm \"Confirm (yes/no) prompt. Can be used standalone or with a prompt system like [Enquirer].\")\n* [prompt-editor](https://www.npmjs.com/package/prompt-editor): Editor prompt. Opens your text editor and waits for you to save your input during… [more](https://github.com/enquirer/prompt-editor) | [homepage](https://github.com/enquirer/prompt-editor \"Editor prompt. Opens your text editor and waits for you to save your input during a prompt. Can be used standalone or with a prompt system like [Enquirer].\")\n* [prompt-expand](https://www.npmjs.com/package/prompt-expand): Expand prompt. Can be used as a standalone prompt, or with a prompt system like… [more](https://github.com/enquirer/prompt-expand) | [homepage](https://github.com/enquirer/prompt-expand \"Expand prompt. Can be used as a standalone prompt, or with a prompt system like [Enquirer].\")\n* [prompt-list](https://www.npmjs.com/package/prompt-list): List-style prompt. Can be used as a standalone prompt, or with a prompt system like… [more](https://github.com/enquirer/prompt-list) | [homepage](https://github.com/enquirer/prompt-list \"List-style prompt. Can be used as a standalone prompt, or with a prompt system like [Enquirer].\")\n* [prompt-password](https://www.npmjs.com/package/prompt-password): Password prompt. Can be used as a standalone prompt, or with a prompt system like… [more](https://github.com/enquirer/prompt-password) | [homepage](https://github.com/enquirer/prompt-password \"Password prompt. Can be used as a standalone prompt, or with a prompt system like [Enquirer].\")\n* [prompt-radio](https://www.npmjs.com/package/prompt-radio): Radio prompt. This prompt behaves like other radio-button interfaces, where only one choice is enabled… [more](https://github.com/enquirer/prompt-radio) | [homepage](https://github.com/enquirer/prompt-radio \"Radio prompt. This prompt behaves like other radio-button interfaces, where only one choice is enabled whilst all others are disabled. Can be used as a standalone prompt, or with a prompt system like [Enquirer].\")\n* [prompt-rawlist](https://www.npmjs.com/package/prompt-rawlist): Rawlist prompt. Can be used as a standalone prompt, or with a prompt system like… [more](https://github.com/enquirer/prompt-rawlist) | [homepage](https://github.com/enquirer/prompt-rawlist \"Rawlist prompt. Can be used as a standalone prompt, or with a prompt system like [Enquirer].\")\n\n## Attribution\n\nThis is entirely based on https://www.npmjs.com/package/inquirer-autocomplete-prompt Copyright (c) 2015, Martin Hansen [martin@martinhansen.no](mailto:martin@martinhansen.no)\n\nThanks, Martin!\n\n## About\n\n### Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\nPlease read the [contributing guide](.github/contributing.md) for avice on opening issues, pull requests, and coding standards.\n\n### Running tests\n\nInstall dev dependencies:\n\n```sh\n$ npm install -d \u0026\u0026 npm test\n```\n\n### Author\n\n**Jon Schlinkert**\n\n* [github/jonschlinkert](https://github.com/jonschlinkert)\n* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)\n\n### License\n\nCopyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).\nReleased under the [MIT license](https://github.com/enquirer/prompt-autocompletion/blob/master/LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.1.31, on October 13, 2016._","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fenquirer%2Fprompt-autocompletion","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fenquirer%2Fprompt-autocompletion","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fenquirer%2Fprompt-autocompletion/lists"}