Skip to content

Proposal: Expand & Improve Compose Language support #106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
colinhemmings opened this issue May 6, 2025 · 0 comments
Open

Proposal: Expand & Improve Compose Language support #106

colinhemmings opened this issue May 6, 2025 · 0 comments
Labels
enhancement New feature or request

Comments

@colinhemmings
Copy link

Problem

The current Docker Compose Language Server Protocol (LSP) implementation inside the Docker VS Code extension is incomplete and limits the developer experience:

  • Autocompletion is inconsistent or missing for many Compose attributes.
  • Validation of Compose files is minimal, catching only basic syntax errors.
  • Hover information is sparse, often only showing type hints without helpful documentation.
  • No schema-based suggestions for service options, volumes, networks, and other Compose constructs.

As a result, developers writing or editing docker-compose.yml files experience friction, higher error rates, and slower authoring compared to working with fully-supported languages or tooling.

Proposed Solution

Expand the Compose LSP support to deliver a first-class authoring experience in VS Code:

  • Rich autocompletion for all supported Compose keys, services, networks, volumes, and extensions.
  • Schema-driven validation with clear error messages and suggestions for corrections.
  • Hover documentation for keys and options explaining their purpose and usage (beyond just types).
  • Go to definition (where appropriate) for named references (like services and networks) and YAML anchors (&) and aliases (*).
  • Inline diagnostics and fix suggestions for common mistakes (e.g., typos, unsupported keys).
@colinhemmings colinhemmings added the enhancement New feature or request label May 6, 2025
@colinhemmings colinhemmings changed the title Proposal: Complete Compose Language support Proposal: Expand & Improve Compose Language support May 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant