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
|
/*
* SonarQube
* Copyright (C) 2009-2021 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 remark from 'remark';
import visit from 'unist-util-visit';
import { filterContent, ParsedContent, separateFrontMatter } from '../../helpers/markdown';
import { Dict } from '../../types/types';
import Docs from './documentation.directory-loader';
import { DocumentationEntry, DocumentationEntryScope } from './utils';
export default function getPages(parsedOverrides: Dict<ParsedContent> = {}): DocumentationEntry[] {
// Get entries, merge with overrides if applicable.
const pages = ((Docs as unknown) as Array<{ content: string; path: string }>).map(file => {
let parsed = separateFrontMatter(file.content);
if (parsedOverrides[file.path]) {
const parsedOverride = parsedOverrides[file.path];
parsed = {
content: parsedOverride.content,
frontmatter: { ...parsed.frontmatter, ...parsedOverride.frontmatter }
};
delete parsedOverrides[file.path];
}
return { parsed, file };
});
// Add new entries.
Object.keys(parsedOverrides).forEach(path => {
const parsed = parsedOverrides[path];
pages.push({
parsed,
file: { content: parsed.content, path }
});
});
return pages.map(({ parsed, file }) => {
let content = '';
let text = '';
try {
content = filterContent(parsed.content);
text = getText(content);
} catch (e) {
/* eslint-disable-next-line no-console */
console.error(
`Documentation - an error occured while parsing page "${parsed.frontmatter.url ||
file.path}":`,
e
);
}
return {
relativeName: file.path,
url: parsed.frontmatter.url || `/${file.path}/`,
title: parsed.frontmatter.title,
navTitle: parsed.frontmatter.nav || undefined,
order: Number(parsed.frontmatter.order || -1),
scope: parsed.frontmatter.scope
? (parsed.frontmatter.scope.toLowerCase() as DocumentationEntryScope)
: undefined,
text,
content
};
});
}
function getText(content: string) {
const ast = remark().parse(content);
const texts: string[] = [];
visit(ast, node => {
if (node.type === `text` || node.type === `inlineCode`) {
texts.push(node.value);
}
});
return texts.join(' ').replace(/\s+/g, ' ');
}
|
