1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
|
/*
* SonarQube
* Copyright (C) 2009-2024 SonarSource SA
* mailto:info AT sonarsource DOT com
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
import { diffLines } from 'diff';
import { groupBy, keyBy } from 'lodash';
import { sanitizeHTMLNoSVGNoMathML } from './sanitize';
const NUMBER_OF_EXAMPLES = 2;
type DiffBlock = { noncompliant: Element; compliant: Element };
export default function applyCodeDifferences(element: Element | null) {
if (element === null) {
return;
}
const codeExamples = getExamplesFromDom(element);
codeExamples.forEach(({ noncompliant, compliant }) => {
if (noncompliant === undefined || compliant === undefined) {
return;
}
const [markedNonCompliant, markedCompliantCode] = differentiateCode(
noncompliant.innerHTML,
compliant.innerHTML
);
replaceInDom(noncompliant, markedNonCompliant);
replaceInDom(compliant, markedCompliantCode);
});
}
function getExamplesFromDom(element: Element) {
const pres = Array.from(element.querySelectorAll(`pre[data-diff-id]`));
return (
Object.values(
groupBy(
pres.filter((e) => e.getAttribute('data-diff-id') !== undefined),
(e) => e.getAttribute('data-diff-id')
)
)
// If we have 1 or 3+ example we can't display any differences
.filter((diffsBlock) => diffsBlock.length === NUMBER_OF_EXAMPLES)
.map(
(diffBlock) =>
keyBy(diffBlock, (block) => block.getAttribute('data-diff-type')) as DiffBlock
)
);
}
function differentiateCode(compliant: string, nonCompliant: string) {
const hunks = diffLines(compliant, nonCompliant);
let nonCompliantCode = '';
let compliantCode = '';
hunks.forEach((hunk) => {
const value = sanitizeHTMLNoSVGNoMathML(hunk.value);
if (!hunk.added && !hunk.removed) {
nonCompliantCode += `<div>${value}</div>`;
compliantCode += `<div>${value}</div>`;
}
if (hunk.added) {
compliantCode += `<div class='code-added'>${value}</div>`;
}
if (hunk.removed) {
nonCompliantCode += `<div class='code-removed'>${value}</div>`;
}
});
return [nonCompliantCode, compliantCode];
}
function replaceInDom(current: Element, code: string) {
const markedCode = document.createElement('pre');
markedCode.classList.add('code-difference-scrollable');
const flexDiv = document.createElement('div');
flexDiv.classList.add('code-difference-container');
flexDiv.innerHTML = code;
markedCode.appendChild(flexDiv);
current.parentNode?.replaceChild(markedCode, current);
}
|
