Microsoft/monaco-editor

[Bug] Instructions for integrating with Vite don't work

Open

#4045 opened on Jun 28, 2023

View on GitHub
 (7 comments) (11 reactions) (0 assignees)JavaScript (14,836 stars) (1,283 forks)batch import
bughelp wantedintegration

Description

Reproducible in vscode.dev or in VS Code Desktop?

  • Not reproducible in vscode.dev or VS Code Desktop

Reproducible in the monaco editor playground?

Monaco Editor Playground Link

No response

Monaco Editor Playground Code

No response

Reproduction Steps

Copy-paste the code from here: https://github.com/microsoft/monaco-editor/blob/main/docs/integrate-esm.md#using-vite

Actual (Problematic) Behavior

These warnings appear in the browser console:

Could not create web worker(s). Falling back to loading web worker code in main thread, which might cause UI freezes. Please see https://github.com/microsoft/monaco-editor#faq
self.MonacoEnvironment.getWorkerUrl is not a function

Expected Behavior

Code should work.

Additional Context

The warnings make perfect sense to me - the code snippet from the instructions doc doesn't define getWorkerUrl, so how is this expected to work?

Using monaco-editor version 0.28.1. Also tried version 0.36.1 with the same result.

Contributor guide

Tech stack
javascriptvite
Domain
frontenddocumentation
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Markdown editingMonaco Editor worker concept
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Investigate the file docs/integrate esm.md, specifically the Vite integration code snippet. Determine the correct way to set up worker loader for Vite by reviewing Monaco's FAQ and other bundler examples in the same file. The fix likely involves adding a getWorkerUrl implementation or using the MonacoEnvironment global. Also check the issue comments for any suggested solutions from maintainers or other users.