Custom validation messages for select-like prompts
まだ誰も着手していません。
評価
- 難易度
- 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
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
bombshell-dev/clack のほかの issue
-
難易度 3/5 1〜2日 初心者へのやさしさ 70/100
bombshell-dev/clack#613 · コメント 4 件 ·
-
難易度 5/5 1週間以上 初心者へのやさしさ 30/100
bombshell-dev/clack#597 ·
-
rfc: accessible modeオープンenhancement
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
bombshell-dev/clack#585 · コメント 1 件 · リアクション 1 件 ·
-
[Bug] Spinner does not run `onCancel` function on `Ctrl + C`対応中かも @cyphercodes が 102 日前に担当しました。 オープンbug
難易度 3/5 1〜2日 初心者へのやさしさ 68/100
bombshell-dev/clack#573 · コメント 1 件 · リアクション 2 件 ·
-
enhancement
難易度 3/5 1〜2日 初心者へのやさしさ 62/100
bombshell-dev/clack#565 · コメント 1 件 · リアクション 1 件 ·
bombshell-dev/clack の issue をすべて見る
似ている issue
-
by: ai-assisted frontend good-for: new-member spike
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
Northeastern-Electric-Racing/Argos#847 ·
メンテナーはふだん 4 日以内に返信
-
難易度 1/5 1〜3時間 初心者へのやさしさ 84/100
SignalK/freeboard-sk#990 ·
メンテナーはふだん 1 日以内に返信
-
[missing-inheritance] audit review (1 preset)対応中かも @github-actions が今日担当しました。 オープン
難易度 1/5 1時間未満 初心者へのやさしさ 82/100
osmberlin/tagging-schema-browser#363 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
Albert-Weasker/niubigeo#205 ·
メンテナーはふだん 1 日以内に返信
-
area/frontend area/v2 kind/bug priority/needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
kubeflow/notebooks#1498 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信