Flatiron Prompt 教程

2026-01-18 10:30:28作者：胡唯隽

项目介绍

Flatiron Prompt 是一个轻量级的命令行界面工具库，旨在简化创建用户交互式命令行应用的过程。它由 Flatiron 团队开发，提供了一个直观的API来构建复杂的命令行界面，支持自定义提示、输入验证等多种功能，让开发者能够集中精力于业务逻辑而非底层细节。

项目快速启动

要快速启动并运行 Prompt，首先确保你的环境中安装了 Node.js。然后，可以通过以下步骤来尝试基本的使用：

安装 Flatiron Prompt

npm install --save prompt

示例代码

接下来，在一个新的Node.js文件中（例如：app.js），你可以这样使用Prompt：

const Prompt = require('prompt');

Prompt.start();

Prompt.get(['name', 'email'], function (err, result) {
  if (err) { return onErr(err); }
  
  console.log('Received:', result);
});

function onErr(err) {
  console.log(err);
  process.exit(1);
}

运行该脚本，你会看到命令行上出现两个连续的提示，要求输入名字和邮箱地址。

$ node app.js
? name: John Doe       // 用户输入
? email: john@example.com // 用户输入
Received: { name: 'John Doe', email: 'john@example.com' }

应用案例和最佳实践

在实际应用中，Prompt 可以用于各种场景，如配置文件的初次设置、用户反馈收集或任何需要从终端获取输入的地方。最佳实践中，应确保：

输入验证：利用Prompt的验证函数来保证数据的质量。
用户体验：清晰的提示信息和友好的错误处理提升用户满意度。
模块化设计：将不同类型的提示逻辑拆分为不同的模块，便于维护和重用。

// 示例：添加简单的输入验证
Prompt.get([
  {
    description: 'age',
    name: 'age',
    message: 'Your age please:',
    validate: value => !isNaN(value) && value > 0,
  }
], (error, results) => {
  if (!error && results.age) {
    console.log(`Your valid age is ${results.age}`);
  }
});