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
102
103
104
105
106
107
108
109
110
111
|
/*
* SonarQube
* Copyright (C) 2009-2020 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.
*/
const { createFilePath, createRemoteFileNode } = require('gatsby-source-filesystem');
const fs = require('fs-extra');
const path = require('path');
let overrides;
function getPluginOverrideIfAvailable(content) {
if (overrides === undefined) {
const dir = path.normalize(`${__dirname}/../../build/tmp/plugin-documentation/`);
overrides = {};
if (fs.existsSync(dir)) {
fs.readdirSync(dir).forEach(filename => {
let content = fs.readFileSync(dir + filename, 'utf-8');
const regex = /^key\s*:\s*(.+)$/m;
const match = content.match(regex);
if (match && match[1]) {
const url = `/analysis/languages/${match[1]}/`;
content = content.replace(regex, `url: ${url}\n`);
overrides[url] = content;
}
});
}
}
const match = content.match(/^url\s*:\s*(.+)$/m);
if (match && match[1] && overrides[match[1]]) {
return overrides[match[1]];
}
return content;
}
function loadNodeContent(fileNode) {
return Promise.resolve(loadNodeContentSync(fileNode));
}
function loadNodeContentSync(fileNode) {
const content = getPluginOverrideIfAvailable(fs.readFileSync(fileNode.absolutePath, 'utf-8'));
let newContent = cutSonarCloudContent(content);
newContent = removeRemainingContentTags(newContent);
newContent = handleIncludes(newContent, fileNode);
newContent = replaceInstanceTag(newContent);
return newContent;
}
function removeRemainingContentTags(content) {
const regexBase = '<!-- \\/?(sonarqube|sonarcloud|static) -->';
return content
.replace(new RegExp(`^${regexBase}(\n|\r|\r\n|$)`, 'gm'), '')
.replace(new RegExp(`${regexBase}`, 'g'), '');
}
function cutSonarCloudContent(content) {
const beginning = '<!-- sonarcloud -->';
const ending = '<!-- /sonarcloud -->';
let newContent = content;
let start = newContent.indexOf(beginning);
let end = newContent.indexOf(ending);
while (start !== -1 && end !== -1) {
newContent = newContent.substring(0, start) + newContent.substring(end + ending.length);
start = newContent.indexOf(beginning);
end = newContent.indexOf(ending);
}
return newContent;
}
function handleIncludes(content, fileNode) {
return content.replace(/@include (.*)/g, (_, path) => {
const relativePath = `${path}.md`;
const absolutePath = `${__dirname}/../../src/${relativePath}`;
if (relativePath === fileNode.relativePath) {
throw new Error(`Error in ${fileNode.relativePath}: The file is trying to include itself.`);
} else if (!fs.existsSync(absolutePath)) {
throw new Error(
`Error in ${fileNode.relativePath}: Couldn't load "${relativePath}" for inclusion.`
);
} else {
const fileContent = loadNodeContentSync({ absolutePath, relativePath });
return fileContent.replace(/^---[\w\W]+?---$/m, '').trim();
}
});
}
function replaceInstanceTag(content) {
return content.replace(/{instance}/gi, 'SonarQube');
}
exports.createFilePath = createFilePath;
exports.createRemoteFileNode = createRemoteFileNode;
exports.loadNodeContent = loadNodeContent;
|
