microsoft / microsoft/vscode-docs

Document how declarative language feature contributions from different sources are merged

Open
#4,677 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

doc-bug
Dominant language
Markdown
Stars
6.6k
Forks
5.8k
Avg merge
11h 43m
Merged PRs (30d)
123

Description

The documentation currently shows that extensions can define basic editing support (declarative language feature) in various aspects.

However, when multiple extensions with overlapping contributions are enabled at the same time, what will happen?


This is a real world headache, confusing both extension authors and end users.

For example, vscode.yaml and redhat.vscode-yaml both define

  • Language definition and configuration (languages and API)

  • TM grammar (grammars)

  • Default editor configuration (configurationDefaults)

for language yaml.

Please clearly document how to deduce the outcome.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the existing VS Code documentation on declarative language features and compare the linked vscode.yaml and redhat.vscode-yaml contributions. Document how overlapping languages, grammars, configurationDefaults, and API contributions are merged when both extensions are enabled. Done means extension authors and users can determine the resulting behavior for each listed contribution.

Written by the indexing model from the issue text.

Assessment

Tech stack
vscode
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.