feat: add coderm.workbench.openReadme command#227
Merged
Conversation
Add a command that opens the workspace root's README.md (first workspace folder), falling back to the upstream workbench.action.files.newUntitledFile command when README.md is absent or no workspace folder is open. Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
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
Adds a new Coderm command
coderm.workbench.openReadme("Open README") that opens the workspace root'sREADME.md(first workspace folder) on a best-effort basis. IfREADME.mdis absent or no workspace folder is open, it falls back to the upstreamworkbench.action.files.newUntitledFilecommand.Behavior
README.mdpresent in the first workspace folder → opens it (pinned tab)README.mdabsent, or empty workspace (no folders) → runsworkbench.action.files.newUntitledFile(new untitled file)Files
src/vs/workbench/contrib/coderm/browser/openReadme.ts(new) —Action2+registerAction2src/vs/workbench/contrib/coderm/browser/coderm.contribution.ts— side-effect importREADME.md/README.ja.md— command table entryThe fallback delegates to the upstream
newUntitledFilecommand viaICommandService.executeCommand(NEW_UNTITLED_FILE_COMMAND_ID)rather than re-implementing it, so upstream behavior changes are tracked for free.Follows Coderm conventions: command lives under
contrib/coderm/browser/, no default keybinding (users assign their own, like other Coderm commands).Related to #105 — this adds a manual command variant. #105 additionally asks for automatic open on startup when no editor pane exists (not covered here).
Checklist
gulp compile, 0 errors)README.md/README.ja.mdsynced