hasura/graphql-engine

print a context aware diff for metadata

Open

#3 263 ouverte le 28 oct. 2019

Voir sur GitHub
 (0 commentaires) (0 réactions) (1 assigné)TypeScript (31 371 stars) (2 787 forks)batch import
c/clihelp wantedk/enhancement

Description

Diff command added #3157 only prints a basic general purpose file diff.

With awareness of Hasura metadata and it's types a better, context aware diff can be printed, where it can do things like:

  • table abcd is tracked
  • relationship name is changed for table xyz

etc.

Guide contributeur

Stack technique
typescriptnodejsgraphqlpostgresql
Domaine
backendclideveloper experience
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 days
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Basic knowledge of Hasura metadataFamiliarity with CLI diff toolsTypeScript skills
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
50
Direction de recherche
Investigate the existing diff command implemented in PR #3157. Look at the Hasura metadata types (e.g., MetadataTableConfig, RelationshipInfo) in the codebase. Understand how metadata changes are represented and how context can be extracted. Study any existing tests or documentation. Propose a design for generating human readable diffs that mention table names and relationship changes. The implementation likely requires modifying the diff output logic in the CLI component.