Syed Maarif R.
← Back to projects

Technical Case Study

Schema-Drift-Detector-CLI

A CLI utility for comparing JSON structures and catching breaking API changes before they reach the frontend.

Header / Meta

Status
Complete
Role
CLI author and maintainer
Timeline
Completed release
Repository
GitHub repository ↗
Core Stack
Node.jsTypeScriptJSON diffingCLI

Intricate Details

Problem Statement

API responses change in small ways that are easy to miss during review. A renamed field or changed type can pass through a changelog and still break consuming code.

Architecture Decisions

  • Parse the old and new JSON structures into comparable trees.
  • Classify structural changes by the risk they create for consumers.
  • Keep the workflow CLI-first so it can run locally, in CI, or before a release.
  • Print terminal output that helps a developer see the change quickly.

Engineering Trade-offs

  • The tool reports structure. It doesn't try to guess every business meaning behind a change.
  • Human-readable output matters more here than a large reporting layer.
  • The scope stays narrow so the command remains easy to run in a pipeline.

Resources

View Source Code

Gallery

Screenshot of Schema Drift Detector CLI initializing
Schema Drift Detector CLI initializing
Screenshot of Schema Drift Detector CLI help output
Schema Drift Detector CLI help output
Screenshot of Schema Drift Detector CLI check command in action
Schema Drift Detector CLI check command in action
Screenshot of Schema Drift Detector CLI output in multiple formats. Table, and JSON shown in the screenshot
Schema Drift Detector CLI output in multiple formats