@akrc/vite-plugin-monaco-editor

中文文档
3.0.0发布于 2024/05/06MITTypeScriptES Module近 30 天下载 5739

摩纳哥编辑器的 Vite 插件Name

中文使用文档
文档目录5 节
  1. 安装
  2. 使用
  3. 导入所有monaco 函数
  4. 导入 monaco 函数的一部分
  5. 选项

Vite 插件摩纳哥编辑器

简化装入的插件 摩纳哥编辑器 与 维特。 。 。 .

  • 它使用Vite特定插件钩子: CconfigResolved,配置Server,变换IndexHtml.
  • 它用起重机将工人捆绑起来 node_modules/.monaco 目录,通过 server.middlewares 捆绑工人的代理 http 服务器 .

安装

// make sure you have it installed monaco-editor.

yarn add vite-plugin-monaco-editor -D

// or
npm install --save-dev vite-plugin-monaco-editor

使用

  • vite.config.ts数字 :
import { defineConfig } from 'vite';
import monacoEditorPlugin from 'vite-plugin-monaco-editor';

export default defineConfig({
  plugins: [monacoEditorPlugin()],
});

导入所有monaco 函数

  • index.ts数字 :
import * as monaco from 'monaco-editor';

monaco.editor.create(document.getElementById('container'), {
  value: 'console.log("Hello, world")',
  language: 'javascript',
});

导入 monaco 函数的一部分

这个 import * as monaco from 'monaco-editor' 正在导入摩纳哥编辑器的所有特性和语言。 假设您只需要部分特性和语言:

  • customMonaco.ts
import 'monaco-editor/esm/vs/editor/editor.all.js';
import 'monaco-editor/esm/vs/editor/standalone/browser/accessibilityHelp/accessibilityHelp.js';

import * as monaco from 'monaco-editor/esm/vs/editor/editor.api';

export { monaco };

完整的进口清单: 自定义摩纳哥特斯

  • index.ts
import { monaco } from './customMonaco.ts';
monaco.editor.create(document.getElementById('container'), {
  value: 'console.log("Hello, world")',
  language: 'javascript',
});

选项

  • languageWorkers (单位:千美元)string[]) - 仅包含所支持的语言工人的子集.

    • 默认值 : ['editor Worker Service','cs','html','json','typescript'].
    • 假设只使用cs工人(编辑工人服务必须包括基础工人),您可以设置 ['编辑工人服务','cs']
  • customWorkers (单位:千美元)IWorkerDefinition[]- 包括你的定制工人.

    • 默认值: []
    • 示例值 : [{label: "graphql", entry: "monaco-graphql/esm/graphql.worker"}],该 entry 是节点单元中的相对路径 或者你可以设置绝对的路径.
  • publicPath (单位:千美元)string) - 为工人脚本自定义的公用路径,覆盖此插件生成的文件将从中服务的公共路径. 或者你可以设置CDN,比如 https://unpkg.com/[email protected]/cdn

    • 默认值 : monacoeditorwork
  • globalAPI (单位:千美元)boolean) - 指定编辑器API是否应该通过环球显示 monaco 对象或非对象。 此选项适用于: 0.22.0 和最新版本 monaco-editor。自 0.22.0,Monaco编辑器的无害环境管理版本不再定义一个全球 monaco 对象,除非 global.MonacoEnvironment = { globalAPI: true } 设定( e)更改日志) (中文(简体) ).

    • 默认值 : false。 。 。 .
  • customDistPath (单位:千美元)(root: string, buildOutDir: string, base: string) => string- 自定义回调返回工人路径

  • forceBuildCDN (单位:千美元)boolean) - 如果您使用 CDN, 默认会跳过该构建 。 如果您想要生成唤醒器, 设置为真

    • 默认值 : false

有些语言共用同一个网络工人. 如果包含下列一种语言,您还必须包括负责即时处理其共用工人的语言:

语言辩护人
日记类型标记
手柄栏(简体中文)
少一点密码

版本与发布记录

@akrc/vite-plugin-monaco-editor 共发布 3 个版本,首次发布于 2023/12/06;过去 12 个月发布了 0 个版本。

版本发布日期距今
3.0.0latest2024/05/062 年前
2.0.12023/12/062 年前
2.0.02023/12/062 年前

关于 @akrc/vite-plugin-monaco-editor 的常见问题

@akrc/vite-plugin-monaco-editor 是什么?

摩纳哥编辑器的 Vite 插件Name

如何安装 @akrc/vite-plugin-monaco-editor?

在项目目录运行 npm install @akrc/vite-plugin-monaco-editor,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:monaco-editor(>=0.33.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@akrc/vite-plugin-monaco-editor 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@akrc/vite-plugin-monaco-editor 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@akrc/vite-plugin-monaco-editor 可以商用吗?

@akrc/vite-plugin-monaco-editor 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@akrc/vite-plugin-monaco-editor 的下载量有多少?

根据 npm 官方下载统计,@akrc/vite-plugin-monaco-editor 在 2026/10/06 – 2026/11/04 这 30 天内被下载 5,739 次,日均约 191 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@akrc/vite-plugin-monaco-editor 还在维护吗?

最新版本 3.0.0 发布于 2024/05/06(2 年前);至今共发布 3 个版本,其中过去 12 个月发布了 0 个;首次发布于 2023/12/06。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。