# @atlassianlabs/jql-parser 中文文档

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

版本：1\.0\.1
npm 元数据更新时间：2026-06-24T07:25:59.519Z
中文译文更新时间：2026-11-07T03:08:04.034Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：930 kB，38 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=6\.0\.0
- 运行依赖：2 个
- 首次发布：2021-12-10T00:59:31.524Z
- 最新版本发布：2023-07-12T04:18:18.101Z
- 近 30 天下载量：12614（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

JQL 词汇、解析器、听众和访客

## 安装

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

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

## README

# JQL 解析器

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

此库包含自定义源 [蚂蚁4ts](https://github.com/tunnelvisionlabs/antlr4ts) 使用 JQL ANTRR4 语法的库。 它使消费者能够将一个 JQL 查询解析成一个剖析树.

## 使用量

```typescript
import { CharStreams, CommonTokenStream } from 'antlr4ts';
import { JQLLexer, JQLParser } from '@atlassianlabs/jql-parser';

// Create the lexer and parser
const jqlText = "project = JQL";
const charStream = CharStreams.fromString(jqlText);
const lexer = new JQLLexer(charStream);
const tokenStream = new CommonTokenStream(lexer);
const parser = new JQLParser(tokenStream);

// Parse the input, where `jqlQuery` is the entry point
const parsedJQLTree = parser.jqlQuery();
```

## 安装

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

## 文档

### 检查剖析树

使用 `JQLParserListener` 或者说 `JQLParserVisitor`,你会读 关于来访者/听众方法之间的差异 [这里](https://github.com/antlr/antlr4/blob/master/doc/listeners.md)。 。 。 .

#### 听众办法

```typescript
import { JQLParserListener, JqlQueryContext } from '@atlassianlabs/jql-parser';
import { ParseTreeWalker } from 'antlr4ts/tree/ParseTreeWalker';


class EnterQueryListener implements JQLParserListener {
    enterJqlQuery: (context: JqlQueryContext) {
        console.log(`Query start line number ${context._start.line}`);
        // ...
    }

    // other enterX functions...
}

// Create the listener
const listener: JQLParserListener = new EnterQueryListener();
// Use the entry point for listeners on the parsed JQL tree
ParseTreeWalker.DEFAULT.walk(listener, parsedJQLTree);
```

#### 访客方式

```typescript
import { JQLParserVisitor, JqlOperandContext } from '@atlassianlabs/jql-parser';
import { AbstractParseTreeVisitor } from 'antlr4ts/tree/AbstractParseTreeVisitor';

// Extend the AbstractParseTreeVisitor to get default visitor behaviour
class CountOperandsVisitor extends AbstractParseTreeVisitor<number>
  implements JQLParserVisitor<number> {
  defaultResult() {
    return 0;
  }

  aggregateResult(aggregate: number, nextResult: number) {
    return aggregate + nextResult;
  }

  visitJqlOperand(context: JqlOperandContext): number {
    return 1 + super.visitChildren(context);
  }
}

// Create the visitor
const countOperandsVisitor = new CountOperandsVisitor()
// Use the visitor entry point with the parsed JQL tree
const numberOfOperands = countOperandsVisitor.visit(parsedJQLTree);
```

## 支助

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

## 许可证

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

## 常见问题

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

JQL 词汇、解析器、听众和访客

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

在项目目录运行 npm install @atlassianlabs/jql-parser，或使用 pnpm add / yarn add / bun add。

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

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

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

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

### @atlassianlabs/jql-parser 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=6\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

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

@atlassianlabs/jql-parser 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

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

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

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

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