angular / angular/angular-cli

Schematics schema should take custom validation functions

未關閉
#12,705 3 則留言 1 個 reaction 已指派 0 人 在 GitHub 檢視
area: @angular-devkit/schematics feature feature: insufficient votes
主要語言
TypeScript
星號
27k
分支
11.8k
平均合併
14 小時 23 分鐘
30 天內合併 PR
162

描述

### Bug Report or Feature Request (mark with an `x`)
```
- [ ] bug report -> please search issues before submitting
- [x] feature request
```

### Desired functionality
I would like to be able to specify validation functions for options of a schematic in the schema. JSON Schema does have some [built-in validation](http://json-schema.org/latest/json-schema-validation.html#rfc.section.6), but this doesn't cover everything.

Here are a couple of examples that are not covered by JSON Schema:

- An option for the name of a new directory or file that should not match the name of an existing directory or file
- An option whose validity is based on a previous option's value

A workaround is to perform this type of validation within the schematic function itself, however, this is not the best possible user experience when using the prompt system. As a user, I would expect my input to be validated as I enter it, then re-prompted for if necessary. With this workaround, a user would need to re-invoke the program from the beginning if their input is found invalid within the schematic function.

貢獻指南

開啟貢獻指南

研究方向

首先追蹤 schematic schemas 的驗證方式,以及 prompt system 如何處理選項輸入;issue 將 schematic function 列為目前的 workaround。完成的標準是:由 schema 定義的自訂驗證能夠涵蓋跨選項和基於檔案系統的情況,在 prompting 期間驗證輸入,並在輸入無效時重新提示輸入。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
typescript
領域
cli, tooling
Issue 類型
功能
難度
5/5
預估耗時
一週以上
活躍度
停滯
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。