monaco-unified
Get warnings and error messages in monaco editor based on a unified processor.
Installation
npm install monaco-unified
Usage
First, create your own unified worker. Let’s create a remark worker for this example.
unified.worker.js:
import { initialize } from 'monaco-unified/worker'
import { remark } from 'remark'
import remarkLintHeadingIncrement from 'remark-lint-heading-increment'
initialize((vfile, configuration) => remark().use(remarkLintHeadingIncrement))
Next, configure monaco-unified in the main thread. Also add your worker in the monaco environment.
import * as monaco from 'monaco-editor'
import { configureMonacoUnified } from 'monaco-unified'
window.MonacoEnvironment = {
getWorker(moduleId, label) {
switch (label) {
case 'editorWorkerService':
return new Worker(new URL('monaco-editor/esm/vs/editor/editor.worker', import.meta.url))
case 'remark':
return new Worker(new URL('unified.worker', import.meta.url))
default:
throw new Error(`Unknown label ${label}`)
}
},
}
const monacoUnified = configureMonacoUnified(monaco, {
languageSelector: 'markdown',
label: 'remark',
configuration: {
// This configuration will be passed to your worker.
},
})
API
This package exposes two exports. One to setup the main logic, another to create a worker.
monaco-unified
configureMonacoUnified(monaco, options)
Configure monaco-unified.
Arguments:
monaco: Themonaco-editormodule.options: An object with the following properties:label: The label to use for the worker. This is used to match a worker in inMonacoEnvironment(string).languageSelector: The language ID or IDs to which to applymonaco-unified. (string|string[])configuration: The configuration that will be sent to the worker. (optional)formatting: By defaultmonaco-unifiedsupports formatting using unified. Set this tofalseto disable. (boolean, optional, default:true)validation: By defaultmonaco-unifiedsupports validation using unified. Set this tofalseto disable.. (boolean, optional, default:true)
Returns: A disposable with the following additional properties::
reconfigure(configuration): Update the configuration.
monaco-unified/worker
initialize(getProcessor)
Initialize the worker.
Arguments:
getProcessor: A function which gets called with a VFile instance and the passed configuration, and should return a unified processor.
2.8k Dec 19, 2022
12 Dec 23, 2022
6.5k Jan 7, 2023
2 May 24, 2022
32.4k Jan 3, 2023
15 Nov 21, 2022
560 Dec 29, 2022
1.1k Jan 2, 2023