implement workbench: startup editor preference #12813
Merged
Conversation
This file contains 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
msujew
reviewed
Aug 17, 2023
packages/getting-started/src/browser/getting-started-contribution.ts
Outdated
Show resolved
Hide resolved
packages/getting-started/src/browser/getting-started-contribution.ts
Outdated
Show resolved
Hide resolved
packages/getting-started/src/browser/getting-started-contribution.ts
Outdated
Show resolved
Hide resolved
msujew
approved these changes
Aug 18, 2023
|
@vince-fugnitto Do you want to merge this? |
Not yet, I'm still performing an offline review with @vladarama about the changes. |
packages/getting-started/src/browser/getting-started-contribution.ts
Outdated
Show resolved
Hide resolved
packages/getting-started/src/browser/getting-started-contribution.ts
Outdated
Show resolved
Hide resolved
packages/getting-started/src/browser/getting-started-contribution.ts
Outdated
Show resolved
Hide resolved
packages/getting-started/src/browser/getting-started-contribution.ts
Outdated
Show resolved
Hide resolved
packages/getting-started/src/browser/getting-started-preferences.ts
Outdated
Show resolved
Hide resolved
packages/getting-started/src/browser/getting-started-contribution.ts
Outdated
Show resolved
Hide resolved
This commit introduces 5 new startup editor preferences: - none: no editor will be shown on startup - welcomePage: the default welcome page will be shown on startup - readme: it will open the folder's readme in preview mode - newUntitledFile: opens an untitled file on startup - welcomePageInEmptyWorkbench: only opens the welcome page when opening empty workbench
This commit aims to address and fix various comments received on the PR: - This includes waiting for the `preferenceService` and the `workspaceService` to be ready before actually using them. - It also includes a minor refactoring of the `openReadme` method to avoid the conversion from URI -> string -> URI. Signed-Off-By: Vlad Arama <vlad.arama@ericsson.com>
This commit removes the `alwaysShowWelcomePage` preference to allow the checkbox to toggle between the `welcomePage` (checked) and `none` (unchecked) states. This is the behavior currently present in vscode. Signed-off-by: Vlad Arama <vlad.arama@ericsson.com>
This commit addresses a few comments: - Move preferences from `@theia/core` to `@theia/getting-started` - Simplify `newUntitledFile` code to reuse the command Signed-off-by: Vlad Arama <vlad.arama@ericsson.com>
This commit addresses review comments by doing the following: - Remove unused injections - Use `NEW_UNTITLED_TEXT_FILE` instead of `NEW_UNTITLED_FILE` - Fix typos and align preference id with VS Code Signed-off-by: Vlad Arama <vlad.arama@ericsson.com>
vladarama
force-pushed
the
startup-editor-preference
branch
from
5befee0 to
c5ae16d
Compare
vince-fugnitto
approved these changes
Aug 23, 2023
There was a problem hiding this comment.
LGTM 👍 I confirmed the following workbench.startupEditor:
| Preference | Use-Case | Result |
|---|---|---|
welcomePage |
no editors present | the welcome page is opened on startup |
welcomePage |
no editors present (no workspace) | the welcome page is opened on startup |
welcomePage |
editors present | the welcome page is not opened on startup |
none |
all cases | nothing happens on startup besides restoring past views |
newUntitledFile |
no editors present | an untitled text file is opened on startup |
newUntitledFile |
no editors present (no workspace) | an untitled text file is opened on startup |
newUntitledFile |
editors present | no untitled file is opened on startup |
readme |
no editors present | the readme is opened on startup |
readme |
no editors present, no readme present in the workspace | the welcome page is opened as a fallback on startup |
readme |
no editors present (no workspace) | the welcome page is opened as a fallback on startup |
readme |
editors present | no readme is opened on startup |
welcomePageInEmptyWorkbench |
workspace present | no welcome page is opened on startup |
welcomePageInEmptyWorkbench |
no workspace present | the welcome page is opened on startup |
1 task
This was referenced Nov 27, 2023
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.
What it does
Fixes: #12754
This PR implements the workbench: startup editor preference. This allows the user to choose which editor is shown on startup when none are restored from the previous session.
Implemented preferences:
none: no editor will be shown on startup.welcomePage: the default welcome page will be shown on startup.readme: it will open the folder's readme file in preview mode.newUntitledFile: opens an untitled file on startup.welcomePageInEmptyWorkbench: only opens the welcome page when openingempty workbench.
How to test
Settings->workbench: startup editorand select one of the preference to test.Review checklist
Reminder for reviewers