TechPrufer
Get started
GitHub
GitHub logoGitHub · Feature trail

Octokit JavaScript SDK Evolution

1 post · Apr 2020

What this trail covers

This feature thread tracks the evolution of the Octokit JavaScript SDK, focusing on its decomposition into smaller, reusable modules, improved maintainability, and enhanced developer experience. The evolution includes migrating from a monolithic structure to a plugin-based architecture, automating API definition updates, and leveraging TypeScript for better code validation and reduced bundle sizes. The goal is to provide a flexible and efficient SDK for interacting with GitHub's APIs across various JavaScript environments.

All GitHub trails
  1. From 48k lines of code to 10—the story of GitHub's JavaScript SDKThis post details the significant refactoring of the GitHub JavaScript SDK (`@octokit/rest`). It describes the transition from a monolithic 16k LOC library to a decomposed architecture using plugins and smaller modules like `@octokit/endpoint`, `@octokit/request`, and `@octokit/core`. Key technical contributions include automating API route definitions by scraping documentation, introducing a plugin API for extensibility, and leveraging TypeScript to replace runtime validation, leading to a drastic reduction in code size and improved maintainability. The post also outlines the strategy for future decomposition and the adoption of `@octokit/core` as the new foundation.