搜尋套件、儲存庫與 APP 分類

cli_dialog 封面
套件詳情v0.5.0

cli_dialog

以 Inquirer.js 風格建立美觀且強大的 CLI 提示並測試它們。

macOSWindowsLinux
近 30 天下載
3110
喜歡數
38
Pub 分數
140

安裝套件

flutter pub add cli_dialog

套件介紹

根據套件公開資料產生的選型評估,僅供參考。

一個 Flutter/Dart 套件,可建立視覺上吸引人且互動性強的命令列介面(CLI)提示,靈感來自 Inquirer.js。它讓開發者能在終端中直接建立豐富的使用者互動,例如輸入表單、選項選單和確認對話框。此套件專為測試設計,方便模擬與驗證 CLI 工作流程。相容於 macOS、Windows 與 Linux,可順暢整合至基於 Dart 的 CLI 應用程式中。

適用情境

  • 建構互動式 CLI 工具
  • 測試基於終端的使用者流程
  • 建立設定向導
  • 開發命令列配置工具
  • 實現使用者輸入驗證

主要特色

  • Inquirer.js 風格的提示
  • 內建測試支援
  • 跨平台相容性
  • 用於常見提示類型的簡單 API
  • 支援非同步使用者互動

適合對象

  • Dart 開發人員建構 CLI 應用
  • 需要可測試終端介面的團隊
  • 腳本中需要使用者輸入的工具
  • 教授CLI設計的教育專案
  • 帶用戶互動的自動化腳本

使用建議

  • 需要終端環境
  • 僅限基於控制台的輸出
  • 可能需要為複雜 UI 進行額外設定
  • 不適用於GUI應用程式
  • 取決於平台特定終端行為

原始 README

以下為關聯原始碼儲存庫的 README 原文快照,最新內容請造訪原始碼儲存庫。

cli_dialog

Build Status Pub Version Coverage Status

A Dart package which allows you to use Inquirer.js prompts with some additional features.

The following GIF shows a CLI dialog which was created using this library. You can also visit the library page on pub.dev.

Demo of cli_dialog

You can find the source for this example here

Usage

Basic Usage
import 'package:cli_dialog/cli_dialog.dart';

void main() {
  final dialog = CLI_Dialog(questions: [
    ['What is your name?', 'name']
  ]);
  final name = dialog.ask()['name'];
}

Whenever you want to create a CLI dialog you create a CLI_Dialog() instance.

The CLI_Dialog class supports multiple keyword arguments amongst which questions is the most basic one. questions is a list of questions and corresponding keys to retreive the answers.

Thus, each list entry for questions has the following syntax: [<question>, <key<].

Then you will want to call the ask() method. It performs the CLI dialog and returns a map with the keys you provided and the values it received from the user.

Boolean questions
import 'package:cli_dialog/cli_dialog.dart';

void main() {
  final dialog = CLI_Dialog(booleanQuestions: [
    ['Are you happy with this package?', 'isHappy']
  ]);
  final answer = dialog.ask()['isHappy'];
}

As the name suggests, boolean questions just asks the user for (y/N) answers and always returns bool values.

The N in (y/N) indicates that the default answer is no. You can change this by passing trueByDefault: true to the constructor.

List questions
import 'package:cli_dialog/cli_dialog.dart';

void main() {
  const listQuestions = [
    [
      {
        'question': 'What is your favourite colour?',
        'options': ['Red', 'Blue', 'Green']
      },
      'colour'
    ]
  ];

  final dialog = CLI_Dialog(listQuestions: listQuestions);
  final answer = dialog.ask();
  final colour = answer['colour'];
}

List questions allow the user to make a selection amongst several strings. 'question' is the question that will be printed before the selection. 'options' are the options from which the user chooses exactly one. 'colour' is the key used to retreive the answer.

Messages

Messages were added in 0.2.0. They are used to display information to users without prompting them for an answer.

You can use them like any other question using the messages keyword parameter or addQuestion(message, is_message: true). It is only optional to include a key if you are not using order.

Order
import 'package:cli_dialog/cli_dialog.dart';

void main() {
  const listQuestions = [
    [
      {
        'question': 'Where are you from?',
        'options': ['Africa', 'Asia', 'Europe', 'North America', 'South Africa']
      },
      'origin'
    ]
  ];

  const booleanQuestions = [
    ['Do you want to continue?', 'continue']
  ];

  final dialog = CLI_Dialog(
      booleanQuestions: booleanQuestions,
      listQuestions: listQuestions,
      order: ['origin', 'continue']);

  dialog.ask();
}

The optional keyword parameter order for the constructor allows you to set a custom order for your questions in the dialog by passing a list with keys in your required order.

If you do not indicate any order then the standard order is applied:

  1. All messages are displayed to the user.
  2. All regular questions.
  3. All boolean questions.
  4. All list questions.

We used the order parameter in this example because otherwise the question 'Do you want to continue' would be asked before 'Where are you from?' according to standard order.

Navigation mode

Navigation mode was added in 0.2.0. It allows users to freely navigate through the prompt and repeadetly answer questions if the want to. For the developer it is a matter of setting navigationMode to true:

final dialog = CLI_Dialog(navigationMode: true);

In navigation mode, each question is prepended by an index which shows the user which question he currently answers. The user can then prepend a colon to his answer and use these indices to jump to another question, even those he has not answered yet. For instance, answering :2 makes the user jump to the second question. After answering it, the user will be prompted with the third question (again) etc. Entering a question number which is out of scope finishes the CLI_Dialog and makes it return the answer map.

Testing

This package also provides a small infrastructure for testing your dialogs.

For this purpose, there is the named constructor CLI_Dialog.std() which has two required arguments:

  • std_input = a StdinService
  • std_output = a StdoutService

StdinService and StdoutService are classes which are provided with this library. There are always used internally for i/o. If you explicitly use these classes then you will probably want to set the mock parameter to true which will make these services mock objects.

Furtermore, it is mostly advised to pass std_output to std_input using the informStdout and isTest parameter to inform the StdoutService about standard input in echo mode. Details can be checked out in the tests I have written (test/).

How it works

This library uses ANSI/XTerm escape sequences and regular escape sequences. You can take a look at them in this file

Contributing

Of course you are welcome to contribute to this project by issuing a pull request on Github.

Please write unit tests (test/) for new functionality and make sure that test.sh and lint.sh (tool/) run succesfully before submitting.

Please format your code using dartfmt -w . (this is also covered by lint.sh).

Windows

cli_dialog supports Windows.

  • Colors look a bit different in command prompt
  • The UTF-16 right indicator is replaced by a simple >

Acknowledgements and Alternatives

This library is more a less a Dart port of Inquirer.js.

There is dart_inquirer which is not developed any more (even the Github repository was deleted by the author). It works fine but it has less features than this package (no colors, no navigation, no resume, no question mark etc.).

I also found interact but I have not tested it.

所屬分類

依賴

依賴清單 1 項

原始碼儲存庫

使用此套件的專案

暫無相關資料。