Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Custom validation messages for select-like prompts

オープン
#553 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
55/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
静か
技術スタック
typescript
領域
cli

調査の方向性

multiselect および groupMultiselect prompt entry point に既存の required バリデーションがあることから始め、select 系の prompt がバリデーションをどのように処理しているかを比較します。validate オプションの戻り値の動作と、それが required を置き換えるのか補完するのかを定義します。両方の prompt がカスタムバリデーションを受け付け、返された string メッセージを表示し、合意したとおり現在の required の動作を維持できれば完了です。

索引モデルが issue の本文から書いたものです。

説明

Context

This came up while evaluating @clack/prompts as a potential replacement for enquirer.js, comparing it with enquirer.js and @inquirer/prompts.

Split out from: #550

Problem

multiselect has a required option with a built-in validation message:

Please select at least one option

That message is not customizable, and there is no general validation hook for select-like prompts.

In enquirer.js, this kind of validation can be customized:

validate(value) {
  if (value.length === 0) return 'You must choose at least one package.'
  return true
}

Proposal

Add a validate option to select-like prompts, initially multiselect and groupMultiselect:

const selected = await multiselect({
  message: 'Choose packages',
  options: [...],
  validate: (values) => {
    if (values.length === 0) return 'Select at least one package.'
    return true
  },
})

The validation function could return true or a string error message.

Notes

This could either replace or complement the current required option.

主要言語
TypeScript
スター
8.1k
フォーク
218
平均マージ
1日 23時間
マージ済み PR(30日)
6

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

bombshell-dev/clack のほかの issue

bombshell-dev/clack の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。