docker
/
vscode-extension
mirror of https://github.com/docker/vscode-extension.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Document how to remove duplicated Compose YAML support 

Depending on what extensions a user has installed, they may find
themselves with duplicated code completion suggestions or hover tooltips
when editing a Compose file. Documenting how to get rid of these
duplicates will help improve our users' experience.

Signed-off-by: Remy Suen <remy.suen@docker.com>
This commit is contained in:
Remy Suen 2025-05-20 13:02:46 -04:00
parent 1dc0595427
commit e3bbfe97ef
No known key found for this signature in database
GPG Key ID: A6B90F06DB1D9658
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -78,3 +78,29 @@ Run `npm test` to launch the UI tests.
The Docker DX extension collects telemetry. We collect this telemetry so that we can improve the extension by understanding usage patterns and catching crashes and errors for diagnostic purposes. Note that if you have already opted out of sending telemetry in Visual Studio Code then no telemetry will be sent.
See [TELEMETRY.md](./TELEMETRY.md) for details about what kind of telemetry we collect and how to configure your telemetry settings.
## FAQ
> **I can see duplicated code completion suggestions and/or hover tooltips in Compose files.**
Do you have any of the following extensions installed?
- [Red Hat's YAML extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) (powered by [redhat-developer/yaml-language-server](https://github.com/redhat-developer/yaml-language-server))
1. To disable duplicates from this extension, create a JSON file with `{}` as its content and save it somewhere. Let's say it is at `/home/user/empty.json`.
2. Open the [Command Palette](https://code.visualstudio.com/api/ux-guidelines/command-palette) in Visual Studio Code and open "Preferences: Open User Settings (JSON)".
3. Create an object attribute for `yaml.schemas` if it does not already exist.
4. Inside the `yaml.schemas` object, map your empty JSON file to Compose YAML files.
```JSONC
{
"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*"]
}
}
```
- [Microsoft's Container Tools extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-containers) (powered by [microsoft/compose-language-service](https://github.com/microsoft/compose-language-service))
- If [microsoft/vscode-containers#75](https://github.com/microsoft/vscode-containers/pull/75) is merged and you are on a release with this change, then the duplicates should already be taken of.
- To disable duplicates from this extension, you can set the `containers.enableComposeLanguageService` settingto `false` and restart Visual Studio Code.
- [Microsoft's Docker extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-docker) (powered by [microsoft/compose-language-service](https://github.com/microsoft/compose-language-service))
- To disable duplicates from this extension, you can set the `docker.enableDockerComposeLanguageService` settingto `false` and restart Visual Studio Code.