semantic-release/issue-parserPublic

NotificationsYou must be signed in to change notification settings
Fork5
Star22

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

License

MIT license

22 stars 5 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 152 Commits
.github		.github
lib		lib
test		test
.gitignore		.gitignore
.nvmrc		.nvmrc
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
LICENSE		LICENSE
README.md		README.md
index.js		index.js
package-lock.json		package-lock.json
package.json		package.json

Repository files navigation

issue-parser

Parser forGithub,GitLab andBitbucket issues actions, references and mentions

The parser can identify:

GitHubclosing keywords,duplicate keyword,issue references anduser mentions
GitLabclosing keywords,duplicate keyword,issue references anduser mentions
Bitbucketclosing keywords,issue references anduser mentions
Custom oradditional keywords

Install

$ npm install --save issue-parser

Usage

GitHub format

constissueParser=require('issue-parser');constparse=issueParser('github');parse('Issue description, ref user/package#1, Fix #2, Duplicate of #3 /cc @user');/*{  refs: [{raw: 'user/package#1', slug: 'user/package', prefix: '#', issue: '1'}],  actions: {    close: [{raw: 'Fix #2', action: 'Fix', prefix: '#', issue: '2'}],    duplicate: [{raw: 'Duplicate of #3', action: 'Duplicate of', prefix: '#', issue: '3'}],  },  mentions: [{raw: '@user', prefix: '@', user: 'user'}],}*/

GitLab format

constissueParser=require('issue-parser');constparse=issueParser('gitlab');parse('Issue description, ref group/user/package#1, !2, implement #3, /duplicate #4 /cc @user');/*{  refs: [    {raw: 'group/user/package#1', slug: 'group/user/package', prefix: '#', issue: '1'},    {raw: '!2', slug: 'group/user/package', prefix: '!', issue: '2'},  ],  actions: {    close: [{raw: 'implement #3', action: 'Implement', prefix: '#', issue: '4'}],    duplicate: [{raw: 'Duplicate of #4', action: 'Duplicate of', prefix: '#', issue: '4'}],  },  mentions: [{raw: '@user', prefix: '@', user: 'user'}],}*/

Bitbucket format

constissueParser=require('issue-parser');constparse=issueParser('bitbucket');parse('Issue description, ref user/package#1, fixing #2. /cc @user');/*{  refs: [{raw: 'user/package#1', slug: 'user/package', prefix: '#', issue: '1'}],  actions: {    close: [{raw: 'fixing #2', action: 'Fixing', prefix: '#', issue: '2'}],  },  mentions: [{raw: '@user', prefix: '@', user: 'user'}],}*/

Custom format

constissueParser=require('issue-parser');constparse=issueParser({actions:{fix:['complete'],hold:['holds up']},issuePrefixes:['🐛']});parse('Issue description, related to user/package🐛1, Complete 🐛2, holds up 🐛3');/*{  refs: [{raw: 'user/package🐛1', slug: 'user/package', prefix: '🐛', issue: '1'}],  actions: {    fix: [{raw: 'Complete 🐛2', action: 'Complete', prefix: '🐛', issue: '2'}],    hold: [{raw: 'holds up 🐛3', action: 'Holds up', prefix: '🐛', issue: '3'}],  },}*/

Extend existing format

constissueParser=require('issue-parser');constparse=issueParser('github',{actions:{parent:['parent of'],related:['related to']}});parse('Issue description, ref user/package#1, Fix #2, Parent of #3, related to #4 /cc @user');/*{  refs: [{raw: 'user/package#1', slug: 'user/package', prefix: '#', issue: '1'}],  actions: {    close: [{raw: 'Fix #2', action: 'Fix', prefix: '#', issue: '2'}],    parent: [{raw: 'Parent of #3', action: 'Parent of', prefix: '#', issue: '3'}],    related: [{raw: 'related to #4', action: 'Related to', prefix: '#', issue: '4'}],  },  mentions: [{raw: '@user', prefix: '@', user: 'user'}],}*/

Features

Parse references

#1

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

Parse repository slug

owner/repo#1

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

Parse closing keywords

Fix #1

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

Parse duplicate keywords

Duplicate of #1

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

Parse user mentions

@user

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

Parse references with full issue URL

https://github.com/owner/repo/pull/1Fix https://github.com/owner/repo/issues/2

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

Ignore keywords case

FIX #1

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

Support delimiters between action keyword and issue

Fix: #1

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

Ignore references in back-tick quotes

Fix #1 `Fix #2` @user1 `@user2`

{actions:{close:[{raw:'Fix #1',action:'Fix',slug:undefined,prefix:'#',issue:'1'}]},mentions:[{raw:'@user1',prefix:'@',user:'user1'}]}

Include references in escaped back-tick quotes

\`Fix #1\` \`@user\`

{actions:{close:[{raw:'Fix #1',action:'Fix',slug:undefined,prefix:'#',issue:'1'}]},mentions:[{raw:'@user1',prefix:'@',user:'user1'}]}

Ignore references in fenced blocks

Fix #1```jsconsole.log('Fix #2');```@user1```jsconsole.log('@user2');```

{actions:{close:[{raw:'Fix #1',action:'Fix',slug:undefined,prefix:'#',issue:'1'}]},mentions:[{raw:'@user1',prefix:'@',user:'user1'}]}

Include references in escaped fenced blocks

\`\`\`Fix #1\`\`\`\`\`\`@user\`\`\`

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

Ignore references in <code> tags

Fix #1<code>Fix #2</code><code><code>Fix #3</code></code>@user1<code>@user2</code>

{actions:{close:[{raw:'Fix #1',action:'Fix',slug:undefined,prefix:'#',issue:'1'}]},mentions:[{raw:'@user1',prefix:'@',user:'user1'}]}

Include references in escaped <code> tags

`<code>`Fix #1`</code>``<code>`@user`</code>`

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

Ignore malformed references

Fix #1 Fix #2a Fix a#3

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

API

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

Create aparser.

options

Type:ObjectString
Parser options. Can begithub,gitlab orbitbucket 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 theresultaction object. For example the with the configuration{actions: fix: ['fixed', 'fixing']} each action matchingfixed orfixing will be underresult.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 withfull URL.

issueURLSegments

Type:Array<String>String
Default:['issues', 'pull', 'merge_requests']

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

overrides

Type:Object
Option overrides. Useful when using predefinedoptions (such asgithub,gitlab orbitbucket). Theoverrides object can define the same properties asoptions.

For example, the following will use all thegithub predefined options but with a differenthosts option:

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

parse(text) => Result

Parse an issue description and returns aResult 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 requestsreferenced or matching anaction.
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.

About

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

Code of conduct

Security policy

Activity

Custom properties

Stars

22 stars

Watchers

2 watching

Forks

5 forks

Report repository

Releases16

v7.0.1 Latest

May 31, 2024

+ 15 releases

Packages

No packages published

Contributors8

Languages

JavaScript100.0%

Movatterモバイル変換

License

semantic-release/issue-parser

Folders and files

Latest commit

History

Repository files navigation

issue-parser

Install

Usage

GitHub format

GitLab format

Bitbucket format

Custom format

Extend existing format

Features

Parse references

Parse repository slug

Parse closing keywords

Parse duplicate keywords

Parse user mentions

Parse references with full issue URL

Ignore keywords case

Support delimiters between action keyword and issue

Ignore references in back-tick quotes

Include references in escaped back-tick quotes

Ignore references in fenced blocks

Include references in escaped fenced blocks

Ignore references in <code> tags

Include references in escaped <code> tags

Ignore malformed references

API

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

options

actions

delimiters

mentionsPrefixes

issuePrefixes

hosts

issueURLSegments

overrides

parse(text) => Result

text

Result

actions

refs

mentions

allRefs

About

Topics

Resources

License

Code of conduct

Security policy

Uh oh!

Stars

Watchers

Forks

Releases16

Packages0

Uh oh!

Contributors8

Uh oh!

Languages

Packages