开发工具【免费下载链接】enquirerStylish, intuitive and user-friendly prompts. Used by eslint, webpack, yarn, pm2, pnpm, RedwoodJS, FactorJS, salesforce, Cypress, Google Lighthouse, Generate, tencent cloudbase, lint-staged, gluegun, hygen, hardhat, AWS Amplify, GitHub Actions Toolkit, airbnb/nimbus, and more! Please follow Enquirers author: https://github.com/jonschlinkert项目地址https://gitcode.com/gh_mirrors/en/enquirer点击查看免费下载导读ArrayPrompt是 Enquirer 中所有数组选择类提示的公共基类负责在终端中渲染一组可滚动的选项列表并返回一个或多个选中值。本文以官方文档 support/src/content/types/array.md 为主体结合仓库源码 lib/types/array.js 与测试用例展开帮助你彻底掌握limit、initial等核心选项的语义理解choices、list、cursor三个实例属性的真实含义并厘清Select、MultiSelect、AutoComplete等具体提示与基类之间的继承关系。ArrayPrompt 是什么根据 support/src/content/types/array.md 的定义ArrayPrompt类用于创建在终端中展示一组选项choices、并返回一个或多个值的提示。它是数组类提示的抽象基类本身不直接对外暴露而是被以下具体提示继承使用具体提示所在源码文件继承链典型返回值Selectlib/prompts/select.jsArrayPrompt单个选项的nameMultiSelectlib/prompts/multiselect.jsSelect→ArrayPrompt构造时强制multiple: true多个选项name组成的数组AutoCompletelib/prompts/autocomplete.jsSelect→ArrayPrompt自动补全后的单个或多个值Sort、Editable、Survey等lib/prompts/ 目录下的相应文件同样基于ArrayPrompt各自语义的返回值从源码结构看ArrayPrompt导出位置在 lib/types/array.js 末尾module.exports ArrayPrompt;并通过 lib/types/index.js 统一汇总为ArrayPrompt导出lib/prompts/index.js 则把Select、MultiSelect、AutoComplete等具体提示挂到enquirer包的顶层 API 上。也就是说开发者日常使用的new Select(...)、new MultiSelect(...)背后核心逻辑全部来自ArrayPrompt。构造阶段做了什么在ArrayPrompt构造函数lib/types/array.js#L9-L19中除了调用父类Prompt的构造外还会调用this.cursorHide()隐藏终端光标初始化this.maxSelected options.maxSelected || Infinity多选上限默认无限初始化this.multiple options.multiple || false是否为多选模式初始化this.initial options.initial || 0默认初始选中项为第 0 项初始化this.delay options.delay || 0数字键选择时的延迟用于支持多位数序号输入初始化this.longest 0与this.num 前者用于计算最长选项文本以对齐布局后者用于累积用户键入的数字序号。这些字段在随后的reset()lib/types/array.js#L29-L58中进一步落地选项会被归一化为带index、path、enabled等属性的 Choice 对象并依据initial定位初始焦点。键盘操作ArrayPrompt 支持的按键组合原文档给出的按键映射表如下这些动作在源码中均有对应方法实现按键动作方法说明shift▲shiftUp无sort选项时向上滚动列表sort: true时上移当前项shift▼shiftDown无sort选项时向下滚动列表sort: true时下移当前项fn▲mac或Page UpwinpageUp减小可见区域limit减 1相当于向上翻页fn▼mac或Page DownwinpageDown增大可见区域limit加 1相当于向下翻页实现细节可以在 lib/types/array.js 中找到shiftUp/shiftDownL424-L444当options.sort true时进入排序模式调用swap()交换相邻选项并移动焦点否则调用scrollUp()/scrollDown()滚动列表。pageUp/pageDownL446-L466pageUp将limit减 1最小为 0pageDown将limit加 1最大不超过choices.length并相应收窄或放宽可见窗口。除了上述组合键ArrayPrompt还支持大量基础按键这些在文档中虽未以表格列出但在测试 test/prompt.select.js 的keypress events分组中得到验证▲/▼up/down在选项间移动焦点当选项总数大于可见窗口且焦点位于窗口边缘时自动滚动L372-L404。回车return/submit提交当前选择测试用例验证了按回车提交后返回首个选项名的行为test/prompt.select.js#L247-L266。数字键number直接键入序号跳到对应选项。number()实现L268-L324支持两位数字序号通过delay延迟等待用户继续输入越界序号会触发alert()。字母快捷键多选模式下space切换当前项选中状态、a全选/全不选、i反选、g切换分组L200-L229。home/end/first/last跳到列表首尾L326-L348。按键分发入口是Prompt.keypress()lib/prompt.js#L36-L50它优先调用options中同名的自定义动作其次调用 prompt 实例上的同名方法最后兜底到dispatch()。Options 配置项详解原文档列出ArrayPrompt支持的配置项整理并扩充如下名称类型默认值说明limitNumberoptions.choices.length终端中可见的选项数量列表更长时用户可上下滚动查看其余选项initialNumber\|String\|Arrayundefined初始选中项的索引或名称多选模式下可以是名称数组hintStringundefined提示行上的辅助说明文本渲染时以 muted 样式显示nameStringundefined选项结果对应的变量名typeStringundefined提示类型标识messageStringundefined显示在终端中的提示语原文档中拼写为messsage源码与常见用法均为messagechoicesArrayundefined选项列表支持字符串、对象、函数与 Promise 四种形态此外源码还揭示了若干文档未展开、但实际生效的选项multipleBoolean默认false是否允许多选MultiSelect就是通过new Select({ ...options, multiple: true })强制开启lib/prompts/multiselect.js#L7。maxSelectedNumber默认Infinity多选时最多可勾选的数量超出后space/toggle会触发alert()L13、L231-L233。delayNumber默认0数字键序号输入的确认延迟见上文number()。sortBoolean为true时shift↑/↓变为排序模式而非滚动模式。scrollBoolean为false时禁用边缘滚动焦点到顶/底后按键触发alert()L376-L378。suggestFunction自定义过滤函数AutoComplete用它实现实时补全lib/prompts/autocomplete.js#L66-L72。options.limit控制终端可见选项数量类型number默认值choices.length即默认全部显示作用设定终端中同时渲染的选项条数。当选项总数超出limit时用户可通过方向键上下滚动逐屏浏览。原文档示例——下列提示任意时刻只在终端渲染 3 个选项const prompt new Prompt({ name: alphabet, message: Choose some letters, choices: [a, b, c, d, e, f, g, h], limit: 3 });注意上述写法中的Prompt是文档中的示意基类名实际使用时应替换为Select或MultiSelect。仓库中可运行的等价示例参见 examples/select/option-limit.jsconst { Select } require(enquirer); const prompt new Select({ name: alphabet, message: Favorite color?, choices: [Blue, Green, Orange, Red, Violet], limit: 3 }); prompt.run() .then(answer console.log(Answer:, answer)) .catch(console.error);limit在源码中的落地逻辑位于 getter/setterlib/types/array.js#L599-L606get limit() { let { state, options, choices } this; let limit state.limit || this._limit || options.limit || choices.length; return Math.min(limit, this.height); }它按运行期状态 → 翻页产生的临时_limit→ 用户配置的options.limit→ 选项总数的优先级取值并最终受终端高度height约束——即使你设置了很大的limit也不会超出终端一屏能显示的行数。可见列表visibleL592-L597则是choices.slice(0, this.limit)的结果滚动逻辑由scrollUp/scrollDown依赖 lib/utils.js#L48-L49 的数组头尾旋转驱动。仓库中的动态演示见 media/types/array-option-limit.gif当limit: 3时8 个字母选项以每次 3 条的窗口上下滚动浏览。options.initial设置初始选中项类型number索引、string选项名或array多选时多个名称默认值undefined源码构造时回退为0即默认聚焦第 0 项initial的解析逻辑集中在reset()lib/types/array.js#L29-L58若initial是对象取其键名数组Object.keys若initial是数组多选预选逐个调用this.enable(this.find(v))启用对应选项若initial是字符串先通过findIndex()转为索引若initial是数字且大于-1则用Math.max(0, Math.min(initial, this.choices.length))夹紧到合法范围并启用该选项initialize()L21-L27还支持把initial写成函数运行时会await其返回值再解析。测试用例验证了两种常见用法test/prompt.select.js#L75-L114// 按索引初始聚焦第 3 项索引 2提交后返回 c const prompt new Prompt({ message: prompt-select, initial: 2, choices: [ { name: a, message: A }, { name: b, message: BB }, { name: c, message: CCC }, { name: d, message: DDDD } ] });// 也支持函数形式 const prompt new Prompt({ message: prompt-select, initial: () 2, choices: [/* ... */] });注意如果initial指向的选项被标记为disabledreset()末尾的isDisabled检查会调用down()把焦点顺移到下一个可用选项L55-L57对应测试见 test/prompt.select.js#L223-L243。实例属性choices、list 与 cursor原文档将ArrayPrompt的实例属性归纳为三个结合源码逐一展开prompt.choices——归一化后的选项数组由options.choices经过toChoices()/toChoice()lib/types/array.js#L60-L146归一化得到。归一化过程包括把字符串选项转为{ name: ... }对象支持函数选项运行时await其返回值与 Promise 选项测试 test/prompt.select.js#L48-L72 验证了choices直接传Promise.resolve([...])的用法为每个选项补齐name、message、value、index、path、enabled、input、cursor等字段嵌套的choices会递归归一化并生成parent、level、indent、path层级信息为分组选项如 examples/multiselect/choice-groups.js 中的用法奠定基础设置reset()回滚函数使选项可在提交失败后恢复初始状态。prompt.list——可见选项列表即当前屏幕显示的那部分选项。文档描述为若定义了options.limit则为可见列表否则为完整 choices 数组。在源码中这一概念由visiblegetter 承担L592-L597get visible() { return (this.state.visible || this.choices).slice(0, this.limit); }即默认取choices前limit项scrollUp/scrollDown滚动时state.visible会被更新从而改变可见窗口的内容。移动焦点时的边界判断如up()中len vis idx 0时先滚动都基于choices与visible的长度对比。prompt.cursor——焦点在可见列表中的位置源码中与之对应的是indexgetter/setterL618-L623get index() { return Math.max(0, this.state ? this.state.index : 0); }index表示当前焦点选项在可见visible数组中的位置源码统一使用index命名文档中的cursor是同一概念的早期称谓。结合focusedgetterL629-L635get focused() { let choice this.choices[this.index]; // ... return choice; }index同时作为choices数组的下标使用因此它实际上既标识可见列表中的位置也直接定位到对应的选项对象。键盘up/downL372-L404通过取模运算(idx ± 1) % len实现焦点循环并在options.scroll false时于首尾处alert()。相关的派生属性在实例属性基础上源码还提供了一组只读派生属性便于渲染与取值selectedL641-L643多选时返回所有已启用选项单选时返回焦点选项enabledL625-L627多选模式下所有已勾选项的数组selectableL637-L639所有未禁用、可被选中的选项valueL608-L616提交后的结果值提交逻辑见submit()L536-L564——多选时返回name数组单选时返回单个name。从基类到具体提示如何落地到 Select / MultiSelectSelectlib/prompts/select.js在ArrayPrompt之上只做了渲染与交互的定制重写renderChoice()为聚焦选项加指针pointer与强调样式为禁用项加 disabled 样式重写format()提交后把选中项名以primary样式拼接输出多选用,连接新增emptyError选项默认No items were selected多选提交且未勾选任何项时在提示行追加错误提示单选模式下space等字母键仅触发alert()dispatch 逻辑 L12-L17。MultiSelect则仅一行核心代码lib/prompts/multiselect.jsclass MultiSelect extends Select { constructor(options) { super({ ...options, multiple: true }); } }AutoCompletelib/prompts/autocomplete.js在Select之上增加了输入过滤能力append()/delete()维护输入框文本complete()调用suggest()默认按message包含匹配支持传入自定义suggest函数重新过滤state._choices并重建choices再调用super.render()渲染渲染时对匹配文本做高亮highlight选项可自定义高亮颜色默认styles.complement。如果你需要自定义一个全新的数组类提示推荐的路径是继承ArrayPrompt或Select参照 examples/enquirer/custom-prompt-class.js 中的模式注册到 Enquirer 中并复用上面介绍的choices/visible/index/submit等机制。相关提示类型速览原文档末尾列出了与ArrayPrompt相关的提示它们正是基于该基类构建的兄弟/派生类型可从以下文档继续深入AutoComplete输入即过滤的自动补全选择见 support/src/content/types/string.md 与 examples/autocomplete/ 系列示例Select单选列表相关示例集中在 examples/select/MultiSelect多选列表支持分组、限制最大选中数、排序相关示例集中在 examples/multiselect/Checkbox / Radio在roles.jslib/roles.js中预留了checkbox与radio两种角色定义但目前实现会抛出not implemented yet错误属于规划中的能力从源码结构看暂未开放使用。总结ArrayPrompt是理解 Enquirer 数组类提示的一把钥匙limit控制可见窗口并由终端高度兜底initial支持索引/名称/数组/函数四种形态决定初始焦点choices负责把任意形态的选项输入归一化为结构完整的 Choice 对象visible与index共同描述屏幕上看到什么、焦点在哪。掌握这些机制后无论是直接使用Select/MultiSelect配置生产环境脚本还是基于基类开发自定义终端提示都能做到有的放矢。更多实践示例可继续查阅 examples/ 目录或通过 test/prompt.select.js、test/prompt.multiselect.js 观察按键与初始化的完整行为。赞分享开发工具【免费下载链接】enquirerStylish, intuitive and user-friendly prompts. Used by eslint, webpack, yarn, pm2, pnpm, RedwoodJS, FactorJS, salesforce, Cypress, Google Lighthouse, Generate, tencent cloudbase, lint-staged, gluegun, hygen, hardhat, AWS Amplify, GitHub Actions Toolkit, airbnb/nimbus, and more! Please follow Enquirers author: https://github.com/jonschlinkert项目地址https://gitcode.com/gh_mirrors/en/enquirer点击查看免费下载相关推荐WinGet 配置完全指南深入解析 settings.json 全部设置项与底层实现WinGet 配置完全指南深入解析 settings.json 全部设置项与底层实现 WinGetWindows Package Manager通过 se包管理器CLIEnquirer 提示符状态属性 status 完全指南pending / submitted / cancelled 的判定、定制与底层实现Enquirer 提示符状态属性 status 完全指南pending / submitted / cancelled 的判定、定制与底层实现 prompt.开发工具Synology NAS thunder安全配置终极指南保护你的Linux NAS数据不泄露Synology NAS thunder安全配置终极指南保护你的Linux NAS数据不泄露 想要在Linux系统上安全运行Synology NAS thun上一篇Steam游戏破解新纪元3步搞定自动破解的黑科技神器下一篇OpenCore Configurator让黑苹果配置变得如此简单创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考