Prompt 项目技术文档

1. 安装指南

安装环境要求

• Node.js 版本：>= 12.x
• npm 或 yarn

安装步骤

1. 打开终端或命令行工具。
2. 使用 npm 或 yarn 安装 prompt 包：

   npm install prompt
   

   或者

   yarn add prompt
   

2. 项目的使用说明

基本使用

prompt 是一个用于 Node.js 的命令行提示工具，支持用户输入、验证和默认值设置。以下是一个简单的使用示例：

const prompt = require('prompt');

// 启动 prompt
prompt.start();

// 获取用户输入的两个属性：username 和 email
prompt.get(['username', 'email'], function (err, result) {
  if (err) {
    console.error(err);
    return;
  }
  console.log('Command-line input received:');
  console.log('  username: ' + result.username);
  console.log('  email: ' + result.email);
});

使用 Promise

如果你不传递回调函数，prompt.get() 会返回一个 Promise：

const { username, email } = await prompt.get(['username', 'email']);
console.log('Username:', username);
console.log('Email:', email);

复杂属性提示

你可以使用 JSON Schema 来定义复杂的属性验证：

const schema = {
  properties: {
    name: {
      pattern: /^[a-zA-Z\s\-]+$/,
      message: 'Name must be only letters, spaces, or dashes',
      required: true
    },
    password: {
      hidden: true
    }
  }
};

prompt.start();

prompt.get(schema, function (err, result) {
  if (err) {
    console.error(err);
    return;
  }
  console.log('Command-line input received:');
  console.log('  name: ' + result.name);
  console.log('  password: ' + result.password);
});

3. 项目API使用文档

prompt.get(schema, callback)

• schema: 可以是字符串数组或 JSON Schema 对象，用于定义提示的属性和验证规则。
• callback: 回调函数，接收两个参数 err 和 result。

prompt.addProperties(obj, properties, callback)

• obj: 要扩展的对象。
• properties: 要添加的属性名称数组。
• callback: 回调函数，接收一个参数 err。

prompt.start()

启动 prompt 服务。

prompt.history(name)

获取指定属性的历史输入值。

prompt.override

用于覆盖提示的属性值，通常用于命令行参数。

4. 项目安装方式

使用 npm 安装

npm install prompt

使用 yarn 安装

yarn add prompt

全局安装（可选）

npm install -g prompt

通过以上步骤，你可以轻松安装并使用 prompt 项目，进行命令行用户输入的提示与验证。