Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Split welcome walkthrough #395

Merged
merged 4 commits into from
Apr 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,15 +162,15 @@ Additionally, several packages that include the VSCode version of some services
- **Preferences**: `@codingame/monaco-vscode-preferences-service-override`
- Allow to read and write preferences
- **Output**: `@codingame/monaco-vscode-output-service-override`
- Output panel support. *Hint*: It only makes sense to enable it when *Views* service is used.
- Output panel support. *Hint*: It only makes sense to enable it when *Views* or *Workbench* service are used.
- **Terminal**: `@codingame/monaco-vscode-terminal-service-override`
- Terminal panel support. *Hint*: It only makes sense to enable it when *Views* service is used.
- Terminal panel support. *Hint*: It only makes sense to enable it when *Views* or *Workbench* service are used.
- **Search**: `@codingame/monaco-vscode-search-service-override`
- search panel support. *Hint*: It only makes sense to enable it when *Views* service is used.
- search panel support. *Hint*: It only makes sense to enable it when *Views* or *Workbench* service are used.
- **Markers**: `@codingame/monaco-vscode-markers-service-override`
- It adds the problems panel tab. *Hint*: It only makes sense to enable it when *Views* service is used.
- It adds the problems panel tab. *Hint*: It only makes sense to enable it when *Views* or *Workbench* service are used.
- **SCM**: `@codingame/monaco-vscode-scm-service-override`
- It adds the SCM API that can be used to implement source control. *Hint*: It only makes sense to enable it when *Views* service is used.
- It adds the SCM API that can be used to implement source control. *Hint*: It only makes sense to enable it when *Views* or *Workbench* service are used.
- **Testing**: `@codingame/monaco-vscode-testing-service-override`
- It adds the Tests API. *Hint*: It makes more sense to enable it when *Views* service is used.
- **Language detection worker**: `@codingame/monaco-vscode-language-detection-worker-service-override`
Expand Down Expand Up @@ -201,17 +201,19 @@ Additionally, several packages that include the VSCode version of some services
- **Notebook**: `@codingame/monaco-vscode-notebook-service-override`
- Support for Jupyter notebooks
- **Welcome**: `@codingame/monaco-vscode-welcome-service-override`
- Support for welcome pages/components. *Hint*: It only makes sense to enable it when *Views* service is used.
- Support for [viewsWelcome contribution point](https://code.visualstudio.com/api/references/contribution-points#contributes.viewsWelcome). *Hint*: It only makes sense to enable it when *Views* or *Workbench* service are used.
- **Walkthrough**: `@codingame/monaco-vscode-walkthrough-service-override`
- Getting Started page and support for [walkthrough contribution point](https://code.visualstudio.com/api/references/contribution-points#contributes.walkthroughs). *Hint*: It only makes sense to enable it when *Views* or *Workbench* service are used.
- **User data sync**: `@codingame/monaco-vscode-user-data-sync-service-override`
- Support for user data sync. ⚠️ It can't really be used as it relies on a [closed source backend from microsoft](https://code.visualstudio.com/docs/editor/settings-sync#_can-i-use-a-different-backend-or-service-for-settings-sync) for the moment ⚠️
- **Ai**: `@codingame/monaco-vscode-ai-service-override`
- Ai support for the ai extension api (RelatedInformation/EmbeddingVector)
- **Task**: `@codingame/monaco-vscode-task-service-override`
- Task management
- **Outline**: `@codingame/monaco-vscode-outline-service-override`
- Support for the outline view. *Hint*: It only makes sense to enable it when *Views* service is used.
- Support for the outline view. *Hint*: It only makes sense to enable it when *Views* or *Workbench* service are used.
- **Timeline**: `@codingame/monaco-vscode-timeline-service-override`
- Support for the timeline view. *Hint*: It only makes sense to enable it when *Views* service is used.
- Support for the timeline view. *Hint*: It only makes sense to enable it when *Views* or *Workbench* service are used.
- **Workbench**: `@codingame/monaco-vscode-workbench-service-override`
- Allows to render the full workbench layout. Is exclusive with the `views` service. Do not use both services at the same time.
- **Comments**
Expand Down
29 changes: 17 additions & 12 deletions demo/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions demo/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,7 @@
"@codingame/monaco-vscode-view-title-bar-service-override": "file:../dist/service-override-view-title-bar",
"@codingame/monaco-vscode-views-service-override": "file:../dist/service-override-views",
"@codingame/monaco-vscode-welcome-service-override": "file:../dist/service-override-welcome",
"@codingame/monaco-vscode-walkthrough-service-override": "file:../dist/service-override-walkthrough",
"@codingame/monaco-vscode-workbench-service-override": "file:../dist/service-override-workbench",
"@codingame/monaco-vscode-working-copy-service-override": "file:../dist/service-override-working-copy",
"@codingame/monaco-vscode-workspace-trust-service-override": "file:../dist/service-override-workspace-trust",
Expand Down
2 changes: 2 additions & 0 deletions demo/src/setup.common.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ import getTestingServiceOverride from '@codingame/monaco-vscode-testing-service-
import getChatServiceOverride from '@codingame/monaco-vscode-chat-service-override'
import getNotebookServiceOverride from '@codingame/monaco-vscode-notebook-service-override'
import getWelcomeServiceOverride from '@codingame/monaco-vscode-welcome-service-override'
import getWalkThroughServiceOverride from '@codingame/monaco-vscode-walkthrough-service-override'
import getUserDataSyncServiceOverride from '@codingame/monaco-vscode-user-data-sync-service-override'
import getAiServiceOverride from '@codingame/monaco-vscode-ai-service-override'
import getTaskServiceOverride from '@codingame/monaco-vscode-task-service-override'
Expand Down Expand Up @@ -311,6 +312,7 @@ export const commonServices: IEditorOverrideServices = {
...getChatServiceOverride(),
...getNotebookServiceOverride(),
...getWelcomeServiceOverride(),
...getWalkThroughServiceOverride(),
...getUserDataSyncServiceOverride(),
...getAiServiceOverride(),
...getTaskServiceOverride(),
Expand Down
22 changes: 22 additions & 0 deletions src/service-override/walkthrough.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import { IEditorOverrideServices } from 'vs/editor/standalone/browser/standaloneServices'
import { SyncDescriptor } from 'vs/platform/instantiation/common/descriptors'
import { IWalkthroughsService, WalkthroughsService } from 'vs/workbench/contrib/welcomeGettingStarted/browser/gettingStartedService'
import 'vs/workbench/contrib/welcomeGettingStarted/browser/gettingStarted.contribution'
import 'vs/workbench/contrib/welcomeWalkthrough/browser/walkThrough.contribution'
import svgAssets from 'vs/workbench/contrib/welcomeGettingStarted/common/media/*.svg'
import pngAssets from 'vs/workbench/contrib/welcomeGettingStarted/common/media/*.png'
import { FileAccess } from 'vs/base/common/network'
import { registerAssets } from '../assets'

registerAssets(svgAssets)
registerAssets(pngAssets)

FileAccess.registerModuleContentProvider('vs/workbench/contrib/welcomeWalkthrough/browser/editor/vs_code_editor_walkthrough', () => import('vs/workbench/contrib/welcomeWalkthrough/browser/editor/vs_code_editor_walkthrough'))
FileAccess.registerModuleContentProvider('vs/workbench/contrib/welcomeGettingStarted/common/media/theme_picker', () => import('vs/workbench/contrib/welcomeGettingStarted/common/media/theme_picker'))
FileAccess.registerModuleContentProvider('vs/workbench/contrib/welcomeGettingStarted/common/media/notebookProfile', () => import('vs/workbench/contrib/welcomeGettingStarted/common/media/notebookProfile'))

export default function getServiceOverride (): IEditorOverrideServices {
return {
[IWalkthroughsService.toString()]: new SyncDescriptor(WalkthroughsService, [], true)
}
}
16 changes: 0 additions & 16 deletions src/service-override/welcome.ts
Original file line number Diff line number Diff line change
@@ -1,24 +1,8 @@
import { IEditorOverrideServices } from 'vs/editor/standalone/browser/standaloneServices'
import { SyncDescriptor } from 'vs/platform/instantiation/common/descriptors'
import { IWalkthroughsService, WalkthroughsService } from 'vs/workbench/contrib/welcomeGettingStarted/browser/gettingStartedService'
import 'vs/workbench/contrib/welcomeGettingStarted/browser/gettingStarted.contribution'
import 'vs/workbench/contrib/welcomeWalkthrough/browser/walkThrough.contribution'
import 'vs/workbench/contrib/welcomeViews/common/viewsWelcome.contribution'
import 'vs/workbench/contrib/welcomeViews/common/newFile.contribution'
import svgAssets from 'vs/workbench/contrib/welcomeGettingStarted/common/media/*.svg'
import pngAssets from 'vs/workbench/contrib/welcomeGettingStarted/common/media/*.png'
import { FileAccess } from 'vs/base/common/network'
import { registerAssets } from '../assets'

registerAssets(svgAssets)
registerAssets(pngAssets)

FileAccess.registerModuleContentProvider('vs/workbench/contrib/welcomeWalkthrough/browser/editor/vs_code_editor_walkthrough', () => import('vs/workbench/contrib/welcomeWalkthrough/browser/editor/vs_code_editor_walkthrough'))
FileAccess.registerModuleContentProvider('vs/workbench/contrib/welcomeGettingStarted/common/media/theme_picker', () => import('vs/workbench/contrib/welcomeGettingStarted/common/media/theme_picker'))
FileAccess.registerModuleContentProvider('vs/workbench/contrib/welcomeGettingStarted/common/media/notebookProfile', () => import('vs/workbench/contrib/welcomeGettingStarted/common/media/notebookProfile'))

export default function getServiceOverride (): IEditorOverrideServices {
return {
[IWalkthroughsService.toString()]: new SyncDescriptor(WalkthroughsService, [], true)
}
}
Loading