BI商业智能>> issue-parser>> 返回
项目作者： pvdlg

项目描述 ：
Parser for Github, GitLab and Bitbucket issues actions, references and mentions
高级语言： JavaScript
项目地址: git://github.com/pvdlg/issue-parser.git
创建时间： 2017-12-05T01:27:13Z
项目社区：https://github.com/pvdlg/issue-parser
开源协议：MIT License
下载


issue-parser

Parser for Github, GitLab and Bitbucket issues actions, references and mentions

Node CI Workflow Status

The parser can identify:

Install

  1. $ npm install --save issue-parser

Usage

GitHub format

  1. const issueParser = require('issue-parser');
  2. const parse = issueParser('github');
  4. parse('Issue description, ref user/package#1, Fix #2, Duplicate of #3 /cc @user');
  5. /*
  6. {
  7.   refs: [{raw: 'user/package#1', slug: 'user/package', prefix: '#', issue: '1'}],
  8.   actions: {
  9.     close: [{raw: 'Fix #2', action: 'Fix', prefix: '#', issue: '2'}],
  10.     duplicate: [{raw: 'Duplicate of #3', action: 'Duplicate of', prefix: '#', issue: '3'}],
  11.   },
  12.   mentions: [{raw: '@user', prefix: '@', user: 'user'}],
  13. }
  14. */

GitLab format

  1. const issueParser = require('issue-parser');
  2. const parse = issueParser('gitlab');
  4. parse('Issue description, ref group/user/package#1, !2, implement #3, /duplicate #4 /cc @user');
  5. /*
  6. {
  7.   refs: [
  8.     {raw: 'group/user/package#1', slug: 'group/user/package', prefix: '#', issue: '1'},
  9.     {raw: '!2', slug: 'group/user/package', prefix: '!', issue: '2'},
  10.   ],
  11.   actions: {
  12.     close: [{raw: 'implement #3', action: 'Implement', prefix: '#', issue: '4'}],
  13.     duplicate: [{raw: 'Duplicate of #4', action: 'Duplicate of', prefix: '#', issue: '4'}],
  14.   },
  15.   mentions: [{raw: '@user', prefix: '@', user: 'user'}],
  16. }
  17. */

Bitbucket format

  1. const issueParser = require('issue-parser');
  2. const parse = issueParser('bitbucket');
  4. parse('Issue description, ref user/package#1, fixing #2. /cc @user');
  5. /*
  6. {
  7.   refs: [{raw: 'user/package#1', slug: 'user/package', prefix: '#', issue: '1'}],
  8.   actions: {
  9.     close: [{raw: 'fixing #2', action: 'Fixing', prefix: '#', issue: '2'}],
  10.   },
  11.   mentions: [{raw: '@user', prefix: '@', user: 'user'}],
  12. }
  13. */

Custom format

  1. const issueParser = require('issue-parser');
  2. const parse = issueParser({actions: {fix: ['complete'], hold: ['holds up']}, issuePrefixes: ['🐛']});
  4. parse('Issue description, related to user/package🐛1, Complete 🐛2, holds up 🐛3');
  5. /*
  6. {
  7.   refs: [{raw: 'user/package🐛1', slug: 'user/package', prefix: '🐛', issue: '1'}],
  8.   actions: {
  9.     fix: [{raw: 'Complete 🐛2', action: 'Complete', prefix: '🐛', issue: '2'}],
  10.     hold: [{raw: 'holds up 🐛3', action: 'Holds up', prefix: '🐛', issue: '3'}],
  11.   },
  12. }
  13. */

Extend existing format

  1. const issueParser = require('issue-parser');
  2. const parse = issueParser('github', {actions: {parent: ['parent of'], related: ['related to']}});
  4. parse('Issue description, ref user/package#1, Fix #2, Parent of #3, related to #4 /cc @user');
  5. /*
  6. {
  7.   refs: [{raw: 'user/package#1', slug: 'user/package', prefix: '#', issue: '1'}],
  8.   actions: {
  9.     close: [{raw: 'Fix #2', action: 'Fix', prefix: '#', issue: '2'}],
  10.     parent: [{raw: 'Parent of #3', action: 'Parent of', prefix: '#', issue: '3'}],
  11.     related: [{raw: 'related to #4', action: 'Related to', prefix: '#', issue: '4'}],
  12.   },
  13.   mentions: [{raw: '@user', prefix: '@', user: 'user'}],
  14. }
  15. */

Features

Parse references

  1. #1
  1. {refs: [{raw: '#1', slug: undefined, prefix: '#', issue: '1'}]}

Parse repository slug

  1. owner/repo#1
  1. {refs: [{raw: 'owner/repo#1', slug: 'owner/repo', prefix: '#', issue: '1'}]}

Parse closing keywords

  1. Fix #1
  1. {actions: {close: [{raw: 'Fix #1', action: 'Fix', slug: undefined, prefix: '#', issue: '1'}]}}

Parse duplicate keywords

  1. Duplicate of #1
  1. {actions: {duplicate: [{raw: 'Duplicate of #1', action: 'Duplicate of', slug: undefined, prefix: '#', issue: '1'}]}}

Parse user mentions

  1. @user
  1. {mentions: [{raw: '@user', prefix: '@', user: 'user'}]}

Parse references with full issue URL

  1. https://github.com/owner/repo/pull/1
  3. Fix https://github.com/owner/repo/issues/2
  1. {
  2.   refs: [{raw: 'https://github.com/owner/repo/pull/1', slug: 'owner/repo', prefix: undefined, issue: '1'},]
  3.   actions: {
  4.     close: [
  5.       {raw: 'Fix https://github.com/owner/repo/issues/2', action: 'Fix', slug: 'owner/repo', prefix: undefined, issue: '2'}
  6.     ]
  7.   }
  8. }

Ignore keywords case

  1. FIX #1
  1. {actions: {close: [{raw: 'FIX #1', action: 'Fix', slug: undefined, prefix: '#', issue: '1'}]}}

Support delimiters between action keyword and issue

  1. Fix: #1
  1. {actions: {close: [{raw: 'Fix: #1', action: 'Fix', slug: undefined, prefix: '#', issue: '1'}]}}

Ignore references in back-tick quotes

  1. Fix #1 `Fix #2` @user1 `@user2`
  1. {
  2.   actions: {close: [{raw: 'Fix #1', action: 'Fix', slug: undefined, prefix: '#', issue: '1'}]},
  3.   mentions: [{raw: '@user1', prefix: '@', user: 'user1'}]
  4. }

Include references in escaped back-tick quotes

  1. \`Fix #1\` \`@user\`
  1. {
  2.   actions: {close: [{raw: 'Fix #1', action: 'Fix', slug: undefined, prefix: '#', issue: '1'}]},
  3.   mentions: [{raw: '@user1', prefix: '@', user: 'user1'}]
  4. }

Ignore references in fenced blocks

  1. Fix #1
  3. ```js
  4. console.log('Fix #2');
  5. ```
  7. @user1
  9. ```js
  10. console.log('@user2');
  11. ```
  1. {
  2.   actions: {close: [{raw: 'Fix #1', action: 'Fix', slug: undefined, prefix: '#', issue: '1'}]},
  3.   mentions: [{raw: '@user1', prefix: '@', user: 'user1'}]
  4. }

Include references in escaped fenced blocks

  1. \`\`\`
  2. Fix #1
  3. \`\`\`
  5. \`\`\`
  6. @user
  7. \`\`\`
  1. {
  2.   actions: {close: [{raw: 'Fix #1', action: 'Fix', slug: undefined, prefix: '#', issue: '1'}]},
  3.   mentions: [{raw: '@user', prefix: '@', user: 'user'}]
  4. }

Ignore references in tags

  1. Fix #1
  2. <code>Fix #2</code>
  3. <code><code>Fix #3</code></code>
  4. @user1
  5. <code>@user2</code>
  1. {
  2.   actions: {close: [{raw: 'Fix #1', action: 'Fix', slug: undefined, prefix: '#', issue: '1'}]},
  3.   mentions: [{raw: '@user1', prefix: '@', user: 'user1'}]
  4. }

Include references in escaped tags

  1. `<code>`Fix #1`</code>`
  2. `<code>`@user`</code>`
  1. {
  2.   actions: {close: [{raw: 'Fix #1', action: 'Fix', slug: undefined, prefix: '#', issue: '1'}]},
  3.   mentions: [{raw: '@user', prefix: '@', user: 'user'}]
  4. }

Ignore malformed references

  1. Fix #1 Fix #2a Fix a#3
  1. {actions: {close: [{raw: 'Fix #1', action: 'Fix', slug: undefined, prefix: '#', issue: '1'}]}}

API

issueParser([options], [overrides]) => parse

Create a parser.

options

Type: Object String

Parser options. Can be github, gitlab or bitbucket for predefined options, or an object for custom options.

actions

Type: Object

Default:
{close: ['close', 'closes', 'closed', 'closing', 'fix', 'fixes', 'fixed', 'fixing', 'resolve', 'resolves', 'resolved', 'resolving', 'implement', 'implements', 'implemented', 'implementing'], duplicate: ['Duplicate of', '/duplicate']}

Object with type of action as key and array of keywords as value.

Each keyword match will be placed in the corresponding property of the result action object. For example the with the configuration {actions: fix: ['fixed', 'fixing']} each action matching fixed or fixing will be under result.actions.fix.

delimiters

Type: Array<String> String

Default: [':']

List of delimiter characters allowed between an action keywords and the issue reference. The characters space (`) and tab ( `) are always allowed.

mentionsPrefixes

Type: Array<String> String

Default: ['@']

List of keywords used to identify user mentions.

issuePrefixes

Type: Array<String> String

Default: ['#', 'gh-']

List of keywords used to identify issues and pull requests.

hosts

Type: Array<String> String

Default: ['https://github.com', 'https://gitlab.com']

List of base URL used to identify issues and pull requests with full URL.

issueURLSegments

Type: Array<String> String

Default: ['issues', 'pull', 'merge_requests']

List of URL segment used to identify issues and pull requests with full URL.

overrides

Type: Object

Option overrides. Useful when using predefined options (such as github, gitlab or bitbucket). The overrides object can define the same properties as options.

For example, the following will use all the github predefined options but with a different hosts option:

  1. const issueParser = require('issue-parser');
  2. const parse = issueParser('github', {hosts: ['https://custom-url.com']});

parse(text) => Result

Parse an issue description and returns a Result object.

text

Type: String

Issue text to parse.

Result

actions

Type: Object

List of matching actions by type.

Each type of action is an array of objects with the following properties:

Name Type Description
raw String The raw value parsed, for example Fix #1.
action String The keyword used to identify the action, capitalized.
slug String The repository owner and name, for issue referred as <owner>/<repo>#<issue number>.
prefix String The prefix used to identify the issue.
issue String The issue number.

refs

Type: Array<Object>

List of issues and pull requests referenced, but not matched with an action.

Each reference has the following properties:

Name Type Description
raw String The raw value parsed, for example #1.
slug String The repository owner and name, for issue referred as <owner>/<repo>#<issue number>.
prefix String The prefix used to identify the issue.
issue String The issue number.

mentions

Type: Array<Object>

List of users mentioned.

Each mention has the following properties:

Name Type Description
raw String The raw value parsed, for example @user.
prefix String The prefix used to identify the mention.
user String The user name

allRefs

Type: Array<Object>

List of all issues and pull requests referenced or matching an action.

Each reference has the following properties:

Name Type Description
raw String The raw value parsed, for example Fix #1.
action String The keyword used to identify the action or the duplicate, capitalized. Only if matched by an action.
slug String The repository owner and name, for issue referred as <owner>/<repo>#<issue number>.
prefix String The prefix used to identify the issue.
issue String The issue number.