Skip to content

Commit cedf68e

Browse files
committed
Futher service description updates
1 parent daafb9e commit cedf68e

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -123,25 +123,29 @@ await initialize({
123123
Additionally, this library exposes 23 modules that include the vscode version of some services (with some glue to make it work with monaco):
124124

125125
- **Extensions** (included by default): `vscode/service-override/extensions`
126-
- Support for VSCode extensions.
126+
- Support for VSCode extensions. A worker configuration can be past to it:
127+
- Then, everything runs in one worker, where extensions run in an iframe, with all the implications (can be created by the bundler directly). The worker script is expected to be hosted on a separate domain.
127128
- **Files** (included by default): `vscode/service-override/files`
128-
- It adds the memory filesystem for `file://` files, but also adds the support for lazy loaded extension files, separate memory user files (e.g. config, keybindings), cache, logs, etc.
129+
- It adds the memory filesystem for `file://` files, but also adds the support for lazy loaded extension files. It adds separate memory user files (e.g. config, keybindings), cache files and log files.
129130
- **QuickAccess** (included by default): `vscode/service-override/quickaccess`
130-
- Enables the quickaccess menu in the editor
131+
- Enables the quickaccess menu in the editor (press F1)
131132
- **Notifications**: `vscode/service-override/notifications`
132-
- This services enables vscode notifications (in the bottom right corner)
133+
- This services enables vscode notifications you usually find in the bottom right corner.
133134
- **Dialogs**: `vscode/service-override/dialogs`
134-
- Enable vscode modal dialogs. They allow users to select an action to perform which are exposed to the vscode API. Additionally, this can be used by the language client to ask questions to the user?
135+
- Enable vscode modal dialogs. It allows users to select actions to perform and exposed them the vscode API. Additionally, this service can be used by the language client to delegate questions to the user.
135136
- **Model**: `vscode/service-override/model`
136-
- This service creates and takes care of model references (e.g. create model if unknown, count references and destroy model when not used anymore)
137+
- This service creates and takes care of model references. For example:
138+
- Create model if content is unknown
139+
- Count references
140+
- Destroy models when they are no lonbger used
137141
- **Editor**: `vscode/service-override/editor`
138-
- Enable editor support. This is usually not needed when working without LSP. Without enabling the editor service, it will only be able to resolve the currently open model, so only internal file links will work.
142+
- Enable editor support. This is usually needed when working with the language server protocol. Without enabling the editor service, it will only be able to resolve the currently open model (only internal file links will work).
139143
- **Views**: `vscode/service-override/views`
140-
- Enable full views support. Is exclusive with `editor`, do not use both at the same time.
144+
- Enable full views support. Is exclusive with the `editor` service. Do not use both services at the same time.
141145
- **Configuration**: `vscode/service-override/configuration`
142146
- Allows to change the configuration of not only the editors, but every part of vscode. The language client for instance uses it to send the requested configuration to the server. The default configuration service already allows to change the configuration. This service overrides makes it rely on a user configuration file (with json schema, overridable by language including all vscode features).
143147
- **Keybindings**: `vscode/service-override/keybindings`
144-
- Enables platform specific keybindings and make it rely on a user definded keybindings configuration (if available)
148+
- Enables platform specific keybindings and make it rely on a user definded keybindings configuration (if available).
145149
- **Languages**: `vscode/service-override/languages`
146150
- Enable language support. It's like the standalone service with 2 differences:
147151
- It handle the language extension point (getting languages from vscode extensions)

0 commit comments

Comments
 (0)