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.