cjoudrey/graphql-schema-linter

Add a rule to ensure deprecation reasons have a date and the date hasn't passed.

Open

#4 opened on 2017年8月3日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)JavaScript (669 stars) (62 forks)batch import
enhancementhelp wanted

説明

The goal of this rule is:

  • To push API clients off deprecated fields by letting them know when a field will get removed.
  • Encourage API owners to remove deprecated fields once the deprecation date has passed.
  • Possibly warn API owners as the deprecation date approaches (possibly configurable?).

コントリビューターガイド

技術スタック
graphqljavascriptnodejs
領域
toolingdeveloper experience
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3 hours
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
GraphQL schema knowledgeLinter rule creation basics
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
60
調査方針
Examine existing rules in the cjoudrey/graphql schema linter repository to understand the pattern for creating a new rule. The rule should validate that the `deprecationReason` argument on the `@deprecated` directive includes a date in a specific format, and that the date has not passed. Look at the GraphQL schema specification for the `@deprecated` directive and its arguments. Implement the rule and add tests.