$ show microsoft/codetour
CodeTour is a Visual Studio Code extension for recording and playing guided walkthroughs of codebases. It allows developers to create interactive step-by-step tours associated with files, directories, and specific lines of code, with support for markdown descriptions, code snippets, shell commands, and command links. The extension features a player (comment-based UI, tree view, status bar, gutter markers) and a recorder (comment creation, step management, git ref association, tour export). It integrates with VS Live Share for collaborative tours and exposes an API for other extensions. The architecture is modular with clear separation between player, recorder, store (MobX-based state management), and LiveShare modules. The codebase is well-structured and demonstrates good TypeScript practices, though it lacks automated tests and relies on some experimental VS Code APIs (notebook provider). The project appears to be in a stale maintenance state with the last release in March 2023.
The LLM identified 3 files worth highlighting for reuse:
Defines the core data model (CodeTour, CodeTourStep, ActiveTour, Store) using MobX observables. This file establishes the entire state management pattern for the extension, including observable tours, active tour state, and progress tracking. The interfaces are well-typed and can serve as a reusable pattern for other VS Code extensions needing reactive state.
Implements a custom FileSystemProvider that exposes a virtual file system (scheme 'codetour') for tour steps with embedded file contents. This allows the extension to open and edit files that are embedded inside a tour JSON without writing them to disk. The pattern is non-trivial and can be extracted for any VS Code extension needing a read/write virtual file system backed by custom data.
Handles synchronization of tour state across VS Live Share sessions. It listens to tour start/end events and broadcasts them to all participants, ensuring that guests see the same tour step as the host. The service is self-contained and uses the LiveShare API's shared service pattern, making it reusable for other collaborative extensions.