# @elastic/monaco-esql 中文文档

规范地址：https://npmcn.com/package/%40elastic/monaco-esql/

版本：4\.39\.0
npm 元数据更新时间：2026-11-11T12:58:50.282Z
中文译文更新时间：2026-11-13T10:35:57.586Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40elastic/monaco-esql
原文对照：https://npmcn.com/package/%40elastic/monaco-esql/?lang=original
源码仓库：https://github.com/elastic/esql-js

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：104 kB，22 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：monaco-editor \>=0\.30\.0
- 首次发布：2025-03-03T18:15:39.954Z
- 最新版本发布：2026-11-11T12:58:49.879Z
- 近 30 天下载量：692490（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：66（近 12 个月 48 个）

## 中文简介

摩纳哥编辑语言支持ESQL.

## 安装

```sh
npm install @elastic/monaco-esql
```

也可以使用：`pnpm add @elastic/monaco-esql`、`yarn add @elastic/monaco-esql`、`bun add @elastic/monaco-esql`

## README

# `@elastic/monaco-esql`

摩纳哥编辑器语言支持ESQQL(Elasticsearch Query Language),包括其嵌入的PromQL命令.

![image](https://github.com/user-attachments/assets/a725841e-68d6-4765-aa29-54a3062e6a3e)

## 安装

```bash
npm install @elastic/monaco-esql
```

## 使用量

登记 `esql` 摩纳哥语,并设置其君主标志提供商:

```ts
import * as monaco from 'monaco-editor';
import { language } from '@elastic/monaco-esql';

monaco.languages.register({ id: 'esql' });
monaco.languages.setMonarchTokensProvider('esql', language);
```

### 自定义关键字列表

`language` 是从默认 ESQL 关键词列表中构建的 `definitions`启用 `create()` 以建立自定义的 Monarch 标记器——例如从 Elasticsearch 中获取的动态函数:

```ts
import { create, definitions } from '@elastic/monaco-esql';

const language = create({
  ...definitions,
  functions: [...definitions.functions, 'MY_CUSTOM_FUNCTION'],
});

monaco.languages.register({ id: 'esql' });
monaco.languages.setMonarchTokensProvider('esql', language);
```

`create()` 接受任意子集 `definitions` 对象; 省略的字段返回到空列表。 全套栏目为: `headerCommands`, (中文(简体) ), `sourceCommands`, (中文(简体) ), `processingCommands`, (中文(简体) ), `options`, (中文(简体) ), `literals`, (中文(简体) ), `functions`, (中文(简体) ), `delimiters`, (中文(简体) ), `temporalUnits`。 。 。 .

## 许可证

麻省理工学院

## 常见问题

### @elastic/monaco-esql 是什么？

摩纳哥编辑语言支持ESQL\.

### 如何安装 @elastic/monaco-esql？

在项目目录运行 npm install @elastic/monaco-esql，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：monaco-editor（\>=0\.30\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @elastic/monaco-esql 支持 TypeScript 吗？

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

### @elastic/monaco-esql 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @elastic/monaco-esql 可以商用吗？

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

### @elastic/monaco-esql 的下载量有多少？

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

### @elastic/monaco-esql 还在维护吗？

最新版本 4\.39\.0 发布于 2026/11/11（2 天前）；至今共发布 66 个版本，其中过去 12 个月发布了 48 个；首次发布于 2025/03/04。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。