Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Adding a New Ecosystem

This chapter walks through adding support for a new package ecosystem (e.g., a language or build tool not yet covered) to deps-lsp, from an empty crate to a registered, tested implementation. It assumes familiarity with the Architecture Overview — in particular the Ecosystem trait, Registry, and EcosystemFormatter.

Read the steps in order; each builds on artifacts (types, error variants) created in an earlier one:

  1. Create the Crate
  2. Handle Errors
  3. Define Types
  4. Implement the Parser
  5. Implement the Registry Client
  6. Implement the Ecosystem Trait
  7. Implement the Lock File Provider
  8. Implement the Formatter
  9. Create lib.rs
  10. Register the Ecosystem
  11. Add Tests

Once implemented, work through the Checklist before opening a PR. See Reference Implementations for existing crates to study, and Templates for a scaffold to start from. Key API Contracts documents conventions (no async_trait, position tracking, LockFileProvider signatures, registry client method naming) that apply across every step above.