# @atlassianlabs/jql-editor 中文文档

规范地址：https://npmcn.com/package/%40atlassianlabs/jql-editor/

版本：2\.0\.1
npm 元数据更新时间：2026-06-24T07:25:57.737Z
中文译文更新时间：2026-11-07T03:27:44.373Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40atlassianlabs/jql-editor
原文对照：https://npmcn.com/package/%40atlassianlabs/jql-editor/?lang=original
项目主页：https://bitbucket.org/atlassian/atlassian-frontend#readme
源码仓库：https://bitbucket.org/atlassian/atlassian-frontend

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

- 包体积（解压后）：2.1 MB，754 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：35 个
- peer 依赖：react ^16\.8\.0，react-dom ^16\.8\.0
- 首次发布：2021-12-10T01:08:58.348Z
- 最新版本发布：2023-07-12T04:30:43.396Z
- 近 30 天下载量：2562（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 0 个）

## 中文简介

这个软件包允许消费者制作一个高级的JQL编辑器组件,以便自动完成辅助的JQL查询的编写和验证.

## 安装

```sh
npm install @atlassianlabs/jql-editor
```

也可以使用：`pnpm add @atlassianlabs/jql-editor`、`yarn add @atlassianlabs/jql-editor`、`bun add @atlassianlabs/jql-editor`

## README

# JQL 编辑器

[![Atlassian license](https://img.shields.io/badge/license-Apache%202.0-blue.svg?style=flat-square)](https://npmcn.com/package/%40atlassianlabs/jql-editor/LICENSE)

这个软件包允许消费者制作高级的JQL编辑器组件,以便自动完成辅助编写和 验证 JQL 查询.

## 使用量

要制作编辑器,消费者必须配置 `autocompleteProvider`,它定义了用于 获取 JQL 字段、 函数和值 。 为了放松配置,我们还运送 `@atlassianlabs/jql-editor-autocomplete-rest` 软件包,将这些调用包包起来,并提供简单的钩子来代表 给Jira REST API的.

JQL 编辑器的最低配置如下:

```typescript
import { useCallback } from 'react';
import { JQLEditorAsync as JQLEditor } from '@atlassianlabs/jql-editor';
import { useAutocompleteProvider } from '@atlassianlabs/jql-editor-autocomplete-rest';

const getInitialData = async (url: string) => {
  const response = await fetch(url, {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({ includeCollapsedFields: true })
  });
  const data = response.json();

  return {
    jqlFields: data.visibleFieldNames,
    jqlFunctions: data.visibleFunctionNames,
  };
};

const getSuggestions = async (url: string) => {
  const response = await fetch(url);
  return response.json();
};

const MyJQLEditor = () => {
  const autocompleteProvider = useAutocompleteProvider('my-app', getInitialData, getSuggestions);

  const onSearch = useCallback((jql: string) => {
    // Do some action on search    
  }, []);

  return (
    <JQLEditor
      analyticsSource={'my-app'}
      query={''}
      onSearch={onSearch}
      autocompleteProvider={autocompleteProvider}
      locale={"en"}
    />
  );
};
```

对于应用程序开发者,请参考 `@atlassianlabs/jql-editor-connect` 财务报告和审定财务报表 `@atlassianlabs/jql-editor-forge` 软件包。 由Jira自动完成整合而来.

## 安装

```sh
yarn add @atlassianlabs/jql-editor
```

## 文档

### 搜索和编写 JQL

编辑器主要有两种使用案例:

1.  通过 JQL 查询搜索
2.  正在编写 JQL 查询

两者的关键区别在于,在作者 JQL 时,例如当 使用 JQL 编辑器作为窗体输入。 上面记录了搜索用例,这里我们将讨论作者.

#### 正在撰写 JQL

隐藏搜索按钮既简单又不提供 `onSearch` 道具 (英语). 相反,你会想使用 `onUpdate` 哪个 当查询更新时会被触发.

默认情况下,编辑器会在用户按下搜索时自动显示任何语法错误. 没有搜索按钮 消费者需要设置错误才能手动显示.

```typescript
import { useCallback, useMemo, useState } from 'react';
import { Jast, JQLParseError } from '@atlassianlabs/jql-ast';
import { JQLEditorAsync as JQLEditor, ExternalError } from '@atlassianlabs/jql-editor';
import debounce from 'lodash/debounce';

const MyJQLEditor = () => {
  const [errors, setErrors] = useState<ExternalError[]>([]);

  const debounceSetErrors = useMemo(() => {
    // Update our errors after a 1 second debounce
    return debounce((parseErrors: JQLParseError[]) => {
      // Format JQL parse errors to be shown as custom error messages in the editor
      const errorMessages: ExternalError[] = parseErrors.map(({ description }) => ({
        message: description,
        type: 'error',
      }));
      setErrors(errorMessages)
    }, 1000);
  }, [setErrors]);

  const onUpdate = useCallback((jql: string, jast: Jast) => {
    debounceSetErrors(jast.errors)
  }, []);

  return (
    <JQLEditor
      analyticsSource={'my-app'}
      query={''}
      onUpdate={onUpdate}
      messages={errors}
      autocompleteProvider={/* ... */}
      locale={"en"}
    />
  );
};
```

编辑器也可以使用相同的API显示警告和消息:

```typescript
const [messages] = useState<ExternalMessage[]>([
  { type: 'error', message: `I'm an error message`} as ExternalError,
  { type: 'warning', message: `I'm a warning message`} as ExternalWarning,
  { type: 'info', message: `I'm an info message`} as ExternalInfo,
]);

return (
  <JQLEditor
    {/* ... */}
    messages={messages}
  />
);
```

值得一提的是,信息是由优先权传递的 并且同时在UI上只能出现单一类型的消息.

因此在以上例子中,将只发布一个错误消息.

## 支助

对于在Atlassian以外的开发者寻求帮助或报告 问题, [请在社区论坛发表文章](https://community.developer.atlassian.com/c/atlassian-ecosystem-design) 我们将监测论坛,并重新将专题分配给适当的维护者.

## 许可证

版权(c) 2021-2022 阿特拉斯人等. Apache 2.0 许可证,见 [自由主义](https://npmcn.com/package/%40atlassianlabs/jql-editor/LICENSE) 文档.

## 常见问题

### @atlassianlabs/jql-editor 是什么？

这个软件包允许消费者制作一个高级的JQL编辑器组件,以便自动完成辅助的JQL查询的编写和验证\.

### 如何安装 @atlassianlabs/jql-editor？

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

### @atlassianlabs/jql-editor 支持 TypeScript 吗？

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

### @atlassianlabs/jql-editor 支持 ESM 还是 CommonJS？

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

### @atlassianlabs/jql-editor 可以商用吗？

@atlassianlabs/jql-editor 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @atlassianlabs/jql-editor 的下载量有多少？

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

### @atlassianlabs/jql-editor 还在维护吗？

最新版本 2\.0\.1 发布于 2023/07/12（3 年前）；至今共发布 8 个版本，其中过去 12 个月发布了 0 个；首次发布于 2021/12/10。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。