cjoudrey/graphql-schema-linter

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

Open

#4 opened on Aug 3, 2017

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (669 stars) (62 forks)batch import
enhancementhelp wanted

Description

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?).

Contributor guide

Tech stack
graphqljavascriptnodejs
Domain
toolingdeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
GraphQL schema knowledgeLinter rule creation basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
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.