4.1.0 • Published 2 years ago
issue-regex v4.1.0
issue-regex
Regular expression for matching issue references
Install
npm install issue-regex
Usage
import issueRegex from 'issue-regex';
'Fixes #143 and avajs/ava#1023'.match(issueRegex());
//=> ['#143', 'avajs/ava#1023']
Organization name, repository name, and issue number are also available individually in capturing groups 1-3, or named groups organization
, repository
, and issueNumber
:
issueRegex().exec('Fixes avajs/ava#1023');
/*
[
'avajs/ava#1023',
'avajs',
'ava',
'1023',
index: 6,
input: 'Fixes avajs/ava#1023',
groups: {
organization: 'avajs',
repository: 'ava',
issueNumber: '1023'
}
]
*/
API
issueRegex()
Returns a RegExp
for matching issue references.
Important
If you run the regex against untrusted user input in a server context, you should give it a timeout.
I do not consider ReDoS a valid vulnerability for this package.
Related
- linkify-issues - Linkify GitHub issue references