Add intellisense for docker compose files

[bwateratmsft]

Creating this umbrella issue since there are a bunch of different things that basically boil down to creating a language server + intellisense + etc. for compose files.

• Linting support (Compose schema validation) (Idea: Linting support for docker-compose.yml files compose-language-service#84)
• Volume pathing intellisense (Idea: IntelliSense for selecting the correct file path in Volumes in Compose compose-language-service#85)
• Snippets for some well-known services (postgres, redis, etc.), including common ports (Idea: Snippets for some well-known services (postgres, redis, etc.), including common ports compose-language-service#86)
• Image autocomplete suggestions (Idea: Image autocomplete suggestions compose-language-service#87)
• Port snippets (Improve port snippets and detecting already in use/restricted ports  #2535)
• Autocompletions for subsequent parts--e.g., when typing 're', complete to 'restart:', then suggest 'always' and other valid suggestions (More suggestions like restart: ... #2713)
• Linting support (YAML validation) (#37)
• Volume snippets (#2536)
• URL click behavior for base images (Add url behaviour at docker-compose image string as Dockerfile #2200)
• Auto format indentation on save/while typing (Autoformat file on save #2714)
• Updated icon theme: update https://github.com/microsoft/vscode/blob/main/extensions/theme-seti/icons/vs-seti-icon-theme.json (so all compose files can get pink whale that currently only appears for docker-compose.yml and docker-compose.override.yml) (microsoft/vscode@5541826) (should be available in VSCode 1.61.0)
• Syntax highlighting
• Language ID for file.associations (Add a docker-compose Language ID so it can be assigned via file.associations (or manually) #206) (Add a compose language vscode#118042)
• Defining a language with more specific file names would help with spurious activations. onLanguage:yaml accounts for about 60% of all our activations; I'm sure many (or most) of those are not actually docker-compose files

Maybe/currently not possible:

• Semantic highlighting (I can't think of a use case)
• Change the file picking logic to be better and language-based (I don't think currently possible)
• Port-in-use intellisense (Gross, port scanning)

Other:

• docker-stack.yml (IntelliSense and file association for docker-stack.yml #520)

Update: as of 2 Aug 21, about 33% of activations are due to Dockerfiles being opened, now about 25% are due to Docker Compose files being opened, with most of the balance being task runs and the Docker Explorer. This is down from 60% YAML, 30% Dockerfile, 10% others. This is a big improvement; by narrowing to activating for Compose documents only, the activations for Compose/YAML are way lower--this means far less spurious activation.

[ucheNkadiCode]

Other Notes & Ideas:
Adding a "well known" service to a compose file through a snippet. (Redis, postgres)
Warnings for incorrect indentation levels of a service or attributes (e.g "attribute dockerfile does not exist at this hierarchy)
Warnings for incorrect file paths or files that don't exist in the context of the project - mainly applies to context attribute and volume attribute
Warnings for misspelled sections (if you misspell volumes, ports, environment etc, there are no warnings)

Feb 11th Edit (per our meeting discussions):
We have at least a few sections we want to tackle early on for creating tab completions. A few of them are listed below:

• env
• env_file
• build
• depends_on
• labels

[thernstig]

@bwateratmsft should the docker-stack.yml be scrapped?

According to https://github.com/compose-spec/compose-spec/blob/master/spec.md#compose-file and https://docs.docker.com/compose/compose-file/ - the latest specs says a file should be named compose.yaml it says:

The default path for a Compose file is compose.yaml (preferred) or compose.yml in working directory. Compose implementations SHOULD also support docker-compose.yaml and docker-compose.yml for backward compatibility.

I also noticed now that when I renamed my file to compose.yaml it does not get the "red Moby Dick icon" but rather a normal .yaml icon.

[bwateratmsft]

@bwateratmsft should the docker-stack.yml be scrapped?

Yeah, probably. 😄

According to https://github.com/compose-spec/compose-spec/blob/master/spec.md#compose-file and https://docs.docker.com/compose/compose-file/ - the latest specs says a file should be named compose.yaml it says:

The default path for a Compose file is compose.yaml (preferred) or compose.yml in working directory. Compose implementations SHOULD also support docker-compose.yaml and docker-compose.yml for backward compatibility.

I also noticed now that when I renamed my file to compose.yaml it does not get the "red Moby Dick icon" but rather a normal .yaml icon.

I had not noticed this change, thank you for bringing it to our attention! I'm going to make a separate work item (#2618) to cover that for the time being. It is more urgent that we get that fix in place than that we create a compose language server.

[bwateratmsft]

We will be able to do this incrementally which is good. The minimum viable product would include a language ID being defined, and syntax highlighting to support it. This would have the side benefit of reducing spurious activations for non-compose YAML files.

[rcjsuen]

@bwateratmsft Is the plan to implement this with VS Code APIs or as a language server? 🤔

[bwateratmsft]

Most likely a language server since I assume a lot of these features would require that. We also want to take the same language server and run it in VS--not just VSCode--which is a thing now, or so I'm told. 😄

[bwateratmsft]

Might get a language ID from VSCode itself: microsoft/vscode#118042

[bwateratmsft]

The pink whale icon has been extended to all dockercompose documents via microsoft/vscode@5541826. This should be available in VSCode 1.60 or maybe 1.61.

[bwateratmsft]

Moving milestone to 1.19.0 as we have completed what we wanted to in 1.18.0.

[bwateratmsft]

Rather than continually moving this a milestone at a time, I'm going to make sure issues exist for each of the remaining tasks in https://github.com/microsoft/compose-language-service, and close this one.

[thernstig]

@bwateratmsft the original post in this thread already contains existing issues. Just open them up again?

[bwateratmsft]

Yeah, that's a better idea. I'll do that and transfer them to the other repo.