Skip to content

fix: ignore issue references inside HTML comments #144

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
LuisUrrutia wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: ignore issue references inside HTML comments #144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ const {hasOwnProperty} = Object.prototype;
const FENCE_BLOCK_REGEXP = /^(([ \t]*`{3,4})([^\n]*)([\s\S]+?)(^[ \t]*\2))/gm;
const CODE_BLOCK_REGEXP = /(`(?!\\))((?:.(?!\1(?!\\)))*.?)\1/g;
const HTML_CODE_BLOCK_REGEXP = /(<code)+?((?!(<code|<\/code>)+?)[\S\s])*(<\/code>)+?/gim;
const HTML_COMMENT_REGEXP = /<!--[\s\S]*?-->/g;
const LEADING_TRAILING_SLASH_REGEXP = /^\/?([^/]+(?:\/[^/]+)*)\/?$/;
const TRAILING_SLASH_REGEXP = /\/?$/;

Expand Down Expand Up @@ -76,13 +77,15 @@ function parse(text, regexp, mentionRegexp, {actions, issuePrefixes, hosts}) {
refs: [],
mentions: [],
};
let noCodeBlock = inverse(inverse(text.replace(FENCE_BLOCK_REGEXP, '')).replace(CODE_BLOCK_REGEXP, ''));
let filteredText = inverse(inverse(text.replace(FENCE_BLOCK_REGEXP, '')).replace(CODE_BLOCK_REGEXP, ''));

while (regexp.test(noCodeBlock)) {
noCodeBlock = noCodeBlock.replace(HTML_CODE_BLOCK_REGEXP, '');
while (regexp.test(filteredText)) {
filteredText = filteredText.replace(HTML_CODE_BLOCK_REGEXP, '');
}

while ((parsed = regexp.exec(noCodeBlock)) !== null) {
filteredText = filteredText.replace(HTML_COMMENT_REGEXP, ' ');

while ((parsed = regexp.exec(filteredText)) !== null) {
let [raw, action, slug, prefix, issue, mentions] = parsed;
prefix =
prefix && issuePrefixes.some(issuePrefix => issuePrefix.toUpperCase() === prefix.toUpperCase())
Expand Down
51 changes: 51 additions & 0 deletions test/index.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,6 +298,57 @@ Fix #2
]);
});

test('Exclude HTML comments', t => {
t.deepEqual(m('github')('Fix #1 <!-- Fix #2 --> Fix #3').actions.close, [
{issue: '1', action: 'Fix', slug: undefined, prefix: '#', raw: 'Fix #1'},
{issue: '3', action: 'Fix', slug: undefined, prefix: '#', raw: 'Fix #3'},
]);

t.deepEqual(m('github')('Fix #1 <!-- Fixes #2 --> #3').actions.close, [
{issue: '1', action: 'Fix', slug: undefined, prefix: '#', raw: 'Fix #1'},
]);

t.deepEqual(m('github')('Fix #1 <!-- Fixes #2 --> #3').refs, [{issue: '3', slug: undefined, prefix: '#', raw: '#3'}]);

t.deepEqual(
m('github')(`Fix #1 <!--
Fix #2
Closes #3
--> Fix #4`).actions.close,
[
{issue: '1', action: 'Fix', slug: undefined, prefix: '#', raw: 'Fix #1'},
{issue: '4', action: 'Fix', slug: undefined, prefix: '#', raw: 'Fix #4'},
]
);

t.deepEqual(m('github')('<!-- Fix #1 -->').actions.close, []);

t.deepEqual(m('github')('<!--Fix #1-->').actions.close, []);

t.deepEqual(m('github')('Fix #1 <!-- Fix #2 --> Fix #3 <!-- Fix #4 --> Fix #5').actions.close, [
{issue: '1', action: 'Fix', slug: undefined, prefix: '#', raw: 'Fix #1'},
{issue: '3', action: 'Fix', slug: undefined, prefix: '#', raw: 'Fix #3'},
{issue: '5', action: 'Fix', slug: undefined, prefix: '#', raw: 'Fix #5'},
]);

t.deepEqual(m('github')('Fix #1 <!-- Fix #2 --> Fix #3 <!-- Fix #4 --> #5 <!-- Fix #6 --> #7').actions.close, [
{issue: '1', action: 'Fix', slug: undefined, prefix: '#', raw: 'Fix #1'},
{issue: '3', action: 'Fix', slug: undefined, prefix: '#', raw: 'Fix #3'},
]);

t.deepEqual(m('github')('Fix #1 <!-- Fix #2 --> Fix #3 <!-- Fix #4 --> #5 <!-- Fix #6 --> #7').refs, [
{issue: '5', slug: undefined, prefix: '#', raw: '#5'},
{issue: '7', slug: undefined, prefix: '#', raw: '#7'},
]);

t.deepEqual(m('github')('Fix #1<!-- Fix #2 -->Fix #3').actions.close, [
{issue: '1', action: 'Fix', slug: undefined, prefix: '#', raw: 'Fix #1'},
{issue: '3', action: 'Fix', slug: undefined, prefix: '#', raw: 'Fix #3'},
]);

t.deepEqual(m('github')('<!-- @user --> @other').mentions, [{raw: '@other', prefix: '@', user: 'other'}]);
});

test('Empty options', t => {
t.deepEqual(m({actions: {close: []}, issuePrefixes: [], mentionsPrefixes: []})('Fix #1, @user'), {
actions: {duplicate: []},
Expand Down