cjoudrey/graphql-schema-linter

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

Open

#4 建立於 2017年8月3日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)JavaScript (669 star) (62 fork)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
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
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.