hasura/graphql-engine

print a context aware diff for metadata

Open

#3.263 geöffnet am 28. Okt. 2019

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (1 zugewiesene Person)TypeScript (31.371 Stars) (2.787 Forks)batch import
c/clihelp wantedk/enhancement

Beschreibung

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.

Contributor Guide

Tech Stack
typescriptnodejsgraphqlpostgresql
Domain
backendclideveloper experience
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 days
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Basic knowledge of Hasura metadataFamiliarity with CLI diff toolsTypeScript skills
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
50
Research-Richtung
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.