stream-monaco 0.0.22 → 0.0.37

package/README.md

@@ -151,6 +151,18 @@ yarn add stream-monaco
 
 Note: Vue is optional. If you don't use Vue, you don't need to install it.
 
+### Example apps
+
+- `examples/streaming-demo` — Vue 3 + Vite demo with streaming, diff, and diff UX routes
+- `examples/react-demo` — React + Vite demo with in-place theme/language switching and `appendCode()` streaming
+
+Quick start:
+
+```bash
+pnpm -C examples/streaming-demo dev
+pnpm -C examples/react-demo dev
+```
+
 ### Basic usage (Vue)
 
 ```vue
@@ -682,6 +694,8 @@ import { preloadMonacoWorkers } from 'stream-monaco/legacy'
 preloadMonacoWorkers()
 ```
 
+The default `stream-monaco` and `stream-monaco/legacy` entry modules intentionally run a best-effort Monaco worker setup during import. The package metadata marks only those published entry files as side-effectful so tree-shaking stays correct for the rest of the library.
+
 If you load Monaco via CDN/AMD (e.g. `<script src=".../vs/loader.js">`), `stream-monaco/legacy` also includes a best-effort auto worker setup that creates a same-origin `blob:` worker and `importScripts()` Monaco’s `vs/base/worker/workerMain.js`. If auto-detection can’t find your Monaco base URL, call:
 
 ```ts
@@ -721,9 +735,9 @@ pnpm build
 
 ### Clearing shiki highlighter cache
 
-The library caches Shiki highlighters internally to avoid recreating them for the same theme combinations. In long-running apps that dynamically create many combinations, you can clear the cache to free memory or reset state (e.g., in tests or on shutdown):
+The library caches Shiki highlighters internally to avoid recreating them for the same theme combinations. In long-running apps that dynamically create many combinations, you can clear the cache to free memory or fully reset the shared highlighter state (e.g., in tests or on shutdown):
 
-- `clearHighlighterCache()` — clears the internal cache
+- `clearHighlighterCache()` — clears cached highlighters and resets the shared Monaco/Shiki highlighter state
 - `getHighlighterCacheSize()` — returns number of cached entries
 
 Call `clearHighlighterCache()` only when highlighters are no longer needed; otherwise, the cache improves performance by reusing instances.

package/README.zh-CN.md

@@ -56,6 +56,18 @@ npm install stream-monaco
 yarn add stream-monaco
 ```
 
+### 示例工程
+
+- `examples/streaming-demo`：Vue 3 + Vite 示例，包含 streaming、diff、diff UX 路由
+- `examples/react-demo`：React + Vite 示例，演示不重建编辑器的主题/语言切换与 `appendCode()` 流式追加
+
+快速启动：
+
+```bash
+pnpm -C examples/streaming-demo dev
+pnpm -C examples/react-demo dev
+```
+
 ### 基础使用（Vue）
 
 #### 简单示例
@@ -887,6 +899,8 @@ import { preloadMonacoWorkers } from 'stream-monaco/legacy'
 preloadMonacoWorkers()
 ```
 
+默认的 `stream-monaco` 与 `stream-monaco/legacy` 入口在模块求值时会做一次 best-effort 的 Monaco worker 安装。包元数据只把这些已发布入口文件标记为有 side effects，其余内部模块仍保持正常 tree-shaking。
+
 #### 2. Diff 编辑器流式更新时内容区空白
 
 确保在调用 `createEditor` / `createDiffEditor` 之前已正确配置 Monaco 的 workers（建议尽早调用 `preloadMonacoWorkers()`）。
@@ -939,9 +953,9 @@ pnpm build
 
 ### Clearing shiki highlighter cache
 
-The library caches shiki highlighters internally to avoid recreating them for the same theme combinations. In long-running applications that may dynamically create many distinct theme combinations, you can clear the cache to free memory or reset state (for example in tests or on app shutdown):
+The library caches shiki highlighters internally to avoid recreating them for the same theme combinations. In long-running applications that may dynamically create many distinct theme combinations, you can clear the cache to free memory or fully reset the shared highlighter state (for example in tests or on app shutdown):
 
-- `clearHighlighterCache()` — clears the internal cache
+- `clearHighlighterCache()` — clears cached highlighters and resets the shared Monaco/Shiki highlighter state
 - `getHighlighterCacheSize()` — returns number of cached entries
 
 Call `clearHighlighterCache()` when you are certain highlighters are no longer needed (for example during teardown), otherwise leaving the cache enabled provides a performance benefit by reusing previously-created highlighters.

package/dist/index.cjs

@@ -1,4 +1,4 @@
-const require_preloadMonacoWorkers_shared = require('./preloadMonacoWorkers.shared-D9riw4LN.cjs');
+const require_preloadMonacoWorkers_shared = require('./preloadMonacoWorkers.shared-C0_StL1Z.cjs');
 
 //#region src/ensureMonacoWorkers.ts
 function ensureMonacoWorkers() {

package/dist/index.js

@@ -1,4 +1,4 @@
-import { RevealStrategy, clearHighlighterCache, defaultRevealDebounceMs, detectLanguage, editorWorkerPath, getOrCreateHighlighter, registerMonacoThemes, uniqueWorkerPaths, useMonaco, workerPathByLabel } from "./preloadMonacoWorkers.shared-B-P1keRz.js";
+import { RevealStrategy, clearHighlighterCache, defaultRevealDebounceMs, detectLanguage, editorWorkerPath, getOrCreateHighlighter, registerMonacoThemes, uniqueWorkerPaths, useMonaco, workerPathByLabel } from "./preloadMonacoWorkers.shared-BRnjKKQj.js";
 
 //#region src/ensureMonacoWorkers.ts
 function ensureMonacoWorkers() {

package/dist/index.legacy.cjs

@@ -1,4 +1,4 @@
-const require_preloadMonacoWorkers_shared = require('./preloadMonacoWorkers.shared-D9riw4LN.cjs');
+const require_preloadMonacoWorkers_shared = require('./preloadMonacoWorkers.shared-C0_StL1Z.cjs');
 const monaco_editor_esm_vs_basic_languages_cpp_cpp = require_preloadMonacoWorkers_shared.__toESM(require("monaco-editor/esm/vs/basic-languages/cpp/cpp"));
 const monaco_editor_esm_vs_basic_languages_javascript_javascript = require_preloadMonacoWorkers_shared.__toESM(require("monaco-editor/esm/vs/basic-languages/javascript/javascript"));
 const monaco_editor_esm_vs_basic_languages_powershell_powershell = require_preloadMonacoWorkers_shared.__toESM(require("monaco-editor/esm/vs/basic-languages/powershell/powershell"));

package/dist/index.legacy.js

@@ -1,4 +1,4 @@
-import { RevealStrategy, clearHighlighterCache, defaultRevealDebounceMs, detectLanguage, getOrCreateHighlighter, monaco_shim_exports, processedLanguage, registerMonacoThemes, useMonaco, workerPathByLabel } from "./preloadMonacoWorkers.shared-B-P1keRz.js";
+import { RevealStrategy, clearHighlighterCache, defaultRevealDebounceMs, detectLanguage, getOrCreateHighlighter, monaco_shim_exports, processedLanguage, registerMonacoThemes, useMonaco, workerPathByLabel } from "./preloadMonacoWorkers.shared-BRnjKKQj.js";
 import { conf, language } from "monaco-editor/esm/vs/basic-languages/cpp/cpp";
 import { conf as conf$1, language as language$1 } from "monaco-editor/esm/vs/basic-languages/javascript/javascript";
 import { conf as conf$2, language as language$2 } from "monaco-editor/esm/vs/basic-languages/powershell/powershell";