Document VS Code Selfhost Import Aid extension#312455
Open
joshka wants to merge 1 commit intomicrosoft:mainfrom
Open
Document VS Code Selfhost Import Aid extension#312455joshka wants to merge 1 commit intomicrosoft:mainfrom
joshka wants to merge 1 commit intomicrosoft:mainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds end-user documentation and richer marketplace metadata for the ms-vscode.vscode-selfhost-import-aid selfhost extension so contributors can understand why it’s recommended in the VS Code repo and what it does.
Changes:
- Expanded the extension manifest metadata (description, keywords, banner, workspace kind, workspace capabilities, links).
- Added a README describing features, activation, workspace requirements, and issue filing location.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
.vscode/extensions/vscode-selfhost-import-aid/package.json |
Adds manifest metadata to improve the extension details / marketplace presentation and declare workspace constraints. |
.vscode/extensions/vscode-selfhost-import-aid/README.md |
Introduces a README documenting purpose, features, activation, workspace support, and issues location. |
Add contributor-facing documentation and extension metadata for the VS Code selfhost import helper so recommendations explain why the extension is useful in the workspace.
joshka
force-pushed
the
joshka/document-selfhost-import-aid
branch
from
f3e54d7 to
4615baa
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
requirements, and issue location.
src/vsTypeScriptfiles.
Motivation
This follows the same motivation as #312452. I wanted to understand why VS Code was recommending a
random selfhost extension, but the extension details page did not explain what it does or why it is
useful in the workspace recommendations. This PR documents
ms-vscode.vscode-selfhost-import-aidso contributors can understand the recommendation from the extension details page.
AI disclosure
The descriptive README text and package metadata descriptions in this PR were generated with AI
assistance and reviewed before publication.
Validation
npm installin.vscode/extensions/vscode-selfhost-import-aidnode -e "JSON.parse(require('fs').readFileSync('.vscode/extensions/vscode-selfhost-import-aid/package.json','utf8')); console.log('package.json ok')"npx markdownlint-cli2 .vscode/extensions/vscode-selfhost-import-aid/README.mdnpx @vscode/vsce lsnpm run compilein.vscode/extensions/vscode-selfhost-import-aidnpm testcould not run because this extension does not define atestscript.