Allow marking options with "deprecated" help or visibility
メンテナーはふだん 3 日以内に返信
まだ誰も着手していません。
評価
調査の方向性
@Option のエントリポイントから始め、ヘルプでの表示可否とコマンドライン診断がどのように処理されているかを追跡します。提案された .deprecated(...) 形式によってオプションが非表示になり、置き換え先のオプションをユーザーに案内する警告が stderr に出力されれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Let's say my CLI tool has an old option that's no longer valid:
@Option
public var sendToCzechslovakia = false
Since Czechoslovakia doesn't exist anymore, I've replace it with sendToEuropeanUnion, and I want to inform folks still using it to change their command-line incantations. Wouldn't it be nice if I could write:
@Option(help: .deprecated("Use --send-to-european-union instead"))
public var sendToCzechslovakia = false
And have it automatically be hidden and emit some sort of diagnostic message to stderr?
⚠️ --send-to-czechoslovakia is deprecated: use --send-to-european-union instead
- 主要言語
- Swift
- スター
- 3.8k
- フォーク
- 436
- 平均マージ
- 4日 11時間
- マージ済み PR（30日）
- 2
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
apple/swift-argument-parser のほかの issue
-
documentation
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
apple/swift-argument-parser#1007 ·
メンテナーはふだん 3 日以内に返信
-
Tool tests fail under the Swift Build build system because `generate-manual` & `generate-docc-reference` are not built対応中かも @rgoldberg が 23 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
apple/swift-argument-parser#995 · コメント 1 件 ·
メンテナーはふだん 3 日以内に返信
-
Consider making `String.wrapped()` and `Platform.terminalWidth` public対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
apple/swift-argument-parser#973 · コメント 1 件 ·
メンテナーはふだん 3 日以内に返信
-
Include hidden args in completion scripts対応中かも @Galileo927 が 182 日前に担当しました。 オープンgood first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
apple/swift-argument-parser#733 · コメント 7 件 ·
メンテナーはふだん 3 日以内に返信
-
Shared `@OptionGroup` flag is rejected after a subcommand when the root has a passthrough `defaultSubcommand`対応中かも @sean0407 が 22 日前に担当しました。 オープン
難易度 4/5 1〜2日 初心者へのやさしさ 48/100
apple/swift-argument-parser#994 ·
メンテナーはふだん 3 日以内に返信
apple/swift-argument-parser の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
Ebullioscopic/Atoll#930 ·
メンテナーはふだん 2 日以内に返信
-
area:development bug triage:needs-triage
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
vburojevic/hermes#123 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 70/100
jaywcjlove/awesome-mac#4631 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
Muesli-HQ/muesli#764 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
-
Dynamic Island: "Tools" and "Files" are the Quick panel and the Shelf under other names対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
vorssaint/vorssaint-utils#4162 ·
メンテナーはふだん 2 日以内に返信