Azure / Azure/data-api-builder
[improve]: dab add/update output around config file is noisy and confusing
まだ誰も着手していません。
- 主要言語
- C#
- スター
- 1.5k
- フォーク
- 372
- 平均マージ
- 3日 22時間
- マージ済み PR(30日)
- 9
説明
## Current
The output logs are not clear or usable to the developer.
## desired dab add
```
> dab add Jerry --source dbo.table --type table --permissions anonymous:*
Info: Added entity: {entity-name}
```
> [!NOTE]
> Do not include the SUGGESTION output. That's just noise.
### Debug experience:
> --verbose
```
> dab add Jerry --source dbo.table --type table --permissions anonymous:*
dbug: Adding entity: {entity-name}
dbug: Microsoft.DataApiBuilder 2.0-rd
dbug: --config flag is (null)
dbug: DAB_ENVIRONMENT is (null)
dbug: Using c:\dev\CD\Demo\dab-config.json
dbug: Source is dbo.TableName
dbug: Type is view
dbug: Permissions are anonymous:*
Info: Added entity: {entity-name}
```
## desired dab update
```
> dab update Jerry --permissions anonymous:*
Info: Updated entity: {entity-name}
```
### Debug experience:
> --verbose
```
> dab update Jerry --permissions anonymous:*
dbug: Updating entity: {entity-name}
dbug: Microsoft.DataApiBuilder 2.0-rd
dbug: --config flag is (null)
dbug: DAB_ENVIRONMENT is (null)
dbug: Using c:\dev\CD\Demo\dab-config.json
Info: Updated entity: {entity-name}
```
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、dab add と dab update コマンドのエントリポイントと、それらの --verbose ロギングを追跡します。この issue の例と現在の出力を比較します。完了の条件は、Info メッセージが簡潔であり、有用なデバッグ詳細が --verbose の場合にのみ表示され、SUGGESTION 出力がないことです。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- csharp
- 領域
- cli, developer-experience
- issue の種類
- 機能追加
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 活発さ
- 静か
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 55/100