Skip to content

Commit 9c764a4

Browse files
author
Loïc Mangeonjean
committed
doc: update README
1 parent e951e2b commit 9c764a4

File tree

1 file changed

+35
-34
lines changed

1 file changed

+35
-34
lines changed

README.md

Lines changed: 35 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -119,80 +119,81 @@ await initialize({
119119
})
120120
```
121121

122-
Additionally, this library exposes 23 modules that include the vscode version of some services (with some glue to make it work with monaco):
122+
Additionally, 25 packages that include the vscode version of some services (with some glue to make it work with monaco) are published:
123123

124-
- **Extensions** (included by default): `vscode/service-override/extensions`
124+
- **Extensions** (included by default): `@codingame/monaco-vscode-extensions-service-override`
125125
- Support for VSCode extensions. A worker configuration can be past to it:
126126
- 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.
127-
- **Files** (included by default): `vscode/service-override/files`
127+
- **Files** (included by default): `@codingame/monaco-vscode-file-service-override`
128128
- 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.
129-
- **QuickAccess** (included by default): `vscode/service-override/quickaccess`
129+
- **QuickAccess** (included by default): `@codingame/monaco-vscode-quickaccess-service-override`
130130
- Enables the quickaccess menu in the editor (press F1 or ctrl+shift+p)
131-
- **Notifications**: `vscode/service-override/notifications`
131+
- **Notifications**: `@codingame/monaco-vscode-notifications-service-override`
132132
- This services enables vscode notifications you usually find in the bottom right corner.
133-
- **Dialogs**: `vscode/service-override/dialogs`
133+
- **Dialogs**: `@codingame/monaco-vscode-dialogs-service-override`
134134
- Enable vscode modal dialogs. It allows users to select an action to do. Those actions are exposed to the vscode API. Additionally, this service can be used by the language client to delegate questions to the user.
135-
- **Model**: `vscode/service-override/model`
135+
- **Model**: `@codingame/monaco-vscode-model-service-override`
136136
- This service creates and takes care of model references. For example:
137137
- Create model if content is unknown
138138
- Count references
139139
- Destroy models when they are no longer used
140-
- **Editor**: `vscode/service-override/editor`
140+
- **Editor**: `@codingame/monaco-vscode-editor-service-override`
141141
- 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).
142-
- **Views**: `vscode/service-override/views`
142+
- **Views**: `@codingame/monaco-vscode-views-service-override`
143143
- Enable full views support. Is exclusive with the `editor` service. Do not use both services at the same time.
144-
- **Configuration**: `vscode/service-override/configuration`
144+
- **Configuration**: `@codingame/monaco-vscode-configuration-service-override`
145145
- 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).
146-
- **Keybindings**: `vscode/service-override/keybindings`
146+
- **Keybindings**: `@codingame/monaco-vscode-keybindings-service-override`
147147
- Enables platform specific keybindings and make it rely on a user definded keybindings configuration (if available).
148-
- **Languages**: `vscode/service-override/languages`
148+
- **Languages**: `@codingame/monaco-vscode-languages-service-override`
149149
- Enable language support. It's like the standalone service with 2 differences:
150150
- It handle the language extension point (getting languages from vscode extensions)
151151
- It triggers the `onLanguage:${language}` event (to load vscode extension listening to those events)
152-
- **Textmate**: `vscode/service-override/textmate`
152+
- **Textmate**: `@codingame/monaco-vscode-textmate-service-override`
153153
- Allows to use textmate grammars. Depends on *themes* service. vscode extensions use textmate grammars exclusively for highlighting. Once this is enabled monarch grammars can no longer be loaded by monaco-editor.
154-
- **Themes**: `vscode/service-override/theme`
154+
- **Themes**: `@codingame/monaco-vscode-theme-service-override`
155155
- Allows to use VSCode themes.
156-
- **Snippets**: `vscode/service-override/snippets`
156+
- **Snippets**: `@codingame/monaco-vscode-snippets-service-override`
157157
- Add snippet extension point (register vscode extension snippets)
158-
- **Audio cue**: `vscode/service-override/audioCue`
158+
- **Audio cue**: `@codingame/monaco-vscode-audio-cue-service-override`
159159
- If enabled the editor may provides audible hints
160-
- **Debug**: `vscode/service-override/debug`
160+
- **Debug**: `@codingame/monaco-vscode-debug-service-override`
161161
- Activate debugging support
162-
- **Preferences**: `vscode/service-override/preferences`
162+
- **Preferences**: `@codingame/monaco-vscode-preferences-service-override`
163163
- Allow to read and write preferences
164-
- **Output**: `vscode/service-override/output`
164+
- **Output**: `@codingame/monaco-vscode-output-service-override`
165165
- Output panel support. *Hint*: It only makes sense to enable it when *Views* service is used.
166-
- **Terminal**: `vscode/service-override/terminal`
166+
- **Terminal**: `@codingame/monaco-vscode-terminal-service-override`
167167
- Terminal panel support. *Hint*: It only makes sense to enable it when *Views* service is used.
168-
- **Search**: `vscode/service-override/search`
168+
- **Search**: `@codingame/monaco-vscode-search-service-override`
169169
- search panel support. *Hint*: It only makes sense to enable it when *Views* service is used.
170-
- **Markers**: `vscode/service-override/markers`
170+
- **Markers**: `@codingame/monaco-vscode-markers-service-override`
171171
- It adds the problems panel tab. *Hint*: It only makes sense to enable it when *Views* service is used.
172-
- **Language detection worker**: `vscode/service-override/languageDetectionWorker`
172+
- **Language detection worker**: `@codingame/monaco-vscode-language-detection-worker-service-override`
173173
- When opening an untitled model or a file without extension or if vscode is unable to guess the language simply by the file extension or by reading the first line. Then it will use tensorflow in a worker to try to guess the most probable language (here we are only able to rely on the open source model).
174-
- **Storage**: `vscode/service-override/storage`
174+
- **Storage**: `@codingame/monaco-vscode-storage-service-override`
175175
- Define your own storage or use the default BrowserStorageService. The storage service is used in many places either as a cache or as a user preference store. For instance:
176176
- Current loaded theme is stored in there to be loaded faster on start.
177177
- Every panel/view positions are stored in there.
178-
- **LifeCycle**: `vscode/service-override/lifecycle`
178+
- **LifeCycle**: `@codingame/monaco-vscode-lifecycle-service-override`
179179
- Allow other services to veto a page reload (for instance when not all open files are saved)
180-
- **Remote agent**: `vscode/service-override/remoteAgent`
180+
- **Remote agent**: `@codingame/monaco-vscode-remote-agent-service-override`
181181
- Connect to a remote vscode agent and have access to:
182182
- The remote filesystem
183183
- The remote file search
184184
- Running terminals
185185
- Running vscode extensions (not web-compatible)
186186
- and probably more?
187187
This library exports a `vscode-ext-host-server` bin to start the remote agent
188-
188+
- **Accessibility**: `@codingame/monaco-vscode-accessibility-service-override`
189+
- Register accessibility helpers
189190
Usage:
190191

191192
```typescript
192193
import * as vscode from 'vscode'
193194
import { initialize } from 'vscode/services'
194-
import getEditorServiceOverride from 'vscode/service-override/editor'
195-
import getConfigurationServiceOverride, { updateUserConfiguration, configurationRegistry } from 'vscode/service-override/configuration'
195+
import getEditorServiceOverride from '@codingame/monaco-vscode-editor-service-override'
196+
import getConfigurationServiceOverride, { updateUserConfiguration, configurationRegistry } from '@codingame/monaco-vscode-configuration-service-override'
196197

197198
await initialize({
198199
...getModelEditorServiceOverride((model, input, sideBySide) => {
@@ -295,21 +296,21 @@ getApi().then(vscodeApi => vscodeApi.languages.registerCompletionItemProvider(..
295296

296297
VSCode uses a bunch of default extensions. Most of them are used to load the default languages and grammars (see https://github.com/microsoft/vscode/tree/main/extensions).
297298

298-
This library bundles most of them and allows to import the ones you want:
299+
This library bundles and publishes them and allows to import the ones you want:
299300
```typescript
300-
import 'vscode/default-extensions/javascript'
301-
import 'vscode/default-extensions/json'
301+
import '@codingame/monaco-vscode-javascript-default-extension'
302+
import '@codingame/monaco-vscode-json-default-extension'
302303
...
303304
```
304305

305306
### Loading vsix file
306307

307308
VSCode extension are bundled as vsix files.
308-
This library exposes a rollup plugin (vite-compatible) that allows to load a vsix file.
309+
This library publishes a rollup plugin (vite-compatible) that allows to load a vsix file.
309310

310311
- rollup/vite config:
311312
```typescript
312-
import vsixPlugin from 'vscode/rollup-vsix-plugin'
313+
import vsixPlugin from '@codingame/monaco-vscode-rollup-vsix-plugin'
313314
...
314315
plugins: [
315316
...,

0 commit comments

Comments
 (0)