Skip to content

Repository files navigation

VS Code Engineering Playbook

Practical engineering lessons from microsoft/vscode: faster feedback, explicit boundaries, and failures that are easier to diagnose.

Start with the adoption overview, then follow the source index from a claim to its implementation. The deep dives are reference material, not prerequisites for reading the overview.

Current source baseline: the seven-pass refresh dated 2026-09-07 covers all six topics below using VS Code 17c5935, package 1.138.0 (development snapshot, committed 2026-09-06). The source map records the specific implementations reviewed, not a blanket re-audit of every historical example.

Older evidence is preserved. The 98-file August catalog, eight detailed runtime walkthroughs, and audit history remain pinned to 7234ef0. Read each citation's commit and excerpt notes; old counts are not current counts.

📚 Contents

Document Description
PLAYBOOK.md Start here: choose an adoption phase and a small first change
SOURCES.md Current implementation map, limitations, and the preserved historical catalog
ANALYSIS.md Technical explanations, source excerpts, and runtime walkthroughs
PLAYBOOK-PHASE-1-2.md Foundations and test infrastructure: configurations, adaptations, and caveats
PLAYBOOK-PHASE-3-4.md Architecture and advanced patterns: DI, import rules, and workflow examples
Example guide File-by-file prerequisites, intended use, and limitations
VALIDATION.md Audit history and the separate September seven-run record

🎯 Six Engineering Dimensions

Dimension Start with the real implementation
🧪 Faster tests Runner scheduling, in-memory fixtures, and scoped leak checks
🔍 Stricter linters 49 registered local rules, fatal warnings, and separate compiler surfaces
📐 Deterministic formatting Core TypeScript formatter, normalized comparison, and the Prettier exception
🔄 Better CI feedback 21 top-level jobs, cache correctness and visual feedback
📦 Smaller units of work Import direction, DI semantics, and contribution entrypoints
🛡️ Runtime self-defence Attributable failures, bounded diagnostics, and cancellation ownership

⚡ Quick Start

Evidence is not a drop-in configuration. VS Code's core unit harnesses use Mocha; Vitest examples here are adoption alternatives. A Prettier recipe likewise does not describe the core VS Code formatter. Match snippets to your installed dependencies and runtime before copying them.

Examples are independent illustrations, not one installable application. Week ranges in the overview are suggested sequencing, not delivery estimates.

Pick your phase based on project maturity:

Phase For Guide
Phase 1: Foundations New/small projects Quick ref · Deep dive
Phase 2: Test Infrastructure Growing projects Quick ref · Deep dive
Phase 3: Architecture Large codebases Quick ref · Deep dive
Phase 4: Advanced At-scale engineering Quick ref · Deep dive

Audit history

Original authoring and August audit methodology

Original pass (2026-04-09)

  • 6 parallel AI agents (Claude Opus 4.6 + GPT-5.4) performed deep repository exploration
  • 300+ GitHub API calls examining CI configs, custom lint rules, test harnesses, build scripts, and architecture docs
  • 50+ VS Code source files directly referenced with exact file paths and code excerpts

Validation pass (2026-08-01)

  • Re-checked against a local clone of microsoft/vscode at 7234ef0 — ground truth, not API snapshots
  • Claude Opus 5 and GPT-5.6 Sol, both at max reasoning effort, audited the corpus in parallel
  • Every claim classified CONFIRMED / IMPRECISE / STALE / WRONG; sample code compiled and linted with real toolchains
  • All corrections and their evidence are recorded in VALIDATION.md

The September record documents the newer source reads and targeted reproductions separately. It does not claim a repeat of the earlier full-repository, dual-reviewer audit.

License

MIT — Use these patterns freely in your projects.

About

Deep analysis of microsoft/vscode engineering practices + phased adoption playbook for faster tests, stricter linters, deterministic formatting, better CI, and smaller units of work

Resources

Stars

3 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors