JQL 自动完成

这个软件包允许消费者检索给定的JQL查询的自动完成建议. 页:1 自动完成杠杆 蚂蚁4-c3 要提供的库 使用生成的 ANTRR4 代码补全选项 @atlassianlabs/jql-parser。参见 蚂蚁4-c3 更深入地引入守则 完成 ANTRR4 语法.

使用量

简而言之,你会想建造一个新的 JQLAutocomplete 给定源对象 查询.

import { JQLAutocomplete } from '@atlassianlabs/jql-autocomplete';

const autocomplete = JQLAutocomplete.fromText("assignee = currentUser()");

然后可以指定(零索引的)caret位置以检索建议,例如:

// Caret positioned at "assignee = "
const selectionStart = 11;
const selectionStop = 11;
const suggestions = autocomplete.getJQLSuggestionsForCaretPosition([
  selectionStart,
  selectionStop,
]);

console.log(suggestions);

将输出以下响应:

{
  "tokens": {
    "matchedText": "",
    "replacePosition": [11,11],
    "values": ["EMPTY"]
  },
  "rules": {
    "function": {
      "matchedText": "",
      "replacePosition": [11,11],
      "context": {
        "field": "assignee",
        "operator": "="
      }
    },
    "value": {
      "matchedText": "",
      "replacePosition": [11,11],
      "context": {
        "field": "assignee",
        "operator": "="
      }
    }
  }
}

包括收集 符号 财务报告和审定财务报表 规则 适用于 给予注意的位置。 规则对于从您手中获取不仅仅是关键词 自动完成.

如上例所示,可以使用:

• 一个 EMPTY 标志,例如:. assignee = EMPTY
• A 类 function 规则,例如:. assignee = currentUser()
• A 类 value 规则,例如:. assignee = xxxxxxxxx

通常,在遇到规则时,你会想用Jira的数据丰富这些信息. 这样做 你可以发挥杠杆 Jira Cloud REST API的(英语:Jira Cloud rest API) 互联网电影数据库(IMDb)上"Jira Cloud REST"的资料(英文)。 。 。 .

安装

yarn add @atlassianlabs/jql-autocomplete

文档

微调

当构建自动完整对象时,您可以指定一个集合 ignoredTokens 财务报告和审定财务报表 preferredRules未提供时,自动完整引擎指定默认参数 适合大多数自动完成使用的案例。 您可以在 蚂蚁4-c3 文档。 。 。 .

我们还延长 antlr4-c3 带有新参数的配置选项, delimiterTokens。通过 默认 JQLAutocomplete 将会为护身符前的标志提供建议. 当护身符被放置在分界符上时,我们会寻找建议 之后 页:1 当前符号.

例如:

import { JQLLexer, JQLParser } from '@atlassianlabs/jql-parser';
import { JQLAutocomplete } from '@atlassianlabs/jql-autocomplete';

const ignoredTokens = new Set([JQLLexer.NOT_EQUALS]); // Exclude != tokens from suggestions
const preferredRules = new Set([JQLParser.RULE_jqlField]) // Only show rule suggestions for fields
const delimiterTokens = new Set([JQLLexer.COMMA]) // Give suggestions for tokens AFTER commas

const autocomplete = JQLAutocomplete.fromText("assignee = currentUser()", ignoredTokens, preferredRules, delimiterTokens);

支助

对于在Atlassian以外的开发者寻求帮助或报告问题, 请在社区论坛发表文章。 。 。 . 我们将监测这些论坛,并重新将专题分配给适当的维护者.

许可证

版权(c) 2021-2022 阿特拉斯人等. Apache 2.0 许可证,见 自由主义 文档.