[Compose LSP] Support for !reset and !override tags

[AnrDaemon]

It is rather problematic right now to validate compose files when using !reset/!override tags on certain settings or services. They are flashing red regardless of the actual issues.

[rcjsuen]

It is rather problematic right now to validate compose files when using !reset/!override tags on certain settings or services. They are flashing red regardless of the actual issues.

@AnrDaemon Thank you for your bug report.

1. Could you share a) a screenshot of your Visual Studio Code showing the "Problems" pane and b) a copy of your YAML file or a "reduced" version of it which demonstrates the error?
2. Could you run and share the output of code --list-extensions --show-versions?

[AnrDaemon]

$ vscode --list-extensions --show-versions
42crunch.vscode-openapi@4.34.0
ahmadalli.vscode-nginx-conf@0.3.5
andyyaldoo.vscode-json@1.5.2
aswinkumar863.smarty-template-support@2.1.1 
bmewburn.vscode-intelephense-client@1.14.4  
dbaeumer.vscode-eslint@3.0.10
devsense.composer-php-vscode@1.58.17223     
docker.docker@0.7.0
dotjoshjohnson.xml@2.5.1
dupeiran.diff@0.0.1
eamodio.gitlens@17.1.1
ecmel.vscode-html-css@2.0.13
editorconfig.editorconfig@0.17.2
firefox-devtools.vscode-firefox-debug@2.15.0
github.vscode-pull-request-github@0.110.0   
gruntfuggly.todo-tree@0.0.226
jeff-hykin.better-shellscript-syntax@1.10.0 
johnstoncode.svn-scm@2.17.0
kelvin.vscode-sshfs@1.26.1
mads-hartmann.bash-ide-vscode@1.43.0        
mrthomas20121.zenscript@1.0.3
ms-azuretools.vscode-docker@1.29.6
ms-dotnettools.vscode-dotnet-runtime@2.3.3
ms-vscode-remote.remote-ssh@0.120.0
ms-vscode-remote.remote-ssh-edit@0.87.0
ms-vscode.hexeditor@1.11.1
ms-vscode.makefile-tools@0.12.17
ms-vscode.powershell@2025.0.0
ms-vscode.remote-explorer@0.5.0
mtxr.sqltools@0.28.4
mtxr.sqltools-driver-mysql@0.6.4
mtxr.sqltools-driver-pg@0.5.5
mtxr.sqltools-driver-sqlite@0.5.2
neilbrayfield.php-docblocker@2.7.0
oracle.sql-developer@25.1.1
rashwell.tcl@0.1.0
redhat.java@1.42.0
redhat.vscode-xml@0.29.0
redhat.vscode-yaml@1.18.0
ritwickdey.liveserver@5.7.9
solnurkarim.html-to-css-autocompletion@1.1.2
sumneko.lua@3.14.0
timonwong.shellcheck@0.37.7
vscjava.vscode-gradle@3.16.4
vscjava.vscode-java-debug@0.58.2
vscjava.vscode-java-dependency@0.24.1
vscjava.vscode-java-test@0.43.1
vscjava.vscode-maven@0.44.0
wisetime.branch-in-window-title@0.2.0
xdebug.php-debug@1.36.1
yesterday17.zenscript@0.2.10
yy0931.gitconfig-lsp@0.10.2

An example compose file could be like this:
Main docker-compose.yml

services:

  nginx:
    image: nginx:invapi
    build:
      dockerfile: ./build/nginx/Dockerfile
      args:
        RELEASE_VERSION: "dev-release"
        ENV: "develop"
        CONF: "dev.conf"
      context: .
      network: host
      target: INVAPI
    ports:
      - '80:80'
      - '443:443'
    volumes:
      - ./build/nginx/nginx.conf:/etc/nginx/nginx.conf
      - ./build/nginx/invapi.conf:/etc/nginx/conf.d/default.conf
      - ./build/nginx/configs/config_dev.js:/opt/app/app/panel/config.js
    restart: unless-stopped

An override docker-compose.override.yml

services:
  nginx:
    ports: !override
      - '127.0.0.1:8080:80'
    build:
      args:
        RELEASE_VERSION: dev
        ENV: dev
        CONF: stage.conf
    volumes:
      - "./app:/opt/app/app"
      - "./build/nginx/config.js:/opt/app/app/panel/config.js"

The diagnostic related:

[{
	"resource": "/d:/Profiles/anrdaemon/Documents/hk/invapi-php/docker-compose.override.yml",
	"owner": "_generated_diagnostic_collection_name_#8",
	"severity": 8,
	"message": "Unresolved tag: !override",
	"source": "YAML",
	"startLineNumber": 3,
	"startColumn": 12,
	"endLineNumber": 3,
	"endColumn": 22
}]

[rcjsuen]

@AnrDaemon Thank you for your detailed information!

As you can see from your errors, the source is YAML. This means the error is coming from Red Hat's YAML extension.

Could you try disabling the extension and restarting Visual Studio Code? Do the errors go away?

[AnrDaemon]

Of course it is coming from YAML.
I though you are writing your extension on top of it, being the most popular YAML LSP in the world.

[rcjsuen]

Of course it is coming from YAML. I though you are writing your extension on top of it, being the most popular YAML LSP in the world.

@AnrDaemon Sorry, maybe there is a misunderstanding so let me try and clarify a few things.

1. The Docker DX extension (this repository) does not bundle the Red Hat's YAML language server.
2. The errors, as you understand, are coming from Red Hat's YAML extension. They are not being reported from the Docker DX extension.
3. We have not contributed any specific bug fixes and/or features for Compose to Red Hat's YAML language server or to their Visual Studio Code extension.
4. The Docker DX extension bundles the Docker Language Server from the docker/docker-language-server repository. That language server is:
   1. written in Go
   2. provides its own set of features for Compose YAML
   3. does not call/reference any of the TypeScript code in Red Hat's YAML language server, and as it is written in Go is not a fork of Red Hat's YAML language server or anything of that sort

We are currently actively improving Compose support in the Docker Language Server (see #106) and will be including that in a future update of the Docker DX extension.

Please do not hesitate to let me know if anything is still unclear.

[AnrDaemon]

No, it is perfectly clear that I will have reduced functionality either way. Same as Kotlin/Gradle.

[rcjsuen]

No, it is perfectly clear that I will have reduced functionality either way. Same as Kotlin/Gradle.

Sorry, I am not sure what you mean by this.

In terms of the experience in Visual Studio Code, the Docker Language Server and the Docker DX extension will provide feature parity with Red Hat's YAML extension with the exception of schema validation. On top of the feature parity, we will provide other features such as

1. reference resolution so you can hover and view the reference's YAML content
2. code completion for service/network/volume/config/secret names
3. proper highlighting and code navigation of references

Although you are correct that you will have reduced functionality in the current release of the Docker DX extension, a future update that brings the latest changes from the Docker Language Server into this extension should get you the same experience (and more) for Compose files when compared to Red Hat's YAML extension.

[rcjsuen]

@AnrDaemon We have released 0.8.0 of the Docker DX extension which includes the aforementioned Compose features. If you'd like to try it out, please follow the steps outlined in the FAQ to a) disable Compose features from Red Hat's YAML extension and b) enable the features from the Docker DX extension.

[AnrDaemon]

You don't understand, what I mean? What about this?

[Window Title]
Visual Studio Code

[Content]
There is no formatter for 'dockercompose' files installed.

[Install Formatter...] [Cancel]

However, the YAML formatter from redhat is readily available…

The FAQ doesn't help, the DockerDX LSP turns itself off at the start.

[rcjsuen]

There is no formatter for 'dockercompose' files installed.

For this particular error, that is coming from Red Hat's YAML extension and is tracked by redhat-developer/vscode-yaml#1000 which has a pull request opened (redhat-developer/vscode-yaml#1126) to hopefully address it in the near future.

The FAQ doesn't help, the DockerDX LSP turns itself off at the start.

@AnrDaemon Yes, you are right that the Docker LSP turns itself off at the start. However, the FAQ mentions how to disable Red Hat's YAML extension for Compose files and how to explicitly re-enable the Docker DX LSP. Did you try using the provided snippet in your settings.json file?

{
  // this must be explicitly set to true in your settings.json file or
  // the auto-deduplication logic will programmatically set the value to
  // false if it detects that Red Hat's YAML extension is installed
  "docker.extension.enableComposeLanguageServer": true,
  "yaml.schemas": {
    // this tells Red Hat's YAML extension to consider Compose YAML
    // files as not having a schema so it will stop suggesting code
    // completion items, hover tooltips, and so on
    "/home/user/empty.json": ["compose*y*ml", "docker-compose*y*ml"]
  }
}