@codingame/monaco-vscode-api 1.67.14 → 1.67.17

package/README.md

@@ -28,6 +28,8 @@ Services.install({
 })
 ```
 
+## Monaco standalone services
+
 Also, monaco-editor use `standalone` versions or the vscode services, which are much simpler.
 
 You may want to provide your custom implementations of them, especially for: `textModelService`, `codeEditorService` and `notificationService`. To do so, you can provide them as the third parameter while creating your first editor.
@@ -46,27 +48,58 @@ StandaloneService.initialize({
 })
 ```
 
-Additionally, this library exposes 2 modules that include the vscode version of some services (with some glue to make it work with monaco):
+Additionally, this library exposes 3 modules that include the vscode version of some services (with some glue to make it work with monaco):
 - Notification / Dialog: `vscode/service-override/messages`
 - Model / Editor: `vscode/service-override/modelEditor`
+- Configuration: `vscode/service-override/configuration`
 
 Usage:
 ```typescript
 import { StandaloneService } from 'vscode/services'
 import getModelEditorServiceOverride from 'vscode/service-override/modelEditor'
 import getMessageServiceOverride from 'vscode/service-override/messages'
+import getConfigurationServiceOverride from 'vscode/service-override/configuration'
 
 StandaloneServices.initialize({
   ...getModelEditorServiceOverride((model, input, sideBySide) => {
     // Open a new editor here and return it
     // It will be called when for instance the user ctrl+click on an import
   }),
-  ...getMessageServiceOverride(document.body)
+  ...getMessageServiceOverride(document.body),
+  ...getConfigurationServiceOverride(() => userConfigurationJson, configurationChangeEvent)
 })
 ```
 
 Note: using `vscode/service-override/modelEditor`, you'll be able to use the `vscode.workspace.registerTextDocumentContentProvider` api
 
+### Troubleshoot
+
+`StandaloneServices.initialize` can only be called once (note that `monaco.editor.create` calls `StandaloneServices.initialize`).
+
+Also, a service that is used cannot be overriden anymore. So `StandaloneServices.initialize` should be called as soon as possible to prevent most of the issues.
+
+## Editor configuration
+
+The editors created using `monaco.editor.create` don't use the configuration from the configurationService.
+
+This library exposes functions to create editors binded on the configuration:
+
+before:
+```typescript
+import * as monaco from 'monaco-editor'
+monaco.editor.create(...)
+```
+
+after:
+```typescript
+import { createConfiguredEditor } from 'vscode/monaco'
+
+createConfiguredEditor(...)
+```
+
+`createConfiguredEditor` returns a subclass of what is returned by `monaco.editor.create`, the `updateOptions` method can still be used.
+The only difference is that is will use the `configurationService` as a default configuration
+
 ### Installation
 
 ```bash
@@ -81,7 +114,7 @@ Just import it as if you were in a vscode extension:
 ```typescript
 import * as vscode from 'vscode'
 
-const range = new new vscode.Range(...)
+const range = new vscode.Range(...)
 vscode.languages.registerCompletionItemProvider(...)
 ```